Saved recipients.
Keep a full recipient address with its exact network. Address-book actions do not move funds or verify who controls an address.
01Review the exact chain and address
POST /address-book/validate checks TRON Base58 or strict EVM address syntax. It returns the canonical address for review. ENS names, payment URIs, zero addresses and registered token contracts are refused.
02Save with a verified passkey
Workspace owners and administrators can create an immutable recipient with recent app passkey verification and an Idempotency-Key. Replay the identical request after an interrupted response. These routes use app sessions; merchant API-key access is not available.
03Find and inspect recipients
GET /address-book supports literal search, an exact chainKey, active/archived status and a before cursor. Pages contain up to 50 records. GET /address-book/{id} returns the full address and current archive state.
04Keep history when details change
POST /address-book/{id}/archive requires recent MFA and is safe to repeat. To correct a recipient, archive it and create a fresh record. Saved payment instructions are never changed by this action.
POST /v1/workspaces/{workspaceId}/address-book
Idempotency-Key: <recipient-request-id>
{ "label": "Supplier treasury", "chainKey": "ethereum:sepolia", "address": "<full-recipient-address>" }
GET /v1/workspaces/{workspaceId}/address-book?status=active&chainKey=ethereum:sepolia
GET /v1/workspaces/{workspaceId}/address-book/{id}
POST /v1/workspaces/{workspaceId}/address-book/{id}/archive
{}Open your workspace