We refreshed our doc site!
Bookmarked links may have changed
Read release notes
Create a recipient
POSThttps://api.circle.com/v1/addressBook/recipients
Body parameters
metadata
object
Required
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.
chain
string
Required
A blockchain that a given currency is available on.
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.
Response
RequestChoose a language
ResponseChoose an example
1{
2 "data": {
3 "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
4 "chain": "ALGO",
5 "address": "0x8381470ED67C3802402dbbFa0058E8871F017A6F",
6 "addressTag": "123456789",
7 "metadata": {
8 "nickname": "sample nickname",
9 "email": "[email protected]",
10 "bns": "sample.circle"
11 },
12 "status": "pending",
13 "createDate": "2020-04-10T02:13:30.000Z",
14 "updateDate": "2020-04-10T02:13:30.000Z"
15 }
16}Did this page help you?
© 2023-2024 Circle Technology Services, LLC. All rights reserved.
