Create Address Book Entry

Add a new address to a customer's address book.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Creates a new entry in a customer's address book. Address book entries allow customers to save frequently used cryptocurrency addresses for quick access when creating send orders.

Request

POST /customers/{customer_id}/address_book

Request Body

FieldTypeRequiredDescriptionExample
addressstringYesThe cryptocurrency address to save"bc1qmv4pr0hs4gd3s7chgacccr3m9ajf7xdcf7mfrm"
networkstringYesThe blockchain network for the address"bitcoin"
labelstringNoA friendly label for the address"My BTC wallet"
ownership_typestringNoRelationship between the customer and the address owner. Possible values: self, third_party"third_party"
beneficiary_full_namestringNoFull name of the beneficiary. Used when ownership_type is third_party"John Doe"

Response Fields

FieldTypeDescriptionExample
idstringUnique identifier for the address book entry"ewteqwtqewtqwetqwetqwetq"
addressstringThe saved cryptocurrency address"bc1qmv4pr0hs4gd3s7chgacccr3m9ajf7xdcf7mfrm"
networkstringThe blockchain network"bitcoin"
labelstring | nullThe friendly label"My BTC wallet"
createdstringISO 8601 creation timestamp"2021-01-25T20:38:31+00:00"
last_usedstring | nullISO 8601 timestamp of last usenull
ownership_typestring | nullOwnership relationship: self or third_party"third_party"
beneficiary_full_namestring | nullFull name of the beneficiary"John Doe"

Error Responses

StatusError CodeDescription
400invalid_parametersRequest validation failed
404not_foundCustomer not found
Path Params
string
required
Body Params
string
required
string
required
string
string

Indicates the relationship between the customer and the address owner. Possible values are "self" (customer owns the address) or "third_party" (address belongs to someone else).

string

Full name of the beneficiary when the ownership_type is "third_party".

Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json