Search
K
ARS — Address Resolution Service

CountryDetailResponse

object
codestring

Match pattern:^[A-Z]{2}$

namestring
sepaMemberboolean
eeaMemberboolean
elementUsageobject

PMPG usage indicators for all 14 PostalAddress24 structured fields. M=Mandatory, E=Expected, O=Optional, C=Conditional, N=Not used.

Show Child Parameters
Example

SchemesResponse

object
schemesarray[object]
Show Child Parameters
Example

SchemeMessageTypesResponse

object
schemestring

Payment scheme identifier.

Allowed values:SCTSCT_INSTSDD_CORESDD_B2BOCT_INSTCBPRPLUSCHAPST2EURO1FEDWIREOTHER

messageTypesarray[object]
Show Child Parameters
Example

HealthResponse

object
statusstring

Operational status of the ARS service.

Allowed values:healthydegradedunhealthy

versionstring

Current ARS version (e.g. 4.3.1).

Example:4.3.1

timestampstring(date-time)

Current server time in ISO 8601 UTC format.

dependenciesobject

Sub-system health map. One entry per external dependency the ARS instance is
currently wired to (database, cache, Kong gateway, Cognito, postal DB, etc.).
Useful for ops dashboards; clients can ignore when only status is needed.

Example

DependencyStatus

object

Health snapshot for one sub-system dependency.

statusstring

Allowed values:UPDEGRADEDDOWNUNKNOWN

latencyMsnumber

Most recent probe latency in milliseconds.

messagestring

Optional human-readable status detail.

Example