Search
K
ARS — Address Resolution Service

ReasonCode

object

Structured reason code. Prefix indicates category:
FMT = format, FLD = field, REG = regulatory, ENT = entity, VRF = verification, CNV = conversion.

codestringrequired

Reason code in PREFIX-NN format (e.g. FMT-01, REG-05, VRF-03).

Example:REG-05

severitystringrequired

Severity level.

Allowed values:ERRORWARNINGINFO

fieldstring

ISO 20022 field name the reason applies to (e.g. TownName, AddressLine).

messagestringrequired

Human-readable explanation.

ruleSourcestring

Regulatory reference (e.g. EPC SCT Rulebook §3.4, CBPR+ MP §2.1).

Example

Issue

object

Legacy issue object. Preserved for backward compatibility with v4.0 integrations.
New integrations should use reasons[] instead.

severitystring

Allowed values:ERRORWARNINGINFO

codestring
messagestring
fieldstring
Example

Statistics

object

Processing statistics block returned on all endpoints.

processingTimeMsinteger

Total processing time in milliseconds.

totalRecordsinteger

Total number of records submitted.

processedRecordsinteger

Number of records successfully processed.

acceptedCountinteger
rejectedCountinteger
Example

RTransactionContext

object

R-transaction exemption assessment result.

exemptionApplicableboolean

TRUE if original predates SR2026 cutover and exemption applies; FALSE if postdates; null if originalExecutionDatetime not provided.

cutoverDatetimestring(date-time)

Always 2026-11-22T02:30:00Z — the SR2026 cutover reference datetime.

Example:2026-11-22T02:30:00Z

originalIsPreCutoverboolean

TRUE if the original payment execution datetime predates the SR2026 cutover.

Example

AddressResult

object

Full address processing result object (used in EP-01 and all Layer 1 responses).

partyRolestring

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.

Allowed values:debtorcreditorultimate_debtorultimate_creditorinitiating_party

inputFormatstring

Format detected in the submitted address.

Allowed values:FULLY_STRUCTUREDHYBRIDFULLY_UNSTRUCTURED

outputFormatstring

Format of the processed output address.

Allowed values:FULLY_STRUCTUREDHYBRIDFULLY_UNSTRUCTURED

statusstring

Outcome of AutoCorrect processing for an address.

Allowed values:VALIDATEDREPAIREDPARTIALLY_REPAIREDNOT_REPAIRED

outputobject

Processed PostalAddress24 output.

Show Child Parameters
verificationobject

Postal DB verification result.

Show Child Parameters
extractedIdentifiersobject

Identifiers extracted from AddressLine (R-04 entity extraction).

Show Child Parameters
detectedNameInAddressstring

Party name text found embedded within address lines (R-05 PMPG non-duplication).

confidenceobject

Overall confidence score (0.0–1.0) and per-field confidence scores.

Show Child Parameters
canonicalobject

Canonical normalised address and SHA-256 fingerprint. Present when include contains canonical.

Show Child Parameters
rTransactionExemptboolean

TRUE if this address is exempt from SR2026 enforcement under EPC §8.3.

reasonsarray[object]

Structured reason code. Prefix indicates category:
FMT = format, FLD = field, REG = regulatory, ENT = entity, VRF = verification, CNV = conversion.

Show Child Parameters
Example