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

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

# CheckPartyAddressResponse

## 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
    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).
    Statistics:
      type: object
      xml:
        name: Statistics
      description: Processing statistics block returned on all endpoints.
      properties:
        processingTimeMs:
          type: integer
          description: Total processing time in milliseconds.
        totalRecords:
          type: integer
          description: Total number of records submitted.
        processedRecords:
          type: integer
          description: Number of records successfully processed.
        acceptedCount:
          type: integer
        rejectedCount:
          type: integer
    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
    CheckPartyAddressResponse:
      type: object
      xml:
        name: CheckPartyAddressResponse
      properties:
        status:
          $ref: "#/components/schemas/PreCheckStatus"
        valid:
          type: boolean
          description: TRUE if no structural errors. Preserved for backward compatibility.
        format:
          $ref: "#/components/schemas/AddressFormat"
        fieldResults:
          type: array
          description: Per-field structural compliance detail.
          items:
            type: object
            properties:
              field:
                type: string
              status:
                $ref: "#/components/schemas/PreCheckStatus"
              message:
                type: string
        reasons:
          type: array
          items:
            $ref: "#/components/schemas/ReasonCode"
        statistics:
          $ref: "#/components/schemas/Statistics"
        issues:
          type: array
          items:
            $ref: "#/components/schemas/Issue"
```