Sign in

v1

latestOpenAPI 3.0.02026-07-26117342409.6 KB
Crypto Withdrawals

Put Crypto Destination Addresses

Updates a specified crypto destination address. If the address does not exist, it will be created

put/transfer/crypto-destination-address

Request body

idstring

Optional field to specify the crypto destination address to update by its unique id. Specify either id or the (crypto_network, address, identity_id) tuple, not both.

identity_idstring

The Identity that owns this destination address. Required for 3P integrations. When looking up an existing address to update, (crypto_network, address, identity_id) uniquely identifies it; omit for first-party addresses with no identity scope.

crypto_network'BITCOIN' | 'ETHEREUM' | 'BITCOIN_CASH' | 'LITECOIN' | 'SOLANA' | 'POLYGON_POS' | 'BASE' | 'ARBITRUM_ONE' | 'STELLAR' | 'INK' | 'XLAYER' | 'AVALANCHE' | 'DOGECOIN' | 'SUI' | 'ROBINHOOD' | 'BNB'

A CryptoNetwork is a blockchain transmitting cryptocurrencies.

addressstring

Specify the address of the crypto destination address to create/update. Specify either id or the (crypto_network, address, identity_id) tuple, not both.

nicknamestring

Optional field to update the nickname of the crypto destination address. Defaults to an auto-generated nickname if not specified on creation.

bookmarked_statusboolean

Optional field to update the bookmarked status of the crypto destination address. Defaults to false if not specified on creation.

Response

A successful response.

Example response

{
  "address": {
    "id": "31f20a34-c1eb-4c86-adad-1e46bc271e1a",
    "crypto_network": "ETHEREUM",
    "address": "0xe4B0aCA9FB669817775274775b20e52118595515",
    "nickname": "my_new_address",
    "status": "APPROVED",
    "created_at": "2024-01-01T00:00:00Z",
    "bookmarked": true
  }
}