Crypto Address Book

Update a crypto address book entry

Changes the attributes of an entry that no screening rests on: its label, its notification channels and its designations. A field left out stays as it is; a field sent as null is cleared. The screened identity (network, address, hosting type, VASP account) never changes: register a new entry instead. A VASP entry cannot gain the WITHDRAWAL designation yet, and an entry in a terminal status (REJECTED or DELETED) cannot be changed.

patch/v3/address-book/crypto/{id}

Request

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

Path parameters

idstring required

Crypto address book entry ID

Request body

designationsstring[]

Replaces the whole set and must not be null or empty. TOP_UP is not accepted on a UTXO network, and a VASP entry cannot gain WITHDRAWAL or TOP_UP. Omit to leave unchanged.

labelstring nullable

Null clears the label. Omit to leave unchanged.

Example request

{
  "designations": [
    "TOP_UP"
  ],
  "label": "Treasury wallet",
  "notifyOptions": {
    "email": "ops@merchant.example",
    "url": "https://merchant.example/hooks/address-book"
  }
}

Response

Crypto address book entry successfully updated

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.