PUT
/
address-book
/
{id}
Update address book
curl --request PUT \
  --url https://api.exchange.coinbase.com/address-book/{id} \
  --header 'Content-Type: application/json' \
  --header 'cb-access-key: <api-key>' \
  --header 'cb-access-passphrase: <api-key>' \
  --header 'cb-access-sign: <api-key>' \
  --header 'cb-access-timestamp: <api-key>' \
  --data '{
  "id": "<string>",
  "label": "<string>",
  "is_verified_self_hosted_wallet": true,
  "vasp_id": "<string>",
  "business_name": "<string>",
  "business_country_code": "<string>",
  "is_certified_self_send": true,
  "network": "<string>",
  "wallet_verification_network": "<string>"
}'
{
  "id": "1",
  "address": "1JmYrFBLMSCLBwoL87gdQ5Qc9MLvb2egKk",
  "display_address": "1JmYrFBLMSCLBwoL87gdQ5Qc9MLvb2egKk",
  "address_info": {
    "address": "1JmYrFBLMSCLBwoL87gdQ5Qc9MLvb2egKk",
    "display_address": "1JmYrFBLMSCLBwoL87gdQ5Qc9MLvb2egKk"
  },
  "currency": "BTC",
  "label": "my wallet",
  "address_booked": true,
  "address_book_added_at": "2019-02-06T22:27:50.221Z"
}

Authorizations

​
cb-access-key
string
header
required
​
cb-access-passphrase
string
header
required
​
cb-access-sign
string
header
required
​
cb-access-timestamp
string
header
required

Path Parameters

​
id
string
required

Body

application/json
​
id
string
required
​
label
string
required
​
is_verified_self_hosted_wallet
boolean

Flag to indicate if the crypto addresses has previously been digitally signed and verified when added in the Address Book UI tab

​
vasp_id
string

The VASP identifier if the address is owned by one of the supported Virtual Asset Service Providers

​
business_name
string

Business name

​
business_country_code
string

The country code (ISO 3166-1 alpha-2) of the originator's account location.

​
is_certified_self_send
boolean

Flag to indicate if the user owns the crypto address

​
network
string

Blockchain network of the address. If null or not provided, the network field remains unchanged. Use * to make the address available on all supported networks compatible with the asset (e.g., both ethereum and arbitrum for an ERC-20 token). Alternatively, specify a single network name (e.g., ethereum, bitcoin)

​
wallet_verification_network
string

Blockchain network used to verify ownership of the wallet address

Response

​
id
string
required
​
address
string
required
​
address_info
object
required
​
currency
string
required

Asset symbol for the saved address (e.g., BTC, ETH, USDC). _ALL_ASSETS_ indicates that this address is stored globally for all assets, rather than a specific one. The network field determines which blockchain network the address applies to.

​
label
string
required
​
display_address
string
required
​
address_booked
boolean
required
​
address_book_added_at
string<date-time>
required
​
address_book_entry_pending_until
string<date-time>
​
is_verified_self_hosted_wallet
boolean

Flag to indicate if the crypto addresses has previously been digitally signed and verified when added in the Address Book UI tab

​
vasp_id
string

The VASP identifier if the address is owned by one of the supported Virtual Asset Service Providers

​
business_name
string

Business name of the originator's account

​
business_country_code
string

The country code (ISO 3166-1 alpha-2) of the originator's account location.

​
network
string

Blockchain network of the address. If null or not provided, the address is available on all supported networks compatible with the asset (e.g., both ethereum and arbitrum for an ERC-20 token).