Create an address book recipient

curl --request POST \
  --url https://api-sandbox.circle.com/v1/addressBook/recipients \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "clientEntityId": "a3f1b2c4-d5e6-7890-abcd-ef1234567890",
  "idempotencyKey": "ba943ff1-ca16-49b2-ba55-1057e70ca5c7",
  "address": "0x8381470ED67C3802402dbbFa0058E8871F017A6F",
  "metadata": {
    "nickname": "sample nickname",
    "email": "satoshi@circle.com",
    "bns": "sample.circle"
  },
  "addressTag": "123456789"
}
'

import requests

url = "https://api-sandbox.circle.com/v1/addressBook/recipients"

payload = {
    "clientEntityId": "a3f1b2c4-d5e6-7890-abcd-ef1234567890",
    "idempotencyKey": "ba943ff1-ca16-49b2-ba55-1057e70ca5c7",
    "address": "0x8381470ED67C3802402dbbFa0058E8871F017A6F",
    "metadata": {
        "nickname": "sample nickname",
        "email": "satoshi@circle.com",
        "bns": "sample.circle"
    },
    "addressTag": "123456789"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    clientEntityId: 'a3f1b2c4-d5e6-7890-abcd-ef1234567890',
    idempotencyKey: 'ba943ff1-ca16-49b2-ba55-1057e70ca5c7',
    address: '0x8381470ED67C3802402dbbFa0058E8871F017A6F',
    metadata: {nickname: 'sample nickname', email: 'satoshi@circle.com', bns: 'sample.circle'},
    addressTag: '123456789'
  })
};

fetch('https://api-sandbox.circle.com/v1/addressBook/recipients', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.circle.com/v1/addressBook/recipients",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'clientEntityId' => 'a3f1b2c4-d5e6-7890-abcd-ef1234567890',
    'idempotencyKey' => 'ba943ff1-ca16-49b2-ba55-1057e70ca5c7',
    'address' => '0x8381470ED67C3802402dbbFa0058E8871F017A6F',
    'metadata' => [
        'nickname' => 'sample nickname',
        'email' => 'satoshi@circle.com',
        'bns' => 'sample.circle'
    ],
    'addressTag' => '123456789'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.circle.com/v1/addressBook/recipients"

	payload := strings.NewReader("{\n  \"clientEntityId\": \"a3f1b2c4-d5e6-7890-abcd-ef1234567890\",\n  \"idempotencyKey\": \"ba943ff1-ca16-49b2-ba55-1057e70ca5c7\",\n  \"address\": \"0x8381470ED67C3802402dbbFa0058E8871F017A6F\",\n  \"metadata\": {\n    \"nickname\": \"sample nickname\",\n    \"email\": \"satoshi@circle.com\",\n    \"bns\": \"sample.circle\"\n  },\n  \"addressTag\": \"123456789\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api-sandbox.circle.com/v1/addressBook/recipients")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"clientEntityId\": \"a3f1b2c4-d5e6-7890-abcd-ef1234567890\",\n  \"idempotencyKey\": \"ba943ff1-ca16-49b2-ba55-1057e70ca5c7\",\n  \"address\": \"0x8381470ED67C3802402dbbFa0058E8871F017A6F\",\n  \"metadata\": {\n    \"nickname\": \"sample nickname\",\n    \"email\": \"satoshi@circle.com\",\n    \"bns\": \"sample.circle\"\n  },\n  \"addressTag\": \"123456789\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.circle.com/v1/addressBook/recipients")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"clientEntityId\": \"a3f1b2c4-d5e6-7890-abcd-ef1234567890\",\n  \"idempotencyKey\": \"ba943ff1-ca16-49b2-ba55-1057e70ca5c7\",\n  \"address\": \"0x8381470ED67C3802402dbbFa0058E8871F017A6F\",\n  \"metadata\": {\n    \"nickname\": \"sample nickname\",\n    \"email\": \"satoshi@circle.com\",\n    \"bns\": \"sample.circle\"\n  },\n  \"addressTag\": \"123456789\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
    "accountId": 1000662322,
    "clientEntityId": "a3f1b2c4-d5e6-7890-abcd-ef1234567890",
    "chain": "ETH",
    "address": "0x8381470ED67C3802402dbbFa0058E8871F017A6F",
    "addressTag": "123456789",
    "metadata": {
      "nickname": "sample nickname",
      "email": "satoshi@circle.com",
      "bns": "sample.circle"
    },
    "status": "pending",
    "riskEvaluation": {
      "decision": "approved",
      "reason": "3000"
    },
    "createDate": "2020-04-10T02:13:30.000Z",
    "updateDate": "2020-04-10T02:13:30.000Z"
  }
}

{
  "code": 2,
  "message": "API parameter invalid."
}

{
  "code": 4,
  "message": "Unauthorized."
}

{
  "code": 404,
  "message": "Not found."
}

{
  "code": 409,
  "message": "Conflict."
}

{
  "code": -1,
  "message": "Something went wrong. errId: 1f0b0c455e40f753f07b4f0ae6abd4b4"
}

Create an address book recipient

Creates an address book recipient for crypto payouts. Use the returned id as destination.id when creating a payout.

Digital Asset Accounts: the address book is available only for custody accounts (purpose: custody) and is for third-party payouts only. It is not supported when the distributor or the end user is under the Circle FR (CIRCLE_FR) or Circle SG (CIRCLE_SG) legal entity. Set clientEntityId to the end user who owns the custody account you will pay out from. A payout can only use a recipient created for that end user.

POST

addressBook

recipients

Create an address book recipient

curl --request POST \
  --url https://api-sandbox.circle.com/v1/addressBook/recipients \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "clientEntityId": "a3f1b2c4-d5e6-7890-abcd-ef1234567890",
  "idempotencyKey": "ba943ff1-ca16-49b2-ba55-1057e70ca5c7",
  "address": "0x8381470ED67C3802402dbbFa0058E8871F017A6F",
  "metadata": {
    "nickname": "sample nickname",
    "email": "satoshi@circle.com",
    "bns": "sample.circle"
  },
  "addressTag": "123456789"
}
'

import requests

url = "https://api-sandbox.circle.com/v1/addressBook/recipients"

payload = {
    "clientEntityId": "a3f1b2c4-d5e6-7890-abcd-ef1234567890",
    "idempotencyKey": "ba943ff1-ca16-49b2-ba55-1057e70ca5c7",
    "address": "0x8381470ED67C3802402dbbFa0058E8871F017A6F",
    "metadata": {
        "nickname": "sample nickname",
        "email": "satoshi@circle.com",
        "bns": "sample.circle"
    },
    "addressTag": "123456789"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    clientEntityId: 'a3f1b2c4-d5e6-7890-abcd-ef1234567890',
    idempotencyKey: 'ba943ff1-ca16-49b2-ba55-1057e70ca5c7',
    address: '0x8381470ED67C3802402dbbFa0058E8871F017A6F',
    metadata: {nickname: 'sample nickname', email: 'satoshi@circle.com', bns: 'sample.circle'},
    addressTag: '123456789'
  })
};

fetch('https://api-sandbox.circle.com/v1/addressBook/recipients', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.circle.com/v1/addressBook/recipients",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'clientEntityId' => 'a3f1b2c4-d5e6-7890-abcd-ef1234567890',
    'idempotencyKey' => 'ba943ff1-ca16-49b2-ba55-1057e70ca5c7',
    'address' => '0x8381470ED67C3802402dbbFa0058E8871F017A6F',
    'metadata' => [
        'nickname' => 'sample nickname',
        'email' => 'satoshi@circle.com',
        'bns' => 'sample.circle'
    ],
    'addressTag' => '123456789'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.circle.com/v1/addressBook/recipients"

	payload := strings.NewReader("{\n  \"clientEntityId\": \"a3f1b2c4-d5e6-7890-abcd-ef1234567890\",\n  \"idempotencyKey\": \"ba943ff1-ca16-49b2-ba55-1057e70ca5c7\",\n  \"address\": \"0x8381470ED67C3802402dbbFa0058E8871F017A6F\",\n  \"metadata\": {\n    \"nickname\": \"sample nickname\",\n    \"email\": \"satoshi@circle.com\",\n    \"bns\": \"sample.circle\"\n  },\n  \"addressTag\": \"123456789\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api-sandbox.circle.com/v1/addressBook/recipients")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"clientEntityId\": \"a3f1b2c4-d5e6-7890-abcd-ef1234567890\",\n  \"idempotencyKey\": \"ba943ff1-ca16-49b2-ba55-1057e70ca5c7\",\n  \"address\": \"0x8381470ED67C3802402dbbFa0058E8871F017A6F\",\n  \"metadata\": {\n    \"nickname\": \"sample nickname\",\n    \"email\": \"satoshi@circle.com\",\n    \"bns\": \"sample.circle\"\n  },\n  \"addressTag\": \"123456789\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.circle.com/v1/addressBook/recipients")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"clientEntityId\": \"a3f1b2c4-d5e6-7890-abcd-ef1234567890\",\n  \"idempotencyKey\": \"ba943ff1-ca16-49b2-ba55-1057e70ca5c7\",\n  \"address\": \"0x8381470ED67C3802402dbbFa0058E8871F017A6F\",\n  \"metadata\": {\n    \"nickname\": \"sample nickname\",\n    \"email\": \"satoshi@circle.com\",\n    \"bns\": \"sample.circle\"\n  },\n  \"addressTag\": \"123456789\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
    "accountId": 1000662322,
    "clientEntityId": "a3f1b2c4-d5e6-7890-abcd-ef1234567890",
    "chain": "ETH",
    "address": "0x8381470ED67C3802402dbbFa0058E8871F017A6F",
    "addressTag": "123456789",
    "metadata": {
      "nickname": "sample nickname",
      "email": "satoshi@circle.com",
      "bns": "sample.circle"
    },
    "status": "pending",
    "riskEvaluation": {
      "decision": "approved",
      "reason": "3000"
    },
    "createDate": "2020-04-10T02:13:30.000Z",
    "updateDate": "2020-04-10T02:13:30.000Z"
  }
}

{
  "code": 2,
  "message": "API parameter invalid."
}

{
  "code": 4,
  "message": "Unauthorized."
}

{
  "code": 404,
  "message": "Not found."
}

{
  "code": 409,
  "message": "Conflict."
}

{
  "code": -1,
  "message": "Something went wrong. errId: 1f0b0c455e40f753f07b4f0ae6abd4b4"
}

Authorizations

Authorization

string

header

required

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

Body

application/json

clientEntityId

string<uuid>

required

Identifier of the end user's client entity this recipient is for. Required for Digital Asset Accounts: a payout can only use a recipient created for the end user that owns the payout's source account.

Example:

"a3f1b2c4-d5e6-7890-abcd-ef1234567890"

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"

chain

enum<string>

required

Blockchain network code for the recipient address (address book scope).

Available options:

ALGO,

APTOS,

ARB,

AVAX,

BASE,

CELO,

ETH,

HBAR,

NEAR,

NOBLE,

OP,

PAH,

POLY,

SOL,

SUI,

UNI,

XLM,

XRP,

ZKS

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"

metadata

object

required

Recipient metadata.

Show child attributes

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"

Response

Successfully created an address book recipient.

data

object

An address book recipient. Use its id as destination.id when creating a crypto payout.

Show child attributes