ProcessPartyAddressResponse
objectTop-level processing decision.
Allowed values:ACCEPTREJECTPARTIAL_SUCCESS
Full address processing result object (used in EP-01 and all Layer 1 responses).
Show Child Parameters
Processing statistics block returned on all endpoints.
Show Child Parameters
Legacy issue object. Preserved for backward compatibility with v4.0 integrations.
New integrations should use reasons[] instead.
Show Child Parameters
ProcessBatchPartyAddressRequest
objectEP-02 batch request. Up to 1,000 transaction sets per call.
<= 1000 items
Show Child Parameters
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.
Show Child Parameters
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.
Show Child Parameters
ProcessBatchPartyAddressResponse
objectTop-level processing decision.
Allowed values:ACCEPTREJECTPARTIAL_SUCCESS
Processing statistics block returned on all endpoints.
Show Child Parameters
Show Child Parameters
Structured reason code. Prefix indicates category (each family drawn from
the internal rules registry — clients should not depend on the exact
numeric value):
Customer-facing regulatory / processing families:
FMT = format-validation, FLD = field-required, REG = regulatory,
CNV = conversion, ENT = entity, VRF = verification.
Diagnostic / algorithmic families (INFO-severity only):
RFT = reformatting, INF = informational, DCT = dictionary match,
POS = positional-rule, SYN = syntax-rule, VLD = validation,
ENR = enrichment, ADP = adaptive-parser, DIC = dictionary lookup,
GLC = geo-location, PHN = phonetic, SPL = spell-correction,
VAL = validation-diagnostic.
All codes use the strict PREFIX-NNN (3-digit) format.
Show Child Parameters
Legacy issue object. Preserved for backward compatibility with v4.0 integrations.
New integrations should use reasons[] instead.
Show Child Parameters
CheckPartyAddressRequest
objectEP-03 request. Structural check only — no AutoCorrect repair.
ISO 20022 PostalAddress24 object. All 14 structured fields plus the three
ISO 20022 identity sub-fields (addressType, department, subDepartment) 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.
Show Child Parameters
ISO 20022 XML tag equivalents of PostalAddress. Alternative input format — clients
may supply either postalAddress (JSON) or postalAddressXml (XML tag names), not both.
Show Child Parameters
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.
Show Child Parameters
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.
Show Child Parameters
CheckPartyAddressResponse
objectOutcome of structural pre-check validation.
Allowed values:COMPLIANTNOT_COMPLIANT
TRUE if no structural errors. Preserved for backward compatibility.
Detected or target address format classification.
Allowed values:FULLY_STRUCTUREDHYBRIDFULLY_UNSTRUCTURED
Per-field structural compliance detail.
Show Child Parameters
Structured reason code. Prefix indicates category (each family drawn from
the internal rules registry — clients should not depend on the exact
numeric value):
Customer-facing regulatory / processing families:
FMT = format-validation, FLD = field-required, REG = regulatory,
CNV = conversion, ENT = entity, VRF = verification.
Diagnostic / algorithmic families (INFO-severity only):
RFT = reformatting, INF = informational, DCT = dictionary match,
POS = positional-rule, SYN = syntax-rule, VLD = validation,
ENR = enrichment, ADP = adaptive-parser, DIC = dictionary lookup,
GLC = geo-location, PHN = phonetic, SPL = spell-correction,
VAL = validation-diagnostic.
All codes use the strict PREFIX-NNN (3-digit) format.
Show Child Parameters
Processing statistics block returned on all endpoints.
Show Child Parameters
Legacy issue object. Preserved for backward compatibility with v4.0 integrations.
New integrations should use reasons[] instead.