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

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

# CheckMessageResponse

## 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:
    PreCheckStatus:
      type: string
      description: Outcome of structural pre-check validation.
      enum:
        - COMPLIANT
        - NOT_COMPLIANT
    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
    ReasonCode:
      type: object
      xml:
        name: ReasonCode
      description: >
        Structured reason code. Prefix indicates category:

        FMT = format, FLD = field, REG = regulatory, ENT = entity, VRF =
        verification, CNV = conversion.
      required:
        - code
        - severity
        - message
      properties:
        code:
          type: string
          description: Reason code in PREFIX-NN format (e.g. FMT-01, REG-05, VRF-03).
          example: REG-05
        severity:
          type: string
          enum:
            - ERROR
            - WARNING
            - INFO
          description: Severity level.
        field:
          type: string
          description: ISO 20022 field name the reason applies to (e.g. TownName,
            AddressLine).
        message:
          type: string
          description: Human-readable explanation.
        ruleSource:
          type: string
          description: Regulatory reference (e.g. EPC SCT Rulebook §3.4, CBPR+ MP §2.1).
    Issue:
      type: object
      xml:
        name: Issue
      description: >
        Legacy issue object. Preserved for backward compatibility with v4.0
        integrations.

        New integrations should use reasons[] instead.
      properties:
        severity:
          type: string
          enum:
            - ERROR
            - WARNING
            - INFO
        code:
          type: string
        message:
          type: string
        field:
          type: string
    CheckMessageResponse:
      type: object
      xml:
        name: CheckMessageResponse
      properties:
        messageStatus:
          $ref: "#/components/schemas/PreCheckStatus"
        compliantCount:
          type: integer
        nonCompliantCount:
          type: integer
        discoveredAddresses:
          type: integer
        results:
          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"
              status:
                $ref: "#/components/schemas/PreCheckStatus"
              fieldResults:
                type: array
                items:
                  type: object
                  properties:
                    field:
                      type: string
                    status:
                      $ref: "#/components/schemas/PreCheckStatus"
              reasons:
                type: array
                items:
                  $ref: "#/components/schemas/ReasonCode"
              issues:
                type: array
                items:
                  $ref: "#/components/schemas/Issue"
        timestamp:
          type: string
          format: date-time
```