Wallet
Private

Saves beneficiary information for an address. This method allows you to store beneficiary details required for compliance purposes, including VASP information, personal details, and wallet type classification.

📖 Related Article: Managing Withdrawals

Scope: wallet:read_write

Try in API console

get/private/save_address_beneficiary

Request

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

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.

📖 Related Article: Using the currency Parameter

addressstring required

Address in currency format

tagstring

Tag for XRP addresses

agreedboolean required

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

Example:true
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
unhostedboolean required

Indicates if the address belongs to an unhosted wallet

beneficiary_vasp_namestring required

Name of beneficiary VASP

Example:Money's Gone
beneficiary_vasp_didstring required

DID of beneficiary VASP

Example:did:example:123456789abcdefghi
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

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",
    "user_id": 57874,
    "agreed": true,
    "personal": true,
    "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",
    "created": 1536569522277,
    "updated": 1536569522277
  }
}

Changes

No recorded changes to this operation across all 11 revisions of this API.