We refreshed our doc site!
Bookmarked links may have changed
Read release notes
Create a recipient address
POSThttps://api.circle.com/v1/businessAccount/wallets/addresses/recipient
Stores an external blockchain address. Once added, the recipient address must be verified to ensure that you know and trust each new address. Note: Circle Mint Singapore customers must verify all transfer recipients using the UI in the Circle Console, as transfers from unverified addresses will be held in pending status.
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.
address
string
Required
An alphanumeric string representing a blockchain address. Will be in different formats for different chains. It is important to preserve the exact formatting and capitalization of the address.
idempotencyKey
uuid
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.
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-2024 Circle Technology Services, LLC. All rights reserved.
