Skip to main content
PUT
/
transfer
/
crypto-destination-address
Put Crypto Destination Address
curl --request PUT \
  --url https://api.paxos.com/v2/transfer/crypto-destination-address \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "address": "<string>",
  "identity_id": "<string>",
  "nickname": "<string>",
  "bookmarked_status": true,
  "travelrule_metadata": {
    "beneficiary": {
      "self": true
    },
    "vasp": {
      "id": "<string>",
      "name": "<string>"
    }
  }
}
'
{
  "address": {
    "id": "<string>",
    "address": "<string>",
    "identity_id": "<string>",
    "nickname": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "bookmarked": true,
    "travelrule_metadata": {
      "beneficiary": {
        "self": true,
        "person_details": {
          "first_name": "<string>",
          "last_name": "<string>",
          "physical_address": {
            "street_line_1": "<string>",
            "street_line_2": "<string>",
            "city": "<string>",
            "region": "<string>",
            "postal_code": "<string>",
            "country_code": "<string>"
          }
        },
        "institution_details": {
          "name": "<string>",
          "physical_address": {
            "street_line_1": "<string>",
            "street_line_2": "<string>",
            "city": "<string>",
            "region": "<string>",
            "postal_code": "<string>",
            "country_code": "<string>"
          }
        }
      },
      "vasp": {
        "id": "<string>",
        "name": "<string>"
      }
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://paxos-0ac97319-travel-rule-api-enhancements.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

OAuth Scope
transfer:write_crypto_destination_address

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

Upsert request for a crypto destination address. Provide (crypto_network, address) to identify the address, optionally scoped by identity_id in 3P flows.

​
crypto_network
enum<string>
required

A CryptoNetwork is a blockchain transmitting cryptocurrencies.

Available options:
BITCOIN,
ETHEREUM,
BITCOIN_CASH,
LITECOIN,
SOLANA,
POLYGON_POS,
BASE,
ARBITRUM_ONE,
STELLAR,
INK,
XLAYER
​
address
string
required
​
identity_id
string

Preview addition. The identity that owns this saved destination address. Required in 3P flows; omit for Dashboard-style flows where the address is not scoped to a particular identity.

​
nickname
string

Optional human-readable nickname. If omitted on creation, Paxos generates one.

​
bookmarked_status
boolean
​
travelrule_metadata
object

Travel Rule metadata associated with a crypto destination address.

Response

The upserted crypto destination address.

​
address
object