Sign in

v3

latestOpenAPI 3.0.02026-07-311784111.3 MB
Wallet
Private

Lists address beneficiaries with optional filtering and pagination. Returns all saved beneficiary information for addresses, with support for filtering by currency, address, wallet type, VASP details, and date ranges.

📖 Related Article: Managing Withdrawals

Scope: wallet:read

Try in API console

get/private/list_address_beneficiaries

Query parameters

currency'BTC' | 'ETH' | 'STETH' | 'ETHW' | 'USDC' | 'USDT' | 'EURR' | 'SOL' | 'XRP' | 'USYC' | 'PAXG' | 'BNB' | 'USDE'

Currency, i.e "BTC", "ETH", "USDC"

The currency symbol

addressstring

Address in currency format

tagstring

Tag for XRP addresses

created_beforeinteger

The timestamp (milliseconds since the Unix epoch)

Example:1536569522277

Filter by creation timestamp (before)

created_afterinteger

The timestamp (milliseconds since the Unix epoch)

Example:1536569522277

Filter by creation timestamp (after)

updated_beforeinteger

The timestamp (milliseconds since the Unix epoch)

Example:1536569522277

Filter by update timestamp (before)

updated_afterinteger

The timestamp (milliseconds since the Unix epoch)

Example:1536569522277

Filter by update timestamp (after)

personalboolean

Filter by personal wallet flag

unhostedboolean

Filter by unhosted wallet flag

beneficiary_vasp_namestring

Name of beneficiary VASP

Example:Money's Gone

Filter by beneficiary VASP name

beneficiary_vasp_didstring

DID of beneficiary VASP

Example:did:example:123456789abcdefghi

Filter by beneficiary VASP DID

beneficiary_vasp_websitestring

Website of the beneficiary VASP

Website of the beneficiary VASP. Required if the address book entry is associated with a VASP that is not included in the list of known VASPs

limitinteger

Maximum number of results to return

continuationstring
Example:xY7T6cutS3t2B9YtaDkE6TS379oKnkzTvmEDUnEUP2Msa9xKWNNaT

Continuation token for pagination

Response

Success response

jsonrpc'2.0' required

The JSON-RPC version (2.0)

idinteger

The id that was sent in the request

Example response

{
  "result": {
    "data": [
      {
        "address": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
        "user_id": 57874,
        "agreed": true,
        "personal": true,
        "beneficiary_vasp_name": "Money's Gone",
        "beneficiary_vasp_did": "did:example:123456789abcdefghi",
        "beneficiary_first_name": "John",
        "beneficiary_last_name": "Doe",
        "beneficiary_company_name": "Company Name",
        "beneficiary_address": "NL, Amsterdam, Street, 1",
        "created": 1536569522277,
        "updated": 1536569522277
      }
    ],
    "continuation": "xY7T6cutS3t2B9YtaDkE6TS379oKnkzTvmEDUnEUP2Msa9xKWNNaT",
    "count": 42
  }
}