Search
K
ARS — Address Resolution Service

PostalAddressXml

object

ISO 20022 XML tag equivalents of PostalAddress. Alternative input format — clients
may supply either postalAddress (JSON) or postalAddressXml (XML tag names), not both.

AdrLinearray[string]

<= 70 characters<= 7 items

StrtNmstring

<= 70 characters

BldgNbstring

<= 16 characters

BldgNmstring

<= 35 characters

Flrstring

<= 70 characters

PstBxstring

<= 16 characters

Roomstring

<= 70 characters

PstCdstring

<= 16 characters

TwnNmstring

<= 35 characters

TwnLctnNmstring

<= 35 characters

DstrctNmstring

<= 35 characters

CtrySubDvsnstring

<= 35 characters

Ctrystring

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

CtryOfResstring

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

Example

Identification

object

Optional party identifiers. Used for entity conflict detection (R-04).

organisationIdobject
Show Child Parameters
privateIdobject
Show Child Parameters
Example

ProcessingOptions

object

Per-request overrides of the channelProfile configuration. Only fields present
here override the corresponding channelProfile value. Fields absent here fall
through to channelProfile. This is NOT a general-purpose configuration block —
it only overrides values already set in channelProfile.

schemestring

Per-request override of channelProfile.scheme.

Allowed values:SCTSCT_INSTSDD_CORESDD_B2BOCT_INSTCBPRPLUSCHAPST2EURO1FEDWIREOTHER

schemeVersionstring

Per-request override of channelProfile.schemeVersion. SR2025 or SR2026.

Allowed values:SR2025SR2026

qualitystring

Per-request override of channelProfile.quality.

Allowed values:premiumstandardbasic

verificationboolean

Per-request override. When false, skips postal DB lookup. Forced false for Basic quality.

detectMisplacedIdentifiersboolean

Per-request override. When true, flags BIC/LEI/IBAN found in AddressLine (R-04).

validateNameContentboolean

Per-request override. When true, checks for party name duplication in address lines (R-05).

redactionstring

Per-request override. PII redaction level applied to response address fields.

Allowed values:NONEPARTIALFULL

targetFormatstring

Per-request override of channelProfile default targetFormat.

Allowed values:autoFULLY_STRUCTUREDHYBRIDFULLY_UNSTRUCTURED

repairConfidenceThresholdnumber

Per-request override of channelProfile.repairConfidenceThreshold (0.0–1.0).

>= 0<= 1

payerPspCountrystring

Per-request override of channelProfile.payerPspCountry. ISO 3166-1 alpha-2.

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

payeePspCountrystring

Per-request override of channelProfile.payeePspCountry. ISO 3166-1 alpha-2.

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

Example

Context

object

Analytics/audit passthrough AND processing fallback layer.
Fields labelled “Analytics + Processing fallback” are used as last-resort defaults
when both channelProfile and processingOptions leave a parameter unresolved.
Pure analytics fields are written to the ARS audit log but do not affect processing.
Processing precedence: channelProfile → processingOptions → context.

namestring

Analytics only. ISO 20022 party name used for entity conflict detection.

schemestring

Analytics + Processing fallback. Payment scheme.

Allowed values:SCTSCT_INSTSDD_CORESDD_B2BOCT_INSTCBPRPLUSCHAPST2EURO1FEDWIREOTHER

schemeVersionstring

Analytics + Processing fallback. SR2025 or SR2026. Controls post-cutover enforcement.

Allowed values:SR2025SR2026

executionDatetimestring(date-time)

Analytics + Processing fallback. Payment execution datetime in ISO 8601 UTC. Used for SR2026 cutover enforcement (cutover = 2026-11-22T02:30:00Z).

directionstring

Analytics + Processing fallback. OUTBOUND | INBOUND.

Allowed values:OUTBOUNDINBOUND

partyRolestring

Analytics + Processing fallback. Party role for this request.

Allowed values:debtorcreditorultimate_debtorultimate_creditorinitiating_party

outputModestring

Analytics + Processing fallback. Address line rendering constraints.

Allowed values:EPCCBPR_PLUSMT_LEGACYCOMPLIANCE

sendingCountrystring

Analytics + Processing fallback. Country of the sending PSP (ISO 3166-1 alpha-2).

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

receivingCountrystring

Analytics + Processing fallback. Country of the receiving PSP.

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

messageTypestring

Analytics + Processing fallback. ISO 20022 message type.

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

timezonestring

Analytics + Processing fallback. IANA timezone for executionDatetime evaluation.

inputFormatstring

Analytics only. Format of the originating input.

Allowed values:FULLY_STRUCTUREDHYBRIDFULLY_UNSTRUCTURED

outputFormatstring

Analytics only. Expected output format.

Allowed values:FULLY_STRUCTUREDHYBRIDFULLY_UNSTRUCTURED

sourcestring

Analytics only. Sending system identifier (e.g. PAYMENT_HUB, SWIFT_ALLIANCE).

senderstring

Analytics only. BIC of the sending institution.

receiverstring

Analytics only. BIC of the receiving institution.

paymentMethodstring

Analytics only. Payment method for audit reporting.

channelstring

Analytics only. Delivery channel for audit.

Allowed values:apifileother

applicationstring

Analytics only. Caller application identifier.

referencestring

Analytics only. Business reference for audit trail (e.g. payment ID, batch ID).

partyTypestring

Analytics only. Whether the party is a company or individual.

Allowed values:COMPANYINDIVIDUAL

Example

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