--- title: "RTransactionPartyAddressResponse" url: "https://dev.ionova.ai/apis/ars-address-resolution-service-4/versions/fdd2c316-7f84-4f04-8bb7-64e9bf97893b/schemas/RTransactionPartyAddressResponse" --- > Full API specification: https://dev.ionova.ai/apis/ars-address-resolution-service-4/versions/fdd2c316-7f84-4f04-8bb7-64e9bf97893b.md # RTransactionPartyAddressResponse ## 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: Decision: type: string description: Top-level processing decision. enum: - ACCEPT - REJECT - PARTIAL_SUCCESS RTransactionContext: type: object xml: name: RTransactionContext description: R-transaction exemption assessment result. properties: exemptionApplicable: type: boolean nullable: true description: TRUE if original predates SR2026 cutover and exemption applies; FALSE if postdates; null if originalExecutionDatetime not provided. cutoverDatetime: type: string format: date-time description: Always 2026-11-22T02:30:00Z — the SR2026 cutover reference datetime. example: 2026-11-22T02:30:00Z originalIsPreCutover: type: boolean description: TRUE if the original payment execution datetime predates the SR2026 cutover. AddressResult: type: object description: Full address processing result object (used in EP-01 and all Layer 1 responses). xml: name: AddressResult properties: partyRole: $ref: "#/components/schemas/PartyRole" inputFormat: allOf: - $ref: "#/components/schemas/AddressFormat" description: Format detected in the submitted address. outputFormat: allOf: - $ref: "#/components/schemas/AddressFormat" description: Format of the processed output address. status: $ref: "#/components/schemas/AutoCorrectStatus" output: allOf: - $ref: "#/components/schemas/PostalAddress" description: Processed PostalAddress24 output. xml: name: PstlAdr verification: type: object description: Postal DB verification result. properties: status: type: string enum: - verified - partial - unverified score: type: number minimum: 0 maximum: 1 extractedIdentifiers: type: object description: Identifiers extracted from AddressLine (R-04 entity extraction). properties: bic: type: string lei: type: string iban: type: string detectedNameInAddress: type: string description: Party name text found embedded within address lines (R-05 PMPG non-duplication). confidence: type: object description: Overall confidence score (0.0–1.0) and per-field confidence scores. properties: overall: type: number minimum: 0 maximum: 1 fields: type: object additionalProperties: type: number canonical: type: object description: Canonical normalised address and SHA-256 fingerprint. Present when `include` contains `canonical`. properties: address: $ref: "#/components/schemas/PostalAddress" fingerprint: type: string description: SHA-256 hash of the canonical address for deduplication. rTransactionExempt: type: boolean description: TRUE if this address is exempt from SR2026 enforcement under EPC §8.3. reasons: type: array items: $ref: "#/components/schemas/ReasonCode" 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 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 AutoCorrectStatus: type: string description: Outcome of AutoCorrect processing for an address. enum: - VALIDATED - REPAIRED - PARTIALLY_REPAIRED - NOT_REPAIRED 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). RTransactionPartyAddressResponse: type: object xml: name: RTransactionPartyAddressResponse properties: decision: $ref: "#/components/schemas/Decision" rTransactionContext: $ref: "#/components/schemas/RTransactionContext" result: allOf: - $ref: "#/components/schemas/AddressResult" description: Address exactly as submitted — NO repair is applied. statistics: $ref: "#/components/schemas/Statistics" timestamp: type: string format: date-time ```