---
title: "ClassifyMessageResponse"
url: "https://dev.ionova.ai/apis/ars-address-resolution-service-4/versions/fdd2c316-7f84-4f04-8bb7-64e9bf97893b/schemas/ClassifyMessageResponse"
---

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

# ClassifyMessageResponse

## 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)
components:
  schemas:
    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
    SchemeCode:
      type: string
      description: Payment scheme identifier.
      enum:
        - SCT
        - SCT_INST
        - SDD_CORE
        - SDD_B2B
        - OCT_INST
        - CBPRPLUS
        - CHAPS
        - T2
        - EURO1
        - FEDWIRE
        - OTHER
    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
    AddressFormat:
      type: string
      description: Detected or target address format classification.
      enum:
        - FULLY_STRUCTURED
        - HYBRID
        - FULLY_UNSTRUCTURED
    ClassifyMessageResponse:
      type: object
      xml:
        name: ClassifyMessageResponse
      properties:
        messageType:
          $ref: "#/components/schemas/MessageType"
        scheme:
          $ref: "#/components/schemas/SchemeCode"
        discoveredAddresses:
          type: integer
        classifications:
          type: array
          items:
            type: object
            properties:
              partyRole:
                $ref: "#/components/schemas/PartyRole"
              xpath:
                type: string
              postalAddressVariant:
                type: string
                enum:
                  - __1
                  - __2
              format:
                $ref: "#/components/schemas/AddressFormat"
              hasTownName:
                type: boolean
              hasCountry:
                type: boolean
              addressLineCount:
                type: integer
        timestamp:
          type: string
          format: date-time
```