# Address book and external accounts

Product: Account API
Guides follow API reference 0.1.0 and event reference 0.1.0.
Canonical page: https://docs.sandbox.axiym.io/account-api/concepts/address-book

Your **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.



```mermaid
flowchart TD
  funding["Whitelisted external account"] -->|Deposit| axiym["Axiym account"]
  axiym -->|Withdrawal| receiving["Whitelisted external account"]

  class funding,receiving externalNode
  class axiym accountNode
  classDef externalNode stroke-width:1.5px
  classDef accountNode stroke-width:2px
```



## 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.



```mermaid
flowchart TD
  register["Register a bank account or wallet"] --> review["PENDING_REVIEW<br/>Due diligence and compliance checks"]
  review -->|Checks passed| active["ACTIVE"]
  active --> deposit["Use as the source of deposits"]
  active --> withdrawal["Use as the recipient of withdrawals"]

  class register actionNode
  class review reviewNode
  class active activeNode
  class deposit,withdrawal actionNode
  classDef actionNode stroke-width:1.25px
  classDef reviewNode stroke-width:1.5px
  classDef activeNode stroke-width:1.5px
```



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

| Status           | Meaning                                                                                   |
| ---------------- | ----------------------------------------------------------------------------------------- |
| `PENDING_REVIEW` | Axiym is performing due diligence and compliance checks on the external account.          |
| `ACTIVE`         | The external account is whitelisted and available for supported deposits and withdrawals. |
| `SUSPENDED`      | The external account is unavailable for use.                                              |
| `CLOSED`         | The 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](/account-api/concepts/depositing-funds) or
[Withdrawing funds](/account-api/concepts/withdrawing-funds) to follow the
movement of funds. For registration requests and identifiers, see
[Add to the address book](/account-api/integration-guide/add-to-address-book).
