Sign in

v3

latestOpenAPI 3.0.02026-07-311784111.3 MB
Wallet
Private

Retrieves beneficiary information for a specific address. Returns the stored beneficiary details including VASP information, personal details, and wallet type classification.

📖 Related Article: Managing Withdrawals

Scope: wallet:read

Try in API console

get/private/get_address_beneficiary

Query parameters

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

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

The currency symbol

addressstring required

Address in currency format

tagstring

Tag for XRP addresses

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": {
    "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
  }
}