Create an address book entry

POST/v1/blockchain-manager/address-book

Registers a new external blockchain address in the user's address book for future withdrawals.

The entry starts in validating state. An authorization email is sent to the user; the entry moves to verified only after the user confirms it. Real-time status updates arrive through the websocket event address-book-updated-v1.

The address is checked against the format of network, and the same address cannot be registered twice for the same currency and network while an earlier entry is still validating or verified.

Authorization

ApiKeyAuth

X-Api-Key<token>

For accessing these endpoints a valid API key must be sent in the X-Api-Key header.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

address*string

The blockchain address to register. Surrounding spaces are trimmed and no whitespace is allowed inside. It must be a valid address for network.

Match^\S+$

Length1 <= length

currency*string

Symbol of the cryptocurrency that will be withdrawn to the address.

Length1 <= length

exchangeName?string

Name of the exchange. Send it when walletType is exchange.

name?string

First name of the beneficiary, or the company name when personType is company. Send it when walletOwnership is other.

network*string

Network of the address. It must be one of the networks supported for currency.

Length1 <= length

ownershipVerified?boolean

The user's statement that they control the destination wallet (proof of ownership). Only taken into account when walletType is unhosted.

personType?string

Whether the beneficiary is a natural person or a company. Send it when walletOwnership is other.

Value in

"company"
"person"

surname?string

Last name of the beneficiary. Send it when personType is person.

tag?string

Destination tag or memo, for networks that use one (e.g. XRP, XLM). Rejected on networks that do not support it.

Length1 <= length

walletOwnership*string

Whether the destination wallet belongs to the same user (own) or to someone else (other).

Value in

"other"
"own"

walletType*string

Whether the destination is a hosted exchange wallet or an unhosted (self-custody) wallet.

Value in

"exchange"
"unhosted"

Response Body

`application/json`

Create an address book entry

Example1 of 2

curl --request POST \  --url 'https://gateway.bit2me.com/v1/blockchain-manager/address-book' \  --header 'Content-Type: application/json' \  --data '{  "address": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",  "currency": "BTC",  "exchangeName": "Binance",  "name": "John",  "network": "bitcoin",  "personType": "person",  "surname": "Doe",  "walletOwnership": "other",  "walletType": "exchange"}'

{  "address": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",  "addressId": "550e8400-e29b-41d4-a716-446655440000",  "createdAt": "2026-06-01T10:30:00.000Z",  "currency": "BTC",  "exchangeName": "Binance",  "name": "John",  "network": "bitcoin",  "personType": "person",  "status": "validating",  "surname": "Doe",  "updatedAt": "2026-06-01T10:30:00.000Z",  "userId": "550e8400-e29b-41d4-a716-446655440099",  "walletOwnership": "other",  "walletType": "exchange"}

Create an address book entry

Authorization

Request Body

Response Body

201application/json

400application/json

403application/json

409application/json

`application/json`

`application/json`

`application/json`

`application/json`