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

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

# ConvertPartyAddressResponse

## 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:
    AutoCorrectStatus:
      type: string
      description: Outcome of AutoCorrect processing for an address.
      enum:
        - VALIDATED
        - REPAIRED
        - PARTIALLY_REPAIRED
        - NOT_REPAIRED
    AddressFormat:
      type: string
      description: Detected or target address format classification.
      enum:
        - FULLY_STRUCTURED
        - HYBRID
        - FULLY_UNSTRUCTURED
    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
    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
    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
    ConvertPartyAddressResponse:
      type: object
      xml:
        name: ConvertPartyAddressResponse
      properties:
        status:
          $ref: "#/components/schemas/AutoCorrectStatus"
        success:
          type: boolean
          description: TRUE if conversion achieved target or fallback format. Preserved
            for backward compatibility.
        inputFormat:
          $ref: "#/components/schemas/AddressFormat"
        outputFormat:
          $ref: "#/components/schemas/AddressFormat"
        correctedAddress:
          allOf:
            - $ref: "#/components/schemas/PostalAddress"
          description: Corrected PostalAddress24 fields. null when status = NOT_REPAIRED.
          nullable: true
          xml:
            name: PstlAdr
        confidence:
          type: object
          properties:
            overall:
              type: number
            fields:
              type: object
              additionalProperties:
                type: number
        reasons:
          type: array
          items:
            $ref: "#/components/schemas/ReasonCode"
        issues:
          type: array
          items:
            $ref: "#/components/schemas/Issue"
        statistics:
          $ref: "#/components/schemas/Statistics"
        timestamp:
          type: string
          format: date-time
```