Wallet
Private

Changed on

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.

Coinbase wallet type

For Coinbase wallet type accounts the method supports network selection and CTN (Coinbase Travel Network) counterparties, and behaves differently:

  • Required parameters are type and label, plus one of:
    • address together with currency and network (optional tag) — an on-chain address on the selected network, or
    • counterparty_id — a CTN counterparty; currency is then omitted and the entry applies to all currencies.
  • type accepts only withdrawal and transfer.
  • Travel rule data is provided with the fields name, country, address, financial_institution, account, account_location, entity_type (organization or individual), wallet_type (exchange or self_hosted) and is_self instead of the legacy beneficiary_*, agreed and personal fields.
  • extra_currencies is not supported.
  • The response contains a Coinbase address book entry object, including the entry id which can be used instead of address in the other address book methods.

📖 Related Article: Managing Withdrawals

Scope: wallet:read_write

Try in API console

get/private/add_to_address_book

Request

  • Base URL
    https://test.deribit.com/api/v2
  • URL
    https://test.deribit.com/api/v2/private/add_to_address_book
  • Auth
    none declared

Query parameters

currency'BTC' | 'ETH' | 'USDC' | 'USDT' | 'EURR'

Currency, i.e "BTC", "ETH", "USDC"

The currency symbol. Required for legacy wallet type (wallet currencies only). Coinbase wallet type: required when address is used (any portfolio currency); omitted when adding a CTN counterparty via counterparty_id — such entries apply to all currencies ("all").

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

Address book type

Address book type. Legacy wallet type: withdrawal, transfer or deposit_source. Coinbase wallet type: withdrawal or transfer only.

addressstring

Address in proper format for currency

Example:1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa

Address in currency format. Required for legacy wallet type. Coinbase wallet type: required when counterparty_id is not provided, and must then be used together with currency and network (and tag for networks that require one). For Coinbase wallet type the same value is also stored as the beneficiary address travel rule field.

networkstring
Example:networks/ethereum-mainnet

Blockchain network for the wallet operation, given as a network resource name (e.g. "networks/ethereum-mainnet"). Coinbase wallet type only. The networks available for each currency are returned by public/get_currencies in the coinbase_networks field. Required for operations that target an on-chain address or a deposit address; also used to disambiguate address book entries when the same address exists on multiple networks.

tagstring

Destination tag / memo for networks that support one. Coinbase wallet type only. Used together with address and network; also serves to disambiguate address book entries that share the same address.

counterparty_idstring
Example:cp-8f3e2a1b9c4d

Identifier of a Coinbase Travel Network (CTN) counterparty. Coinbase wallet type only. Used instead of address and network; entries created with counterparty_id apply to all currencies, so currency is omitted.

labelstring required

Label of the address book entry

Example:Main address
beneficiary_vasp_namestring

Name of beneficiary VASP

Example:Money's Gone

Name of beneficiary VASP. Legacy wallet type only.

beneficiary_vasp_didstring

DID of beneficiary VASP

Example:did:example:123456789abcdefghi

DID of beneficiary VASP. Legacy wallet type only.

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

Geographical address of the beneficiary

Example:NL, Amsterdam, Street, 1

Geographical address of the beneficiary. Legacy wallet type only.

agreedboolean

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. Legacy wallet type only.

personalboolean

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. Legacy wallet type only.

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.

[
  "USDC"
]
namestring
Example:Alice Smith

Full name of the beneficiary (person or organization). Coinbase wallet type only — travel rule data.

countrystring
Example:NL

Country code of the beneficiary (ISO 3166-1 alpha-2). Coinbase wallet type only — travel rule data.

financial_institutionstring

Name of the financial institution holding the beneficiary account. Coinbase wallet type only — travel rule data.

accountstring

Account identifier of the beneficiary at the financial institution. Coinbase wallet type only — travel rule data.

account_locationstring

Location of the beneficiary account. Coinbase wallet type only — travel rule data.

entity_type'organization' | 'individual'

Type of the beneficiary entity. Coinbase wallet type only — travel rule data.

wallet_type'exchange' | 'self_hosted'

Type of the beneficiary wallet. Coinbase wallet type only — travel rule data.

is_selfboolean

Indicates that the beneficiary is the account owner. Coinbase wallet type only — travel rule data.

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
  }
}

Changes

  • f1c92835a183Revision changes
    • breaking

      removed the enum value BNB from the query request parameter currency

    • breaking

      removed the enum value ETHW from the query request parameter currency

    • breaking

      removed the enum value PAXG from the query request parameter currency

    • breaking

      removed the enum value SOL from the query request parameter currency

    • breaking

      removed the enum value STETH from the query request parameter currency

    • breaking

      removed the enum value USDE from the query request parameter currency

    • breaking

      removed the enum value USYC from the query request parameter currency

    • breaking

      removed the enum value XRP from the query request parameter currency

    • breaking

      added to the response property oneOf list for the response status

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      added the new optional query request parameter account

    • info

      added the new optional query request parameter account_location

    • info

      added the new optional query request parameter counterparty_id

    • info

      added the new optional query request parameter country

    • info

      added the new optional query request parameter entity_type

    • info

      added the new optional query request parameter financial_institution

    • info

      added the new optional query request parameter is_self

    • info

      added the new optional query request parameter name

    • info

      added the new optional query request parameter network

    • info

      added the new optional query request parameter tag

    • info

      added the new optional query request parameter wallet_type

    • info

      the query request parameter address became optional

    • info

      the query request parameter agreed became optional

    • info

      the query request parameter beneficiary_address became optional

    • info

      the query request parameter beneficiary_vasp_did became optional

    • info

      the query request parameter beneficiary_vasp_name became optional

    • info

      the query request parameter currency became optional

    • info

      the query request parameter personal became optional