Axiym

Address book and external accounts

View Markdown

Each client's address book contains registered external accounts: bank accounts and wallets used for deposits and withdrawals. Each address book entry represents one external account.

Axiym performs due diligence and compliance checks before an external account becomes ACTIVE. Only active, whitelisted external accounts can be used:

  • deposits must originate from a whitelisted external account; and
  • withdrawals can be sent only to a whitelisted external account.

Register external accounts for the selected client

Each client has its own address book. External accounts must be registered and whitelisted in the same client context as the Axiym accounts they fund or receive withdrawals from.

External accounts and address book entries

An external account is a bank account or wallet outside Axiym. The address book holds the records of these accounts, including their review status. Each entry represents one external account and has its own destinationId.

Whitelist external accounts before moving funds

Registering an external account creates a reusable record and submits it for review. Wait until it is ACTIVE before using it for deposits or withdrawals.

External accounts that are pending review, suspended, or closed cannot be used.

External account types

Bank account

Identified by its currency, IBAN or domestic account number, bank name, and bank country, with SWIFT/BIC where required. Deposits originate from this account, and withdrawals send funds to it.

Wallet address

Identified by its currency, wallet address, and blockchain network. A wallet deposit must originate from this wallet on the specified network, and a withdrawal can send funds to it.

External account lifecycle

StatusMeaning
PENDING_REVIEWAxiym is performing due diligence and compliance checks on the external account.
ACTIVEThe external account is whitelisted and available for supported deposits and withdrawals.
SUSPENDEDThe external account is unavailable for use.
CLOSEDThe external account has been permanently retired from the address book.

Status changes are reported through webhook events and are also available when viewing the address book entry.

How deposits use the address book

The whitelisted external account identifies where incoming funds may come from. Deposit instructions identify where those funds must be sent to credit an Axiym account. The sending external account and the receiving details serve different roles.

How withdrawals use the address book

A withdrawal sends funds from an Axiym account to an active, whitelisted external account in the same currency. The address book provides the reusable record of the receiving bank account or wallet.

Continue with Depositing funds or Withdrawing funds to follow the movement of funds. For registration requests and identifiers, see Add to the address book.