Web3 Services
API Overview
Configurations
Developer-Controlled Wallets
Circle Contracts
Modular Wallets
User-Controlled Wallets
Compliance Engine
Create a recipient address
posthttps://api-sandbox.circle.com/v1/businessAccount/wallets/addresses/recipient
- Reference
- Playground
Stores an external blockchain address. Once added, the recipient address must be verified to ensure that you know and trust each new 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:
Body parameters
description
string
Required
An identifier or sentence that describes the recipient.
chain
string
Required
A blockchain that a given currency is available on.
Allowed valuesALGOAPTOSARBAVAXBASEBTCCELOETHHBARLINEANEARNOBLEOPPAHPOLYSOLSUIUNIXLMXRPZKS
address
string
Required
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).
idempotencyKey
string
Required
Universally unique identifier (UUID v4) idempotency key. This key is utilized to ensure exactly-once execution of mutating requests.
addressTag
string
The secondary identifier for a blockchain address. An example of this is the memo field on the Stellar network, which can be text, id, or hash format.
currency
string
A currency associated with a balance or address.
Allowed valuesUSDEURBTCETH
Response
RequestChoose a language
ResponseChoose an example
1{
2 "data": {
3 "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
4 "address": "0x8381470ED67C3802402dbbFa0058E8871F017A6F",
5 "addressTag": "123456789",
6 "chain": "ALGO",
7 "currency": "USD",
8 "description": "My USDC address at a cryptocurrency exchange",
9 "status": "active"
10 }
11}Did this page help you?
© 2023-2025 Circle Technology Services, LLC. All rights reserved.
