List vasps

GET /travelrule/vasps

cURL

cURL

curl --request GET \
  --url https://api.paxos.com/v2/travelrule/vasps

200

{
  "items": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "next_page_cursor": "<string>"
}

Query Parameters

ids · string[]

Optionally filter by the vasps' IDs.

limit · integer<int32>

Number of results to return. Defaults to 100 if no limit is provided.

order · enum<string>

Determines whether the items are returned in ascending (ASC), or descending (DESC) order.

Available options: DESC, ASC

order_by · enum<string>

The specific method by which the returned results will be ordered.

Available options: NAME

page_cursor · string

Optional: Cursor for getting the next page of results. When the number of items returned is fewer than the limit, there is currently no next page.

search · string

Optional substring filter matched against VASP name. Case-insensitive. Use to power type-ahead search when the end user is selecting a VASP.

Response

200 - application/json

A successful response.

items · object[]

Show child attributes

next_page_cursor · string