Skip to main content
GET
List Crypto Destination Addresses
OAuth Scope

Bookmarked addresses and status

A bookmarked address is saved to your address book. The Addresses page in the Paxos Dashboard shows exactly your bookmarked addresses. Adding an address in the Dashboard bookmarks it. To bookmark an address through the API, set "bookmarked_status": true on Put Crypto Destination Address. status only applies to bookmarked addresses. It is the approval state of the saved address: status reflects your organization’s own approval settings. It is not a Paxos compliance review. APPROVED means the address passed your approval process, not that Paxos cleared it.

Empty fields are omitted

The API omits empty fields from the JSON response. When an address is not bookmarked, the response omits both status and bookmarked (because bookmarked is false). This is expected behavior. Calling List Crypto Destination Addresses returns the same result, so polling does not produce a status for an address that isn’t bookmarked. To get a status back, bookmark the address by including "bookmarked_status": true in your PUT request. For API requests, the response includes "bookmarked": true and "status": "APPROVED".

Withdrawals and Travel Rule data

  • You can create crypto withdrawals through the API to addresses that are not bookmarked.
  • Bookmarking is required for withdrawals created in the Paxos Dashboard, or when Paxos has configured your account to require it for API withdrawals.
  • Paxos stores and checks the address’s travelrule_metadata whether or not the address is bookmarked. See the Travel Rule guide.
Each (crypto_network, address, identity_id) combination is a separate record. If you have one record for an address linked to an Identity and another with no identity_id, bookmark the record your withdrawals use.

Authorizations

Authorization
string
header
required

Paxos APIs use OAuth 2 with the client credentials grant flow.

Token URLs:

Learn more in the API credentials guide →

Query Parameters

ids
string[]

Optionally filter by the UUIDs of the crypto destination addresses. Limit 100.

identity_ids
string[]

Optionally filter by the Identities the destination addresses are scoped to. Limit 100.

crypto_networks
enum<string>[]

Optionally filter by the crypto_network of the destination addresses. Limit 100.

Available options:
BITCOIN,
ETHEREUM,
BITCOIN_CASH,
LITECOIN,
SOLANA,
POLYGON_POS,
BASE,
ARBITRUM_ONE,
STELLAR,
INK,
XLAYER,
AVALANCHE,
DOGECOIN,
SUI,
ROBINHOOD,
BNB,
OP,
COSMOS,
TRON,
APTOS,
HYPEREVM,
MANTLE,
RIPPLE,
STABLE
addresses
string[]

Optionally filter by specific addresses. Limit 100.

nicknames
string[]

Optionally filter by specific nicknames. Limit 100.

bookmarked_status
boolean

Optionally filter by bookmarked status. If omitted, addresses regardless of bookmarked status will be returned.

created_at.lt
string<date-time>

Include timestamps strictly less than lt. RFC3339 format, like 2006-01-02T15:04:05Z.

created_at.lte
string<date-time>

Include timestamps less than or equal to lte. RFC3339 format, like 2006-01-02T15:04:05Z.

created_at.eq
string<date-time>

Include timestamps exactly equal to eq. RFC3339 format, like 2006-01-02T15:04:05Z.

created_at.gte
string<date-time>

Include timestamps greater than or equal to gte. RFC3339 format, like 2006-01-02T15:04:05Z.

created_at.gt
string<date-time>

Include timestamps strictly greater than gt. RFC3339 format, like 2006-01-02T15:04:05Z.

limit
integer<int32>

Number of results to return. Defaults to 100 if no limit is provided. Maximum 1000.

order
enum<string>

Return items in ascending (ASC) or descending (DESC) order. Defaults to DESC.

Available options:
DESC,
ASC
order_by
enum<string>

The specific method by which the returned results will be ordered.

Available options:
CREATED_AT
page_cursor
string

Optional cursor for getting the next page of results.

Response

200 - application/json

A successful response.

addresses
object[]
next_page_cursor
string