---
title: "EP-06 — Classify Party Address"
url: "https://dev.ionova.ai/apis/ars-address-resolution-service-4/versions/fdd2c316-7f84-4f04-8bb7-64e9bf97893b/operations/classifyPartyAddress"
---

> Full API specification: https://dev.ionova.ai/apis/ars-address-resolution-service-4/versions/fdd2c316-7f84-4f04-8bb7-64e9bf97893b.md

# EP-06 — Classify Party Address

`POST` `/classify-party-address`

Operation ID: `classifyPartyAddress`

Lightest available endpoint. Returns format classification only — no validation, verification, conversion, or normalisation. Extremely low latency. **Classification logic:** - FULLY_STRUCTURED: Country + TownName present AND no AddressLine. - HYBRID: Country + TownName present AND AddressLine present. - FULLY_UNSTRUCTURED: anything else. No issues[] or reasons[] in response. Context fields are analytics only. Processing precedence: channelProfile → processingOptions → context.

## Header parameters

- `X-Request-ID` (string, uuid, optional) - Client-supplied correlation ID echoed in response headers for tracing.

## Request body (required)

Content types: `application/json`, `application/xml`

## Responses

- `200` - Classification completed
- `400` - Bad Request — malformed request body or invalid parameter.
- `401` - Unauthorized — missing or invalid authentication credentials.
- `422` - Unprocessable Entity — semantic validation failure (e.g. R-transaction type submitted to a non-R endpoint).
- `429` - Too Many Requests — rate limit exceeded.
- `500` - Internal Server Error — unexpected server-side failure.

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: ARS — Address Resolution Service
  version: 4.3.1
servers:
  - url: https://api-uat.ionova.ai/ars
    description: UAT (test data only)
paths:
  /classify-party-address:
    post:
      tags:
        - Layer 1 — Party Address
      summary: EP-06 — Classify Party Address
      description: >
        Lightest available endpoint. Returns format classification only — no
        validation,

        verification, conversion, or normalisation. Extremely low latency.


        **Classification logic:**

        - FULLY_STRUCTURED: Country + TownName present AND no AddressLine.

        - HYBRID: Country + TownName present AND AddressLine present.

        - FULLY_UNSTRUCTURED: anything else.


        No issues[] or reasons[] in response. Context fields are analytics only.


        Processing precedence: channelProfile → processingOptions → context.
      operationId: classifyPartyAddress
      parameters:
        - $ref: "#/components/parameters/XRequestId"
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ClassifyPartyAddressRequest"
            example:
              postalAddress:
                postCode: "1000"
                townName: Brussels
                country: BE
                addressLine:
                  - CITY HALL GROTE MARKT 1
          application/xml:
            schema:
              $ref: "#/components/schemas/ClassifyPartyAddressRequest"
            example: |
              <ClassifyPartyAddressRequest>
                <PstlAdr>
                  <PstCd>1000</PstCd>
                  <TwnNm>Brussels</TwnNm>
                  <Ctry>BE</Ctry>
                  <AdrLine>CITY HALL GROTE MARKT 1</AdrLine>
                </PstlAdr>
              </ClassifyPartyAddressRequest>
      responses:
        "200":
          description: Classification completed
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ClassifyPartyAddressResponse"
            application/xml:
              schema:
                $ref: "#/components/schemas/ClassifyPartyAddressResponse"
              example: |
                <ClassifyPartyAddressResponse>
                  <format>HYBRID</format>
                  <hasAddressLine>true</hasAddressLine>
                  <addressLineCount>1</addressLineCount>
                  <hasStructuredFields>true</hasStructuredFields>
                  <hasTownName>true</hasTownName>
                  <hasCountry>true</hasCountry>
                </ClassifyPartyAddressResponse>
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "422":
          $ref: "#/components/responses/UnprocessableEntity"
        "429":
          $ref: "#/components/responses/TooManyRequests"
        "500":
          $ref: "#/components/responses/InternalServerError"
      security:
        - ApiKeyAuth: []
security:
  - ApiKeyAuth: []
components:
  parameters:
    XRequestId:
      name: X-Request-ID
      in: header
      required: false
      schema:
        type: string
        format: uuid
      description: Client-supplied correlation ID echoed in response headers for tracing.
  schemas:
    ClassifyPartyAddressRequest:
      type: object
      description: EP-06 request. Lightweight classification only — no repair.
      xml:
        name: ClassifyPartyAddressRequest
      properties:
        channelName:
          type: string
        postalAddress:
          allOf:
            - $ref: "#/components/schemas/PostalAddress"
          xml:
            name: PstlAdr
        postalAddressXml:
          allOf:
            - $ref: "#/components/schemas/PostalAddressXml"
          xml:
            name: PstlAdr
        context:
          allOf:
            - $ref: "#/components/schemas/Context"
          description: Analytics only for this endpoint — no processing fallback.
    ClassifyPartyAddressResponse:
      type: object
      xml:
        name: ClassifyPartyAddressResponse
      properties:
        format:
          $ref: "#/components/schemas/AddressFormat"
        hasAddressLine:
          type: boolean
        addressLineCount:
          type: integer
        hasStructuredFields:
          type: boolean
        hasTownName:
          type: boolean
        hasCountry:
          type: boolean
    PostalAddress:
      type: object
      description: >
        ISO 20022 PostalAddress24 object. All 14 structured fields are
        supported.

        Country is strongly recommended for all submissions.

        AddressLine is limited to max 7 elements in schema; practical publishing
        limits

        are governed by OutputMode (EPC=2, CBPR_PLUS=3, MT_LEGACY=2,
        COMPLIANCE=7).

        PMPG non-duplication rule: structured fields (TownName, Country) must
        NOT also

        appear in AddressLine simultaneously.
      properties:
        addressLine:
          type: array
          items:
            type: string
            maxLength: 70
          maxItems: 7
          description: Unstructured address lines (max 70 chars each). Max 3 for __1
            variant parties, max 2 for __2 variant parties.
          xml:
            name: AdrLine
            wrapped: false
        streetName:
          type: string
          maxLength: 70
          xml:
            name: StrtNm
        buildingNumber:
          type: string
          maxLength: 16
          xml:
            name: BldgNb
        buildingName:
          type: string
          maxLength: 35
          xml:
            name: BldgNm
        floor:
          type: string
          maxLength: 70
          xml:
            name: Flr
        postBox:
          type: string
          maxLength: 16
          xml:
            name: PstBx
        room:
          type: string
          maxLength: 70
          xml:
            name: Room
        postCode:
          type: string
          maxLength: 16
          xml:
            name: PstCd
        townName:
          type: string
          maxLength: 35
          description: Required for __2 variant parties (ultimate_debtor,
            ultimate_creditor, initiating_party). Best practice for all.
          xml:
            name: TwnNm
        townLocationName:
          type: string
          maxLength: 35
          xml:
            name: TwnLctnNm
        districtName:
          type: string
          maxLength: 35
          xml:
            name: DstrctNm
        countrySubDivision:
          type: string
          maxLength: 35
          xml:
            name: CtrySubDvsn
        country:
          type: string
          pattern: ^[A-Z]{2}$
          description: ISO 3166-1 alpha-2. Strongly recommended. Required for __2 variant
            parties.
          xml:
            name: Ctry
        countryOfResidence:
          type: string
          pattern: ^[A-Z]{2}$
          description: ISO 3166-1 alpha-2. Country where the party is resident. Distinct
            from country in the postal address.
          xml:
            name: CtryOfRes
    PostalAddressXml:
      type: object
      description: >
        ISO 20022 XML tag equivalents of PostalAddress. Alternative input format
        — clients

        may supply either postalAddress (JSON) or postalAddressXml (XML tag
        names), not both.
      properties:
        AdrLine:
          type: array
          items:
            type: string
            maxLength: 70
          maxItems: 7
          xml:
            wrapped: false
        StrtNm:
          type: string
          maxLength: 70
        BldgNb:
          type: string
          maxLength: 16
        BldgNm:
          type: string
          maxLength: 35
        Flr:
          type: string
          maxLength: 70
        PstBx:
          type: string
          maxLength: 16
        Room:
          type: string
          maxLength: 70
        PstCd:
          type: string
          maxLength: 16
        TwnNm:
          type: string
          maxLength: 35
        TwnLctnNm:
          type: string
          maxLength: 35
        DstrctNm:
          type: string
          maxLength: 35
        CtrySubDvsn:
          type: string
          maxLength: 35
        Ctry:
          type: string
          pattern: ^[A-Z]{2}$
        CtryOfRes:
          type: string
          pattern: ^[A-Z]{2}$
    Context:
      type: object
      xml:
        name: Context
      description: >
        Analytics/audit passthrough AND processing fallback layer.

        Fields labelled "Analytics + Processing fallback" are used as
        last-resort defaults

        when both channelProfile and processingOptions leave a parameter
        unresolved.

        Pure analytics fields are written to the ARS audit log but do not affect
        processing.

        Processing precedence: channelProfile → processingOptions → context.
      properties:
        name:
          type: string
          description: Analytics only. ISO 20022 party name used for entity conflict
            detection.
        scheme:
          allOf:
            - $ref: "#/components/schemas/SchemeCode"
          description: Analytics + Processing fallback. Payment scheme.
        schemeVersion:
          allOf:
            - $ref: "#/components/schemas/SchemeVersion"
          description: Analytics + Processing fallback. SR2025 or SR2026. Controls
            post-cutover enforcement.
        executionDatetime:
          type: string
          format: date-time
          description: Analytics + Processing fallback. Payment execution datetime in ISO
            8601 UTC. Used for SR2026 cutover enforcement (cutover =
            2026-11-22T02:30:00Z).
        direction:
          allOf:
            - $ref: "#/components/schemas/Direction"
          description: Analytics + Processing fallback. OUTBOUND | INBOUND.
        partyRole:
          allOf:
            - $ref: "#/components/schemas/PartyRole"
          description: Analytics + Processing fallback. Party role for this request.
        outputMode:
          allOf:
            - $ref: "#/components/schemas/OutputMode"
          description: Analytics + Processing fallback. Address line rendering constraints.
        sendingCountry:
          type: string
          pattern: ^[A-Z]{2}$
          description: Analytics + Processing fallback. Country of the sending PSP (ISO
            3166-1 alpha-2).
        receivingCountry:
          type: string
          pattern: ^[A-Z]{2}$
          description: Analytics + Processing fallback. Country of the receiving PSP.
        messageType:
          allOf:
            - $ref: "#/components/schemas/MessageType"
          description: Analytics + Processing fallback. ISO 20022 message type.
        timezone:
          type: string
          description: Analytics + Processing fallback. IANA timezone for
            executionDatetime evaluation.
        inputFormat:
          allOf:
            - $ref: "#/components/schemas/AddressFormat"
          description: Analytics only. Format of the originating input.
        outputFormat:
          allOf:
            - $ref: "#/components/schemas/AddressFormat"
          description: Analytics only. Expected output format.
        source:
          type: string
          description: Analytics only. Sending system identifier (e.g. PAYMENT_HUB,
            SWIFT_ALLIANCE).
        sender:
          type: string
          description: Analytics only. BIC of the sending institution.
        receiver:
          type: string
          description: Analytics only. BIC of the receiving institution.
        paymentMethod:
          type: string
          description: Analytics only. Payment method for audit reporting.
        channel:
          allOf:
            - $ref: "#/components/schemas/ChannelType"
          description: Analytics only. Delivery channel for audit.
        application:
          type: string
          description: Analytics only. Caller application identifier.
        reference:
          type: string
          description: Analytics only. Business reference for audit trail (e.g. payment
            ID, batch ID).
        partyType:
          type: string
          enum:
            - COMPANY
            - INDIVIDUAL
          description: Analytics only. Whether the party is a company or individual.
    AddressFormat:
      type: string
      description: Detected or target address format classification.
      enum:
        - FULLY_STRUCTURED
        - HYBRID
        - FULLY_UNSTRUCTURED
    ErrorResponse:
      type: object
      xml:
        name: ErrorResponse
      description: Standard error envelope returned on 4xx and 5xx responses.
      properties:
        code:
          type: integer
          description: HTTP status code.
        message:
          type: string
          description: Human-readable error description.
        requestId:
          type: string
          description: Correlation ID for support.
    SchemeCode:
      type: string
      description: Payment scheme identifier.
      enum:
        - SCT
        - SCT_INST
        - SDD_CORE
        - SDD_B2B
        - OCT_INST
        - CBPRPLUS
        - CHAPS
        - T2
        - EURO1
        - FEDWIRE
        - OTHER
    SchemeVersion:
      type: string
      description: ISO 20022 scheme version / SR year.
      enum:
        - SR2025
        - SR2026
    Direction:
      type: string
      description: Payment processing direction. OUTBOUND = sending; INBOUND = receiving.
      enum:
        - OUTBOUND
        - INBOUND
    PartyRole:
      type: string
      description: >
        ISO 20022 party role. Determines the PostalAddress24 XSD variant:

        - **__2 variant** (ultimate_debtor, ultimate_creditor,
        initiating_party):
          TownName AND Country are MANDATORY. FULLY_UNSTRUCTURED is NEVER permitted (REG-05).
        - **__1 variant** (debtor, creditor):
          Max 3 AddressLines. FULLY_UNSTRUCTURED is permitted until SR2026 cutover (2026-11-22T02:30:00Z) for INBOUND;
          banned OUTBOUND post-cutover.
      enum:
        - debtor
        - creditor
        - ultimate_debtor
        - ultimate_creditor
        - initiating_party
    OutputMode:
      type: string
      description: |
        Address line rendering constraints applied during output formatting.
        - EPC: 2 lines × 70 chars
        - CBPR_PLUS: 3 lines × 35 chars
        - MT_LEGACY: 2 lines × 35 chars
        - COMPLIANCE: 7 lines × 70 chars
      enum:
        - EPC
        - CBPR_PLUS
        - MT_LEGACY
        - COMPLIANCE
    MessageType:
      type: string
      description: >
        ISO 20022 message type. R-transaction types (pain.002, pain.007,
        pacs.002,

        pacs.004, camt.029, camt.052, camt.053, camt.054, camt.055, camt.056,
        camt.058, camt.110, camt.111) must be submitted to R-transaction
        endpoints only

        (EP-07, EP-15). Submitting them to Check/Convert endpoints returns HTTP
        422 (REG-06).
      enum:
        - pain.001
        - pain.002
        - pain.007
        - pain.008
        - pacs.002
        - pacs.003
        - pacs.004
        - pacs.008
        - pacs.009
        - pacs.010
        - camt.029
        - camt.052
        - camt.053
        - camt.054
        - camt.055
        - camt.056
        - camt.057
        - camt.058
        - camt.060
        - camt.105
        - camt.106
        - camt.107
        - camt.108
        - camt.109
        - camt.110
        - camt.111
    ChannelType:
      type: string
      description: Payment delivery channel type.
      enum:
        - api
        - file
        - other
  responses:
    BadRequest:
      description: Bad Request — malformed request body or invalid parameter.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ErrorResponse"
          example:
            code: 400
            message: Request body is not valid JSON.
            requestId: b1a2c3d4-0000-0000-0000-000000000000
        application/xml:
          schema:
            $ref: "#/components/schemas/ErrorResponse"
          example: |
            <?xml version="1.0" encoding="UTF-8"?>
            <ErrorResponse>
              <code>400</code>
              <message>Request body is not valid JSON.</message>
              <requestId>b1a2c3d4-0000-0000-0000-000000000000</requestId>
            </ErrorResponse>
    Unauthorized:
      description: Unauthorized — missing or invalid authentication credentials.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ErrorResponse"
          example:
            code: 401
            message: Authentication credentials are missing or invalid.
            requestId: b1a2c3d4-0000-0000-0000-000000000001
        application/xml:
          schema:
            $ref: "#/components/schemas/ErrorResponse"
          example: >
            <?xml version="1.0" encoding="UTF-8"?>

            <ErrorResponse>
              <code>401</code>
              <message>Authentication credentials are missing or invalid.</message>
              <requestId>b1a2c3d4-0000-0000-0000-000000000001</requestId>
            </ErrorResponse>
    UnprocessableEntity:
      description: Unprocessable Entity — semantic validation failure (e.g.
        R-transaction type submitted to a non-R endpoint).
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ErrorResponse"
          example:
            code: 422
            message: R-transaction message types (e.g. pacs.002) are not permitted on this
              endpoint. Use /r-transaction-message-party-addresses.
            requestId: b1a2c3d4-0000-0000-0000-000000000004
        application/xml:
          schema:
            $ref: "#/components/schemas/ErrorResponse"
          example: >
            <?xml version="1.0" encoding="UTF-8"?>

            <ErrorResponse>
              <code>422</code>
              <message>R-transaction message types (e.g. pacs.002) are not permitted on this endpoint.</message>
              <requestId>b1a2c3d4-0000-0000-0000-000000000004</requestId>
            </ErrorResponse>
    TooManyRequests:
      description: Too Many Requests — rate limit exceeded.
      headers:
        Retry-After:
          schema:
            type: integer
          description: Seconds to wait before retrying.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ErrorResponse"
          example:
            code: 429
            message: Rate limit exceeded. Retry after 10 seconds.
            requestId: b1a2c3d4-0000-0000-0000-000000000005
        application/xml:
          schema:
            $ref: "#/components/schemas/ErrorResponse"
          example: |
            <?xml version="1.0" encoding="UTF-8"?>
            <ErrorResponse>
              <code>429</code>
              <message>Rate limit exceeded. Retry after 10 seconds.</message>
              <requestId>b1a2c3d4-0000-0000-0000-000000000005</requestId>
            </ErrorResponse>
    InternalServerError:
      description: Internal Server Error — unexpected server-side failure.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ErrorResponse"
          example:
            code: 500
            message: An unexpected error occurred. Please contact support with your
              requestId.
            requestId: b1a2c3d4-0000-0000-0000-000000000006
        application/xml:
          schema:
            $ref: "#/components/schemas/ErrorResponse"
          example: |
            <?xml version="1.0" encoding="UTF-8"?>
            <ErrorResponse>
              <code>500</code>
              <message>An unexpected error occurred.</message>
              <requestId>b1a2c3d4-0000-0000-0000-000000000006</requestId>
            </ErrorResponse>
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Your ioNova platform API key. Generate it from your organisation
        admin in the ioNova app, then paste it here to test.
```