PartyRole
stringISO 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
AddressFormat
stringDetected or target address format classification.
Allowed values:FULLY_STRUCTUREDHYBRIDFULLY_UNSTRUCTURED
TargetFormat
stringTarget conversion format. auto lets ARS select the best achievable format.
Allowed values:autoFULLY_STRUCTUREDHYBRIDFULLY_UNSTRUCTURED
OutputMode
stringAddress 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
Quality
stringPostal database verification depth.
Allowed values:premiumstandardbasic