---
title: "Register a crypto address book entry"
method: POST
path: "/v3/address-book/crypto"
tags: ["Crypto Address Book"]
---

# Register a crypto address book entry

`POST /v3/address-book/crypto`

## Request

- Base URL: `https://confirmo.net/api`
- URL: `https://confirmo.net/api/v3/address-book/crypto`
- Auth: HTTP bearer

Whitelists a crypto account for the authenticated merchant — a self-hosted wallet or an account at a VASP. The entry is created with status PENDING and must pass screening before it can be used for any of the usages it is designated for. The link at which the account holder proves the account is theirs is issued by POST /v3/address-book/crypto/{id}/verification.

## Request body

- CreateCryptoAddressBookEntryRequest
  - `address` string
  - `designations` string[], required: Must not be empty. TOP_UP is not accepted on a UTXO network, nor on a VASP account for now.
  - `hostingType` 'SELF_HOSTED' | 'VASP', required
  - `label` string
  - `networkId` 'ARC-BLOCKCHAIN-MAINNET' | 'BITCOIN-BLOCKCHAIN-MAINNET' | 'BITCOIN-LIGHTNING-MAINNET' | 'BSC-BLOCKCHAIN-MAINNET' | 'ETHEREUM-ARBITRUM-ONE-MAINNET' | 'ETHEREUM-BLOCKCHAIN-MAINNET' | 'ETHEREUM-OPTIMISM-MAINNET' | 'PLASMA-BLOCKCHAIN-MAINNET' | 'ETHEREUM-POLYGON-MAINNET' | 'LITECOIN-BLOCKCHAIN-MAINNET' | 'SOLANA-BLOCKCHAIN-MAINNET' | 'TRON-BLOCKCHAIN-MAINNET', required
  - `notifyOptions` CryptoAddressBookEntryNotifyOptions
    - `email` string, email
    - `url` string, uri

## Response `201`

Crypto address book entry successfully registered

- CryptoAddressBookEntry
  - `address` string
  - `createdAt` integer
  - `designations` string[]
  - `hostingType` 'SELF_HOSTED' | 'VASP'
  - `id` string
  - `label` string
  - `networkId` string
  - `notifyOptions` CryptoAddressBookEntryNotifyOptions, required
    - `email` string, email
    - `url` string, uri
  - `status` 'PENDING' | 'ACTIVE' | 'REJECTED' | 'EXPIRED' | 'DELETED'
  - `updatedAt` integer

## Other responses

- `400`: Invalid request body, invalid crypto address, a designation the entry cannot have, an account already in the merchant's address book, a self-hosted wallet of a merchant not fully onboarded yet, of an individual merchant or on a network its ownership cannot be proven on, or the address book feature is disabled
- `403`: Not authenticated by an API key, no authenticated merchant in the request context, or an API key without payouts enabled registering a withdrawal destination
- `409`: Conflict

---

[API](https://skmtc.dev/confirmo/apis/confirmo-api.md) - [All operations](https://skmtc.dev/confirmo/apis/confirmo-api/llms.txt) - [OpenAPI document](https://skmtc.dev/confirmo/apis/confirmo-api/revisions/09bef7db3dd1?raw)