Crypto Address Book

Register a crypto address book entry

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.

post/v3/address-book/crypto

Request

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

Request body

addressstring

designationsstring[] 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

labelstring

Example request

{
  "designations": [
    "WITHDRAWAL"
  ],
  "hostingType": "SELF_HOSTED",
  "label": "Treasury wallet",
  "networkId": "ETHEREUM-BLOCKCHAIN-MAINNET",
  "notifyOptions": {
    "email": "ops@merchant.example",
    "url": "https://merchant.example/hooks/address-book"
  }
}

Response

Crypto address book entry successfully registered

addressstring

createdAtinteger

designationsstring[]

hostingType'SELF_HOSTED' | 'VASP'

idstring

labelstring

networkIdstring

status'PENDING' | 'ACTIVE' | 'REJECTED' | 'EXPIRED' | 'DELETED'

updatedAtinteger

Example response

{
  "createdAt": 1712311200,
  "designations": [
    "TOP_UP"
  ],
  "hostingType": "SELF_HOSTED",
  "id": "cabT4hN8vZ0aWpL",
  "label": "Treasury wallet",
  "networkId": "ETHEREUM-BLOCKCHAIN-MAINNET",
  "notifyOptions": {
    "email": "ops@merchant.example",
    "url": "https://merchant.example/hooks/address-book"
  },
  "status": "PENDING",
  "updatedAt": 1712311200
}

Changes

No recorded changes to this operation across all 1 revision of this API.