curl --request POST \
--url https://test.deribit.com/api/v2/private/update_in_address_book \
--header 'Authorization: Bearer <ACCESS_TOKEN>' \
--header 'Content-Type: application/json' \
--data '{
"jsonrpc": "2.0",
"id": 42,
"method": "private/update_in_address_book",
"params": {
"currency": "BTC",
"type": "withdrawal",
"address": "bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf0uyj",
"label": "Main address",
"beneficiary_vasp_name": "Money`s Gone",
"beneficiary_vasp_did": "did:example:123456789abcdefghi",
"beneficiary_first_name": "John",
"beneficiary_last_name": "Doe",
"beneficiary_address": "NL, Amsterdam, Street, 1",
"agreed": true,
"personal": false
}
}'{
"jsonrpc": "2.0",
"id": 42,
"result": "ok"
}private/update_in_address_book
Updates beneficiary information for an address in the address book. This method allows you to add or modify beneficiary details required for compliance purposes when making withdrawals to certain addresses.
Coinbase wallet type
For Coinbase wallet type accounts the method behaves differently:
- Required parameters are
currency(portfolio currencies or"all") andtype, plus one ofaddressorid(the entry identifier returned byprivate/get_address_book). Usenetworkandtagtogether withaddressto disambiguate entries sharing the same address. typeaccepts onlywithdrawalandtransfer.labelis optional.- Travel rule data is provided with the fields
name,country,address,financial_institution,account,account_location,entity_type(organizationorindividual),wallet_type(exchangeorself_hosted) andis_selfinstead of the legacybeneficiary_*,agreedandpersonalfields. - The response contains the updated Coinbase address book entry object instead of
"ok".
📖 Related Article: Managing Withdrawals
Scope: wallet:read_write
curl --request POST \
--url https://test.deribit.com/api/v2/private/update_in_address_book \
--header 'Authorization: Bearer <ACCESS_TOKEN>' \
--header 'Content-Type: application/json' \
--data '{
"jsonrpc": "2.0",
"id": 42,
"method": "private/update_in_address_book",
"params": {
"currency": "BTC",
"type": "withdrawal",
"address": "bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf0uyj",
"label": "Main address",
"beneficiary_vasp_name": "Money`s Gone",
"beneficiary_vasp_did": "did:example:123456789abcdefghi",
"beneficiary_first_name": "John",
"beneficiary_last_name": "Doe",
"beneficiary_address": "NL, Amsterdam, Street, 1",
"agreed": true,
"personal": false
}
}'{
"jsonrpc": "2.0",
"id": 42,
"result": "ok"
}Query Parameters
Address in currency format, it must be in address book. Required for legacy wallet type. Coinbase wallet type: required when id is not provided; use network and tag to disambiguate entries sharing the same address. For Coinbase wallet type the same value is also stored as the beneficiary address travel rule field.
Address in proper format for currency
"bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf0uyj"
Blockchain network resource name (e.g. networks/ethereum-mainnet), for Coinbase wallet types. Available networks are returned by public/get_currencies in coinbase_networks. Requiredness depends on the operation. When resolving an existing address-book entry, it is optional if the entry resolves uniquely; it disambiguates an address present on multiple networks.
"networks/ethereum-mainnet"
Was this page helpful?