Crypto Address Book

List crypto address book entries

Returns the authenticated merchant's crypto address book, newest first, in a paginated envelope. Optionally narrowed by status, hosting type, network, designation, address and creation date; the total in the envelope counts the filtered set. Deleted (retired) entries are included, with status DELETED, unless the statuses filter leaves them out.

get/v3/address-book/crypto

Request

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

Query parameters

statusesstring[]

Filter by the entry statuses; several values match any of them. Omit to list every status, DELETED included.

hostingType'SELF_HOSTED' | 'VASP'

Filter by who custodies the account.

Filter by the blockchain network.

designationsstring[]

Filter by designations; an entry must carry every one named, so WITHDRAWAL alone also matches entries designated for both directions, and both together only those.

addressstring

Filter by the address or a part of it, ignoring letter case.

createdAtFrominteger

Filter by the creation date - start timestamp, inclusive (Unix epoch in seconds).

createdAtTointeger

Filter by the creation date - end timestamp, inclusive (Unix epoch in seconds).

limitinteger

Maximum number of records to return.

offsetinteger

Number of records to skip.

Response

Crypto address book entries returned successfully

limitinteger

The number of returned items.

offsetinteger

The number of skipped items.

orderstring

The sort column and the order of returned items.

querystring

The searched string in items.

totalCountinteger

The total number of items owned by the merchant.

Example response

{
  "data": [
    {
      "address": "0x1111111111111111111111111111111111111111",
      "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
    }
  ],
  "limit": 20,
  "order": "createdAt, desc",
  "totalCount": 150
}

Changes

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