Sign in

v2

OpenAPI 3.0.02026-07-311824171.4 MB
Wallet
Private

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

Scope: wallet:read_write

Try in API console

get/private/add_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"

The currency symbol

type'transfer' | 'withdrawal' | 'deposit_source' required

Address book type

Address book type

addressstring required

Address in currency format

labelstring required

Label of the address book entry

Example:Main address

Label of the address book entry

beneficiary_vasp_namestring required

Name of beneficiary VASP

Example:Money's Gone

Name of beneficiary VASP

beneficiary_vasp_didstring required

DID of beneficiary VASP

Example:did:example:123456789abcdefghi

DID of beneficiary VASP

beneficiary_vasp_websitestring

Website of the beneficiary VASP

Website of the beneficiary VASP. Required if the address book entry is associated with a VASP that is not included in the list of known VASPs

beneficiary_first_namestring

First name of the beneficiary (if beneficiary is a person)

Example:John

First name of beneficiary (if beneficiary is a person)

beneficiary_last_namestring

Last name of the beneficiary (if beneficiary is a person)

Example:Doe

First name of beneficiary (if beneficiary is a person)

beneficiary_company_namestring

Company name of the beneficiary (if beneficiary is a company)

Example:Company Name

Beneficiary company name (if beneficiary is a company)

beneficiary_addressstring required

Geographical address of the beneficiary

Example:NL, Amsterdam, Street, 1

Geographical address of the beneficiary

agreedboolean required

Indicates that the user agreed to shared provided information with 3rd parties

Example:true

Indicates that the user agreed to shared provided information with 3rd parties

personalboolean required

The user confirms that he provided address belongs to him and he has access to it via an un-hosted wallet software

Example:true

The user confirms that he provided address belongs to him and he has access to it via an un-hosted wallet software

extra_currenciesstring[]

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.

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.

[
  "USDC"
]

Response

Success response

jsonrpc'2.0' required

The JSON-RPC version (2.0)

idinteger

The id that was sent in the request

Example response

{
  "result": {
    "address": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
    "creation_timestamp": 1536569522277,
    "label": "Main address",
    "beneficiary_vasp_name": "Money's Gone",
    "beneficiary_vasp_did": "did:example:123456789abcdefghi",
    "beneficiary_first_name": "John",
    "beneficiary_last_name": "Doe",
    "beneficiary_company_name": "Company Name",
    "beneficiary_address": "NL, Amsterdam, Street, 1",
    "agreed": true,
    "personal": true,
    "info_required": true,
    "waiting_timestamp": true,
    "requires_confirmation": true,
    "requires_confirmation_change": true
  }
}