Axiym

List address book entries

Returns the external bank accounts and wallets registered in the selected client's address book, including their current status. Filter the results by currency or status.

An external account is whitelisted for deposits and withdrawals when its status is ACTIVE.

View MarkdownView complete reference

Authorization

Default
AuthorizationBearer <token>

In: header

Path Parameters

clientId*string

Client identifier (UUID) assigned when an onboarding case is created. It identifies the onboarding case and, once active, the client's Client Account API resources. The client must belong to your partnership; anyone else's id returns 404.

Formatuuid

Query Parameters

first?integer

Maximum number of items to return (page size).

Range1 <= value <= 100
Default20
after?string

Cursor for the next page, from the previous response's pageInfo.endCursor.

currency?string

Filter by currency.

status?string

Filter by status.

Allowed values

  • "PENDING_REVIEW"
  • "ACTIVE"
  • "SUSPENDED"
  • "CLOSED"

Header Parameters

X-Request-Id?string

Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the X-Request-Id response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json