Create a recipient

POST {{baseUrl}}/v1/addressBook/recipients

Body Params

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

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.

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.

metadata object (REQUIRED)

nickname string Nickname related to the address.
email string Email of the user.
bns string Blockchain Name Service (e.g. ENS) domain for the address.

Request Body

{"idempotencyKey"=>"{{$guid}}", "chain"=>"ETH", "address"=>"0x8381470ED67C3802402dbbFa0058E8871F017A6F", "metadata"=>{"nickname"=>"sample nickname", "email"=>"satoshi@circle.com", "bns"=>"sample.circle"}}

HEADERS

Key	Datatype	Required	Description
`Content-Type`	string
`Accept`	string

RESPONSES

status: Created

{&quot;data&quot;:{&quot;id&quot;:&quot;a2e34bed-5490-5388-8d4c-5388c7674815&quot;,&quot;chain&quot;:&quot;ETH&quot;,&quot;address&quot;:&quot;0x8381470ed67c3802402dbbfa0058e8871f017a6f&quot;,&quot;metadata&quot;:{&quot;nickname&quot;:&quot;sample nickname&quot;,&quot;email&quot;:&quot;satoshi@circle.com&quot;,&quot;bns&quot;:&quot;sample.circle&quot;},&quot;status&quot;:&quot;pending&quot;,&quot;createDate&quot;:&quot;2024-01-17T21:47:19.805349Z&quot;,&quot;updateDate&quot;:&quot;2024-01-17T21:47:19.805349Z&quot;}}