---
title: "GET /private/add_to_address_book"
method: GET
path: "/private/add_to_address_book"
tags: ["Wallet", "Private"]
---

# GET /private/add_to_address_book

`GET /private/add_to_address_book`

Adds a new address to the address book. The address book allows you to store addresses for withdrawals, along with beneficiary information for compliance purposes.

**📖 Related Article:** [Managing Withdrawals](https://docs.deribit.com/articles/managing-withdrawals-api)

**Scope:** `wallet:read_write`

[Try in API console](https://test.deribit.com/api_console?method=%2Fprivate%2Fadd_to_address_book)

## Query parameters

- `currency` 'BTC' | 'ETH' | 'STETH' | 'ETHW' | 'USDC' | 'USDT' | 'EURR' | 'SOL' | 'XRP' | 'USYC' | 'PAXG' | 'BNB' | 'USDE', required — Currency, i.e `"BTC"`, `"ETH"`, `"USDC"`
- `type` 'transfer' | 'withdrawal' | 'deposit_source', required — Address book type
- `address` string, required
- `label` string, required — Label of the address book entry
- `beneficiary_vasp_name` string, required — Name of beneficiary VASP
- `beneficiary_vasp_did` string, required — DID of beneficiary VASP
- `beneficiary_vasp_website` string — Website of the beneficiary VASP
- `beneficiary_first_name` string — First name of the beneficiary (if beneficiary is a person)
- `beneficiary_last_name` string — Last name of the beneficiary (if beneficiary is a person)
- `beneficiary_company_name` string — Company name of the beneficiary (if beneficiary is a company)
- `beneficiary_address` string, required — Geographical address of the beneficiary
- `agreed` boolean, required — Indicates that the user agreed to shared provided information with 3rd parties
- `personal` boolean, required — The user confirms that he provided address belongs to him and he has access to it via an un-hosted wallet software
- `extra_currencies` string[] — The user can pass a list of currencies to add the address for. It is currently available ONLY for ERC20 currencies. Without passing this paramater for an ERC20 currency, the address will be added to ALL of the ERC20 currencies.

## Response `200`

Success response

- PrivateAddToAddressBookResponse
  - `jsonrpc` '2.0', required — The JSON-RPC version (2.0)
  - `id` integer — The id that was sent in the request
  - `result` AddressBookItem, required
    - `currency` 'BTC' | 'ETH' | 'STETH' | 'ETHW' | 'USDC' | 'USDT' | 'EURR' | 'SOL' | 'XRP' | 'USYC' | 'PAXG' | 'BNB' | 'USDE', required — Currency, i.e `"BTC"`, `"ETH"`, `"USDC"`
    - `address` string, required — Address in proper format for currency
    - `creation_timestamp` integer, required — The timestamp (milliseconds since the Unix epoch)
    - `type` 'transfer' | 'withdrawal' | 'deposit_source' — Address book type
    - `label` string — Label of the address book entry
    - `beneficiary_vasp_name` string — Name of beneficiary VASP
    - `beneficiary_vasp_did` string — DID of beneficiary VASP
    - `beneficiary_vasp_website` string — Website of the beneficiary VASP
    - `beneficiary_first_name` string — First name of the beneficiary (if beneficiary is a person)
    - `beneficiary_last_name` string — Last name of the beneficiary (if beneficiary is a person)
    - `beneficiary_company_name` string — Company name of the beneficiary (if beneficiary is a company)
    - `beneficiary_address` string — Geographical address of the beneficiary
    - `agreed` boolean — Indicates that the user agreed to shared provided information with 3rd parties
    - `personal` boolean — The user confirms that he provided address belongs to him and he has access to it via an un-hosted wallet software
    - `info_required` boolean — Signalises that addition information regarding the beneficiary of the address is required
    - `status` 'admin_locked' | 'waiting' | 'confirmed' | 'ready' — Wallet address status, values: [`admin_locked`, `waiting`, `confirmed`, `ready`]
    - `waiting_timestamp` boolean — Timestamp when the address will be ready
    - `requires_confirmation` boolean — If address requires email confirmation for withdrawals
    - `requires_confirmation_change` boolean — If email confirmation change is in progress

---

[API](https://skmtc.net/deribit/apis/deribit-api-2.md) · [All operations](https://skmtc.net/deribit/apis/deribit-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/deribit/deribit-api-2/revisions/8dfbbe9fdddf/schema)