Search
K
ARS — Address Resolution Service

EP-27 — Read Channel Profile

Returns the complete channel profile for the specified channelName, including all
channelSelection, corridor, and preferences fields.
Returns HTTP 404 if channelName not found.

get
https://api-uat.ionova.ai/ars/channel-profile/{name}

Path Parameters

namestringrequired

channelName of the profile to read

Headers

X-Request-IDstring(uuid)

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

Response

application/json

Channel profile returned

ChannelProfileResponse

Full channel profile returned by EP-25 (201), EP-26 (200), and EP-27 (200).

channelNamestring

Example:CBPR_OUTBOUND_US

channelSelectionobject

Channel identification block for channelProfile registration and retrieval.

Show Child Parameters
corridorobject

Default corridor (geographic routing) block for a channelProfile.

Show Child Parameters
preferencesobject

Output and behaviour preference defaults for a channelProfile.

Show Child Parameters
createdAtstring(date-time)

Timestamp when this channel profile was first registered.

updatedAtstring(date-time)

Timestamp when this channel profile was last updated.

get/channel-profile/{name}
 
application/json

Layer 5 — Health

Service availability. No authentication required.

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