Create a recipient address
Stores an external blockchain address. Once added, the recipient address must be verified to ensure that you know and trust each new address.
cirBTC recipients: Recipient addresses for cirBTC flows are registered with one of these chain and currency pairs:
chain=ETHwithcurrency=CIRBTCfor onchain cirBTC transfers.chain=BTCwithcurrency=BTCfor native Bitcoin recipients. To redeem cirBTC to native Bitcoin, create a transfer withamount.currency=CIRBTCto a recipient of this form; Circle will burn the cirBTC and release the equivalent amount of native Bitcoin (1:1) to the Bitcoin address.
For France customers:
Circle Mint France customers must verify all transfer recipients using the UI in the Circle Console, as transfers from unverified addresses will be held in pending status. Please see Help Center articles below for details:
Authorizations
Body
Adds a recipient address. The currency parameter will default to USD for all chains except for BTC where it defaults to BTC.
An alphanumeric string representing a blockchain address. Formatting varies by blockchain.
Be sure to preserve the exact formatting and capitalization of the address.
Important: For Ripple (XRP) addresses, only the classic address format is supported (for example, rPEPPER7kfTD9w2To4CQk6UCfuHM9c6GDY).
The x-address format is NOT supported currently (for example, XV5sbjUmgPpvXv4ixFWZ5ptAYZ6PD2q1qM6owqNbug8W6KV).
"0x8381470ED67C3802402dbbFa0058E8871F017A6F"
A blockchain that a given currency is available on.
ALGO, APTOS, ARB, ARC, AVAX, BASE, BTC, CELO, CODEX, CRONOS, EDGE, ETH, HBAR, HYPEREVM, INJECTIVE, INK, LINEA, MONAD, MORPH, NEAR, NOBLE, OP, PHAROS, PLUME, PAH, PLASMA, POLY, SEI, SOL, SONIC, STRK, SUI, UNI, WORLDCHAIN, XLAYER, XDC, XLM, XRP, ZKS Ownership and custody of the wallet for Travel Rule and compliance.
Validation errors can include codes such as 2025 (ownership missing), 2026 (VASP ID missing when required), 2027–2030, 2035 (VASP ID not allowed when custody is self_hosted), and 2037 (ownership cannot be updated via PATCH).