Skip to main content
POST
/
v3
/
api
/
netwmgmt
/
vasps
Retrieve onboarded VASPs
curl --request POST \
  --url https://api.custody.api-zodia.io/v3/api/netwmgmt/vasps \
  --header 'Content-Type: application/json' \
  --header 'X-Signature: <api-key>' \
  --header 'submitter-id: <submitter-id>' \
  --data '
{
  "ids": [
    "ff91be0d-bca9-4a3f-9193-42106a1bbed"
  ],
  "names": [
    "COINBASE"
  ],
  "travelRuleMethods": [
    "MANUAL"
  ],
  "paginationLimit": 10,
  "paginationOffset": 123,
  "sort": {
    "by": "id",
    "order": "ASC"
  }
}
'
{
  "total": 123,
  "items": [
    {
      "id": "ff91be0d-bca9-4a3f-9193-42106a1bbed",
      "name": "my-vasp",
      "travelRuleMethod": "MANUAL",
      "country": "Singapore"
    }
  ]
}

Authorizations

X-Signature
string
header
required

Headers

submitter-id
string
required

Email of API user submitting the request

Example:

"api-maker@zodia.io"

Body

application/json
ids
string<uuid>[]

Search by IDs of VASPs

names
string[]

Search by names of the VASPs

travelRuleMethods
string[]

Search by Travel Rule methods such as MANUAL, TRUST, etc.

paginationLimit
number

Number of items in response (default is 10)

Example:

10

paginationOffset
number
sort
object

Response

OK

total
integer
items
object[]

List of VASPs