Search
K
ARS — Address Resolution Service

CheckMessageResponse

object
messageStatusstring

Outcome of structural pre-check validation.

Allowed values:COMPLIANTNOT_COMPLIANT

compliantCountinteger
nonCompliantCountinteger
discoveredAddressesinteger
resultsarray[object]
Show Child Parameters
timestampstring(date-time)
Example

ClassifyMessageRequest

object

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

channelNamestring
messageContentobject
messageXmlstring
contextobject

Analytics only for this endpoint.

Show Child Parameters
Example

ClassifyMessageResponse

object
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)
Example

ConvertMessageRequest

object

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
Example

ConvertMessageResponse

object
messageStatusstring

Outcome of AutoCorrect processing for an address.

Allowed values:VALIDATEDREPAIREDPARTIALLY_REPAIREDNOT_REPAIRED

correctedMessageXmlstring

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)
Example