Sign in

v1

latestOpenAPI 3.1.02026-07-2685154311.7 KB
Address Book

Get addresses registered

Get the addresses registered for a VASP.

get/v1/addresses

Query parameters

vasp_didstring required

Decentralized Identifier

Example:did:methd:identifier

VASP DID

source'ADDRESS_GRAPH' required

Blockchain address query sources available

source_type'INTERNAL' | 'EXTERNAL'

Query source types (if not provided, it will return all addresses):

  • INTERNAL - Internal address book: addresses owned by a VASP. It can be populated by uploading a CSV, confirming incoming transfers, registering addresses. It is used to confirm transfers.
  • EXTERNAL - External address book: addresses owned by counterparty VASPs. It is populated only when a counterparty VASP confirms a transfer that another VASP sent them. It is used to identify counterparty VASP via Validate / Widget / Network Discovery flows.
pageinteger

Page number

per_pageinteger

Records per page

Response

Addresses Registered

Example response

{
  "data": [
    {
      "address": "0x489c818ca8b9251b393131b08a736a67ccb19298"
    }
  ]
}