Search
K
ARS — Address Resolution Service

EP-24 — Health

Returns the operational status of the ARS service. No API key or bearer token required.
Suitable for uptime monitoring, load balancer health probes, and status dashboards.

get
https://api-uat.ionova.ai/ars/health

Headers

X-Request-IDstring(uuid)

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

Response

application/json

Health status returned

HealthResponse

statusstring

Operational status of the ARS service.

Allowed values:healthydegradedunhealthy

versionstring

Current ARS version (e.g. 4.3.0).

Example:4.3.0

timestampstring(date-time)

Current server time in ISO 8601 UTC format.

get/health
 
application/json

SchemeCode

string

Payment scheme identifier.

Allowed values:SCTSCT_INSTSDD_CORESDD_B2BOCT_INSTCBPRPLUSCHAPST2EURO1FEDWIREOTHER

SchemeVersion

string

ISO 20022 scheme version / SR year.

Allowed values:SR2025SR2026

Direction

string

Payment processing direction. OUTBOUND = sending; INBOUND = receiving.

Allowed values:OUTBOUNDINBOUND

PartyRole

string

ISO 20022 party role. Determines the PostalAddress24 XSD variant:

  • __2 variant (ultimate_debtor, ultimate_creditor, initiating_party):
    TownName AND Country are MANDATORY. FULLY_UNSTRUCTURED is NEVER permitted (REG-05).
  • __1 variant (debtor, creditor):
    Max 3 AddressLines. FULLY_UNSTRUCTURED is permitted until SR2026 cutover (2026-11-22T02:30:00Z) for INBOUND;
    banned OUTBOUND post-cutover.

Allowed values:debtorcreditorultimate_debtorultimate_creditorinitiating_party