Search
K
ARS — Address Resolution Service

ChannelType

string

Payment delivery channel type.

Allowed values:apifileother

PostalAddress

object

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.

addressLinearray[string]

Unstructured address lines (max 70 chars each). Max 3 for __1 variant parties, max 2 for __2 variant parties.

<= 70 characters<= 7 items

streetNamestring

<= 70 characters

buildingNumberstring

<= 16 characters

buildingNamestring

<= 35 characters

floorstring

<= 70 characters

postBoxstring

<= 16 characters

roomstring

<= 70 characters

postCodestring

<= 16 characters

townNamestring

Required for __2 variant parties (ultimate_debtor, ultimate_creditor, initiating_party). Best practice for all.

<= 35 characters

townLocationNamestring

<= 35 characters

districtNamestring

<= 35 characters

countrySubDivisionstring

<= 35 characters

countrystring

ISO 3166-1 alpha-2. Strongly recommended. Required for __2 variant parties.

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

countryOfResidencestring

ISO 3166-1 alpha-2. Country where the party is resident. Distinct from country in the postal address.

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

Example

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