ARS — Address Resolution Service

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.

post
https://api-uat.ionova.ai/ars/classify-message-party-addresses

Headers

X-Request-IDstring(uuid)

Client-supplied correlation ID echoed in response headers for tracing.

Body

ClassifyMessageRequest

EP-11 request. Classification of all party addresses in message.

channelNamestring
messageContentobject
messageXmlstring
contextobject

Analytics only for this endpoint.

Show Child Parameters

Response

Message classification completed

ClassifyMessageResponse

messageTypestring

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

schemestring

Payment scheme identifier.

Allowed values:SCTSCT_INSTSDD_CORESDD_B2BOCT_INSTCBPRPLUSCHAPST2EURO1FEDWIREOTHER

discoveredAddressesinteger
classificationsarray[object]
Show Child Parameters
timestampstring(date-time)
post/classify-message-party-addresses

Body

{ "channelName": "MY_SEPA_SCT", "messageXml": "<Document>...</Document>" }
 

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.

post
https://api-uat.ionova.ai/ars/convert-message-party-addresses

Headers

X-Request-IDstring(uuid)

Client-supplied correlation ID echoed in response headers for tracing.

Body

ConvertMessageRequest

EP-12 request. Format conversion on all party addresses in message.

channelNamestring
messageTypestringrequired

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

schemestringrequired

Payment scheme identifier.

Allowed values:SCTSCT_INSTSDD_CORESDD_B2BOCT_INSTCBPRPLUSCHAPST2EURO1FEDWIREOTHER

targetFormatstringrequired

Target conversion format. auto lets ARS select the best achievable format.

Allowed values:autoFULLY_STRUCTUREDHYBRIDFULLY_UNSTRUCTURED

messageContentobject
messageXmlstring
perAddressOverridesarray[object]

Per-party-role direction and outputMode overrides for mixed-direction messages.

Show Child Parameters
returnCorrectedMessageboolean

Default true when messageXml provided. Returns correctedMessageXml in response.

processingOptionsobject

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
contextobject

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

Message conversion completed

ConvertMessageResponse

messageStatusstring

Outcome of AutoCorrect processing for an address.

Allowed values:VALIDATEDREPAIREDPARTIALLY_REPAIREDNOT_REPAIRED

correctedMessageXmlstring | null

Complete corrected ISO 20022 XML. null when returnCorrectedMessage=false.

validatedCountinteger
repairedCountinteger
partiallyRepairedCountinteger
notRepairedCountinteger
discoveredAddressesinteger
resultsarray[object]
Show Child Parameters
statisticsobject

Processing statistics block returned on all endpoints.

Show Child Parameters
timestampstring(date-time)
post/convert-message-party-addresses

Body

{ "channelName": "MY_SEPA_SCT", "messageType": "pacs.008", "scheme": "SCT", "targetFormat": "auto", "returnCorrectedMessage": true, "messageXml": "<Document>...</Document>" }
 

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.

post
https://api-uat.ionova.ai/ars/render-message-party-addresses

Headers

X-Request-IDstring(uuid)

Client-supplied correlation ID echoed in response headers for tracing.

Body

RenderMessageRequest

EP-13 request. Renders all party addresses in message into unstructured lines.

channelNamestring
messageContentobject
messageXmlstring
processingOptionsobject

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
contextobject

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

Message render completed

RenderMessageResponse

decisionstring

Allowed values:ACCEPTPARTIAL_SUCCESS

messageTypestring

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

schemestring

Payment scheme identifier.

Allowed values:SCTSCT_INSTSDD_CORESDD_B2BOCT_INSTCBPRPLUSCHAPST2EURO1FEDWIREOTHER

discoveredAddressesinteger
resultsarray[object]
Show Child Parameters
statisticsobject

Processing statistics block returned on all endpoints.

Show Child Parameters
issuesarray[object]

Legacy issue object. Preserved for backward compatibility with v4.0 integrations.
New integrations should use reasons[] instead.

Show Child Parameters
timestampstring(date-time)
post/render-message-party-addresses

Body

{ "channelName": "MY_SEPA_SCT", "messageXml": "<Document>...</Document>" }
 

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.

post
https://api-uat.ionova.ai/ars/extract-message-party-addresses

Headers

X-Request-IDstring(uuid)

Client-supplied correlation ID echoed in response headers for tracing.

Body

ExtractMessageRequest

EP-14 request. Extracts and inventories all party addresses in message.

channelNamestring
executionDatetimestring(date-time)
messageContentobject
messageXmlstring
processingOptionsobject

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
contextobject

Provide sendingCountry and receivingCountry for accurate mandate assessment.

Show Child Parameters
includearray[string]

Response

Extraction completed

ExtractMessageResponse

messageTypestring

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

schemestring

Payment scheme identifier.

Allowed values:SCTSCT_INSTSDD_CORESDD_B2BOCT_INSTCBPRPLUSCHAPST2EURO1FEDWIREOTHER

discoveredAddressesinteger
partyAddressesarray[object]
Show Child Parameters
timestampstring(date-time)
post/extract-message-party-addresses

Body

{ "channelName": "MY_SEPA_SCT", "executionDatetime": "2026-10-15T10:00:00Z", "messageXml": "<Document>...</Document>", "context": { "sendingCountry": "DE", "receivingCountry": "FR" } }
 

Layer 2 — Regulatory

R-transaction exemption assessment at message level.