Skip to main content
POST
/
v1
/
addresses
/
recipient
Create a recipient address
curl --request POST \
  --url https://api-sandbox.circle.com/v1/addresses/recipient \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "idempotencyKey": "ba943ff1-ca16-49b2-ba55-1057e70ca5c7",
  "address": "0x8381470ED67C3802402dbbFa0058E8871F017A6F",
  "description": "My USDC address at a cryptocurrency exchange",
  "clientEntityId": "a3f1b2c4-d5e6-7890-abcd-ef1234567890",
  "addressTag": "123456789"
}
'
{
  "data": {
    "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
    "address": "0x8381470ED67C3802402dbbFa0058E8871F017A6F",
    "addressTag": "123456789",
    "description": "My USDC address at a cryptocurrency exchange"
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.circle.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Adds a recipient address. The currency parameter will default to USD for all chains except for BTC where it defaults to BTC.

​
idempotencyKey
string<uuid>
required

Universally unique identifier (UUID v4) idempotency key. This key is utilized to ensure exactly-once execution of mutating requests.

Example:

"ba943ff1-ca16-49b2-ba55-1057e70ca5c7"

​
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.

Example:

"0x8381470ED67C3802402dbbFa0058E8871F017A6F"

​
chain
enum<string>
required

A blockchain that a given currency is available on.

Available options:
ALGO,
APTOS,
ARB,
AVAX,
BASE,
BTC,
CELO,
CODEX,
ETH,
HBAR,
HYPEREVM,
INK,
LINEA,
NEAR,
NOBLE,
OP,
PLUME,
PAH,
POLY,
SEI,
SOL,
SONIC,
SUI,
UNI,
WORLDCHAIN,
XDC,
XLM,
XRP,
ZKS,
ZKSYNC
​
description
string
required

An identifier or sentence that describes the recipient.

Example:

"My USDC address at a cryptocurrency exchange"

​
clientEntityId
string<uuid>

Identifier of the client entity. Required for 3rd-party flows.

Example:

"a3f1b2c4-d5e6-7890-abcd-ef1234567890"

​
addressTag
string | null

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.

Example:

"123456789"

​
currency
enum<string> | null

A currency associated with a balance or address.

Available options:
USD,
EUR

Response

Successfully added a recipient address.

​
data
object