X-Request-IDstring(uuid)
Client-supplied correlation ID echoed in response headers for tracing.
EP-04 — Convert Party Address (ARS AutoCorrect)
Converts a single party address to the requested target format.
OUTBOUND (default): SR2026 enforcement applies.
INBOUND: downgrade to FULLY_UNSTRUCTURED permitted — output is internal-use-only,
must never be re-injected into outgoing payment messages.
Business Rules:
- C-01: targetFormat
autoselects FULLY_STRUCTURED for __2 parties; HYBRID for SR2026 unstructured input. - C-02: FULLY_UNSTRUCTURED is never valid for __2 variant parties — HTTP 422.
- C-03: OUTBOUND + SR2026 + post-cutover: FULLY_UNSTRUCTURED target rejected. INBOUND: skipped.
- C-04: PMPG non-duplication enforced on all HYBRID outputs.
- C-05: OUTBOUND fallback chain: FULLY_STRUCTURED → HYBRID → REJECT.
- C-06: outputFormat ≠ targetFormat: WARNING explains fallback used.
- C-07: Postal verification payload — address fields only; no names/BICs/IBANs/LEIs.
- C-08: Input already at targetFormat → returned unchanged with confidence 1.0.
- C-09: INBOUND HYBRID→UNSTRUCTURED: existing AdrLine preserved in lines 1–2.
- C-10: INBOUND STRUCTURED→UNSTRUCTURED: all 14 fields rendered per PMPG §5 priority.
- C-11: Truncation with PMPG ‘+’ marker at limit-1.
- C-12: INBOUND downgrade always includes INFO issue marking result as internal-use-only.
Processing precedence: channelProfile → processingOptions → context.
post
https://api-uat.ionova.ai/ars/convert-party-address
Headers
Body
Body
ConvertPartyAddressRequest
EP-04 request. Format conversion to targetFormat.
channelNamestring
namestring
ISO 20022 party name. Used for entity conflict detection.
postalAddressobject
ISO 20022 PostalAddress24 object. All 14 structured fields 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
postalAddressXmlobject
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
identificationobject
Optional party identifiers. Used for entity conflict detection (R-04).
Show Child Parameters
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
includearray[string]
Response
Response
Conversion completed
ConvertPartyAddressResponse
statusstring
Outcome of AutoCorrect processing for an address.
Allowed values:VALIDATEDREPAIREDPARTIALLY_REPAIREDNOT_REPAIRED
successboolean
TRUE if conversion achieved target or fallback format. Preserved for backward compatibility.
inputFormatstring
Detected or target address format classification.
Allowed values:FULLY_STRUCTUREDHYBRIDFULLY_UNSTRUCTURED
outputFormatstring
Detected or target address format classification.
Allowed values:FULLY_STRUCTUREDHYBRIDFULLY_UNSTRUCTURED
correctedAddressobject
Corrected PostalAddress24 fields. null when status = NOT_REPAIRED.
Show Child Parameters
confidenceobject
Show Child Parameters
reasonsarray[object]
Structured reason code. Prefix indicates category:
FMT = format, FLD = field, REG = regulatory, ENT = entity, VRF = verification, CNV = conversion.
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
statisticsobject
Processing statistics block returned on all endpoints.
Show Child Parameters
timestampstring(date-time)
post/convert-party-address
Authentication
Headers
Body
{
"channelName": "MY_SEPA_SCT",
"name": "PETRA DUPONT",
"postalAddress": {
"addressLine": [
"CITY HALL GROTE MARKT 1",
"1000 BRUSSELS"
],
"country": "BE"
},
"processingOptions": {
"targetFormat": "HYBRID"
}
}
EP-05 — Render Party Address
Renders a structured or hybrid address into AddressLine-only format following
PMPG Section 5 mapping priorities. Country always preserved separately.
PMPG mapping priority:
- Line 1 (street-level): StreetName+BuildingNumber, BuildingName, Floor, PostBox, Room, Department, SubDepartment.
- Line 2 (locality): PostCode+TownName, CountrySubDivision, TownLocationName, DistrictName.
- Country: always output separately — never embedded in rendered lines.
For MT RTGS compatibility: maxLines=3, maxLineLength=35.
Processing precedence: channelProfile → processingOptions → context.
post
https://api-uat.ionova.ai/ars/render-party-address
Headers
X-Request-IDstring(uuid)
Client-supplied correlation ID echoed in response headers for tracing.
Body
Body
RenderPartyAddressRequest
EP-05 request. Formats address into unstructured lines per OutputMode limits.
channelNamestring
namestring
ISO 20022 party name. Included in rendered output when present.
postalAddressobject
ISO 20022 PostalAddress24 object. All 14 structured fields 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
postalAddressXmlobject
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
maxLinesinteger
Maximum output lines. Overrides channelProfile format limits.
maxLineLengthinteger
Maximum chars per output line. Overrides channelProfile. Default 35.
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
Response
Rendering completed
RenderPartyAddressResponse
decisionstring
Allowed values:ACCEPTPARTIAL_SUCCESS
resultobject
Show Child Parameters
statisticsobject
Processing statistics block returned on all endpoints.
Show Child Parameters
timestampstring(date-time)
post/render-party-address
Authentication
Headers
Body
{
"channelName": "MY_SEPA_SCT",
"name": "JOHN SMITH",
"postalAddress": {
"streetName": "Hoogstraat",
"buildingNumber": "6",
"floor": "18th Floor",
"postCode": "1000",
"townName": "Brussels",
"country": "BE"
},
"maxLines": 2,
"maxLineLength": 70
}
EP-06 — Classify Party Address
Lightest available endpoint. Returns format classification only — no validation,
verification, conversion, or normalisation. Extremely low latency.
Classification logic:
- FULLY_STRUCTURED: Country + TownName present AND no AddressLine.
- HYBRID: Country + TownName present AND AddressLine present.
- FULLY_UNSTRUCTURED: anything else.
No issues[] or reasons[] in response. Context fields are analytics only.
Processing precedence: channelProfile → processingOptions → context.
post
https://api-uat.ionova.ai/ars/classify-party-address
Headers
X-Request-IDstring(uuid)
Client-supplied correlation ID echoed in response headers for tracing.
Body
Body
ClassifyPartyAddressRequest
EP-06 request. Lightweight classification only — no repair.
channelNamestring
postalAddressobject
ISO 20022 PostalAddress24 object. All 14 structured fields 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
postalAddressXmlobject
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
contextobject
Analytics only for this endpoint — no processing fallback.
Show Child Parameters
Response
Response
Classification completed
ClassifyPartyAddressResponse
formatstring
Detected or target address format classification.
Allowed values:FULLY_STRUCTUREDHYBRIDFULLY_UNSTRUCTURED
hasAddressLineboolean
addressLineCountinteger
hasStructuredFieldsboolean
hasTownNameboolean
hasCountryboolean
post/classify-party-address
Authentication
Headers
Body
{
"postalAddress": {
"postCode": "1000",
"townName": "Brussels",
"country": "BE",
"addressLine": [
"CITY HALL GROTE MARKT 1"
]
}
}
Layer 1 — Regulatory
R-transaction exemption assessment at party address level.
EP-07 — R-Transaction Party Address
Evaluates EPC Section 8.3 exemption for a single R-transaction address.
The address is NEVER modified.
Exemption logic:
- originalExecutionDatetime < 2026-11-22T02:30:00Z → exempt; unstructured accepted.
- originalExecutionDatetime ≥ cutover → SR2026 enforcement applies.
- Not provided → exemptionApplicable: null; structural validation attempted.
EPC §8.3: pain.002 and pain.007 report structural issues as warnings only.
Processing precedence: channelProfile → processingOptions → context.
post
https://api-uat.ionova.ai/ars/r-transaction-party-address
Headers
X-Request-IDstring(uuid)
Client-supplied correlation ID echoed in response headers for tracing.
Body
Body
RTransactionPartyAddressRequest
EP-07 request. R-transaction address exemption assessment.
channelNamestring
postalAddressobjectrequired
The exact address as it appears in the R-message. Must not be altered.
Show Child Parameters
originalExecutionDatetimestring(date-time)
When the original payment was executed. Determines SR2026 exemption eligibility.
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
Response
R-transaction assessment completed
RTransactionPartyAddressResponse
decisionstring
Top-level processing decision.
Allowed values:ACCEPTREJECTPARTIAL_SUCCESS
rTransactionContextobject
R-transaction exemption assessment result.
Show Child Parameters
resultobject
Address exactly as submitted — NO repair is applied.
Show Child Parameters
statisticsobject
Processing statistics block returned on all endpoints.
Show Child Parameters
timestampstring(date-time)
post/r-transaction-party-address
Authentication
Headers
Body
{
"channelName": "MY_SEPA_SCT",
"postalAddress": {
"addressLine": [
"10 Unter den Linden",
"10117 Berlin"
],
"country": "DE"
},
"originalExecutionDatetime": "2026-10-01T08:00:00Z"
}