Client-supplied correlation ID echoed in response headers for tracing.
EP-11 — Classify Message Party Addresses
Message-level equivalent of EP-06. Discovers and classifies every party address in a
submitted ISO 20022 message. No validation, verification, or conversion.
No issues[] or reasons[] in response. Context fields are analytics only.
Very low latency — ideal for routing decisions and dashboard aggregation.
Processing precedence: channelProfile → processingOptions → context.
Headers
Body
Body
ClassifyMessageRequest
EP-11 request. Classification of all party addresses in message.
Analytics only for this endpoint.
Show Child Parameters
Response
Response
Message classification completed
ClassifyMessageResponse
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
Payment scheme identifier.
Allowed values:SCTSCT_INSTSDD_CORESDD_B2BOCT_INSTCBPRPLUSCHAPST2EURO1FEDWIREOTHER
Show Child Parameters
Authentication
Headers
Body
EP-12 — Convert Message Party Addresses (ARS AutoCorrect)
Message-level equivalent of EP-04. Converts all party addresses in an ISO 20022 message
and returns correctedMessageXml with repaired addresses written back in-place.
Either messageContent or messageXml required. If both, messageXml takes precedence.
R-transaction types return HTTP 422 REG-06.
FULLY_UNSTRUCTURED blocked for __2 parties regardless of direction.
PARTIALLY_REPAIRED: VALIDATED/REPAIRED addresses written back; NOT_REPAIRED retain original.
Processing precedence: channelProfile → processingOptions → context.
Headers
Client-supplied correlation ID echoed in response headers for tracing.
Body
Body
ConvertMessageRequest
EP-12 request. Format conversion on all party addresses in message.
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
Payment scheme identifier.
Allowed values:SCTSCT_INSTSDD_CORESDD_B2BOCT_INSTCBPRPLUSCHAPST2EURO1FEDWIREOTHER
Target conversion format. auto lets ARS select the best achievable format.
Allowed values:autoFULLY_STRUCTUREDHYBRIDFULLY_UNSTRUCTURED
Per-party-role direction and outputMode overrides for mixed-direction messages.
Show Child Parameters
Default true when messageXml provided. Returns correctedMessageXml in response.
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
Response
Response
Message conversion completed
ConvertMessageResponse
Outcome of AutoCorrect processing for an address.
Allowed values:VALIDATEDREPAIREDPARTIALLY_REPAIREDNOT_REPAIRED
Complete corrected ISO 20022 XML. null when returnCorrectedMessage=false.
Show Child Parameters
Processing statistics block returned on all endpoints.
Show Child Parameters
Authentication
Headers
Body
EP-13 — Render Message Party Addresses
Message-level equivalent of EP-05. Discovers all party addresses and renders each
to unstructured AddressLine format using PMPG Section 5 mapping priorities.
Country always preserved separately — never embedded in address lines.
Processing precedence: channelProfile → processingOptions → context.
Headers
Client-supplied correlation ID echoed in response headers for tracing.
Body
Body
RenderMessageRequest
EP-13 request. Renders all party addresses in message into unstructured lines.
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
Response
Response
Message render completed
RenderMessageResponse
Allowed values:ACCEPTPARTIAL_SUCCESS
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
Payment scheme identifier.
Allowed values:SCTSCT_INSTSDD_CORESDD_B2BOCT_INSTCBPRPLUSCHAPST2EURO1FEDWIREOTHER
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
Authentication
Headers
Body
EP-14 — Extract Message Party Addresses
Non-destructive address inventory. Returns format, XPath, XSD variant, raw address fields,
isMandatory, and complianceReady for every party address. Nothing processed or modified.
Primary endpoint for SR2026 pre-migration assessment.
Ideal for PMPG self-check framework (Grace Period Guide Section 11).
- isMandatory: uses sendingCountry and receivingCountry from context or channelProfile.
- complianceReady: evaluates against SR2026 rules (FULLY_STRUCTURED or HYBRID = true).
Processing precedence: channelProfile → processingOptions → context.
Headers
Client-supplied correlation ID echoed in response headers for tracing.
Body
Body
ExtractMessageRequest
EP-14 request. Extracts and inventories all party addresses in message.
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
Provide sendingCountry and receivingCountry for accurate mandate assessment.
Show Child Parameters
Response
Response
Extraction completed
ExtractMessageResponse
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
Payment scheme identifier.
Allowed values:SCTSCT_INSTSDD_CORESDD_B2BOCT_INSTCBPRPLUSCHAPST2EURO1FEDWIREOTHER
Show Child Parameters
Authentication
Headers
Body
Layer 2 — Regulatory
R-transaction exemption assessment at message level.