ARS — Address Resolution Service

MessageAddressResult

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
xpathstring

XPath location of this party address within the ISO 20022 message.

postalAddressVariantstring

PostalAddress24 XSD variant (__1 = debtor/creditor, __2 = ultimate/initiating).

Allowed values:__1__2

Example

ErrorResponse

object

Standard error envelope returned on 4xx and 5xx responses.

codeinteger

HTTP status code.

messagestring

Human-readable error description.

requestIdstring

Correlation ID for support.

Example

ChannelSelection

object

Channel identification block for channelProfile registration and retrieval.

channelstringrequired

Payment delivery channel type. Required.

Allowed values:apifileother

schemestring

Payment scheme identifier.

Allowed values:SCTSCT_INSTSDD_CORESDD_B2BOCT_INSTCBPRPLUSCHAPST2EURO1FEDWIREOTHER

schemeVersionstring

ISO 20022 scheme version / SR year.

Allowed values:SR2025SR2026

directionstring

Payment processing direction. OUTBOUND = sending; INBOUND = receiving.

Allowed values:OUTBOUNDINBOUND

messageTypestring

ISO 20022 message type. R-transaction types (pain.002, pain.007, pacs.002,
pacs.004, camt.029, camt.052, camt.053, camt.054, camt.055, camt.056, camt.058, camt.110, camt.111) must be submitted to R-transaction endpoints only
(EP-07, EP-15). Submitting them to Check/Convert endpoints returns HTTP 422 (REG-06).

Allowed values:pain.001pain.002pain.007pain.008pacs.002pacs.003pacs.004pacs.008pacs.009pacs.010camt.029camt.052camt.053camt.054camt.055camt.056camt.057camt.058camt.060camt.105camt.106camt.107camt.108camt.109camt.110camt.111

partyRolestring

Default party role. Determines PostalAddress24 XSD variant.

Allowed values:debtorcreditorultimate_debtorultimate_creditorinitiating_party

pspCountrystring

PSP home country for this channel. Overrides account-level pspCountry.

Match pattern:^[A-Z]{2}$

payerPspCountrystring

Default payer PSP country for EEA mandate determination.

Match pattern:^[A-Z]{2}$

payeePspCountrystring

Default payee PSP country for EEA mandate determination.

Match pattern:^[A-Z]{2}$

timezonestring

Default IANA timezone for executionDatetime evaluation (e.g. Europe/Frankfurt).

Example

Corridor

object

Default corridor (geographic routing) block for a channelProfile.

sendingCountrystring

Default sending PSP country (ISO 3166-1 alpha-2).

Match pattern:^[A-Z]{2}$

receivingCountrystring

Default receiving PSP country (ISO 3166-1 alpha-2).

Match pattern:^[A-Z]{2}$

currencystring

Default transaction currency (ISO 4217, e.g. EUR, GBP, USD).

Match pattern:^[A-Z]{3}$

Example

ChannelPreferences

object

Output and behaviour preference defaults for a channelProfile.

outputModestring

Address line rendering constraints applied during output formatting.

  • EPC: 2 lines × 70 chars
  • CBPR_PLUS: 3 lines × 35 chars
  • MT_LEGACY: 2 lines × 35 chars
  • COMPLIANCE: 7 lines × 70 chars

Allowed values:EPCCBPR_PLUSMT_LEGACYCOMPLIANCE

autoRepairModestring

ARS AutoCorrect repair aggressiveness level.

Allowed values:CONSERVATIVESTANDARDAGGRESSIVE

enforcePostNovember2026boolean

When true, force SR2026 rules even if schemeVersion=SR2025.

targetFormatstring

Target conversion format. auto lets ARS select the best achievable format.

Allowed values:autoFULLY_STRUCTUREDHYBRIDFULLY_UNSTRUCTURED

qualitystring

Postal database verification depth.

Allowed values:premiumstandardbasic

repairConfidenceThresholdnumber

Default minimum confidence score for REPAIRED classification (0.0–1.0).

>= 0<= 1

Example