Get All VASPs

GET

screening

travel_rule

vasp

TypeScript

const response: Promise<FireblocksResponse<TravelRuleGetAllVASPsResponse>> = fireblocks.travelRule.getVASPs(travelRuleApiGetVASPsRequest);

const options = {method: 'GET'};

fetch('https://api.fireblocks.io/v1/screening/travel_rule/vasp', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fireblocks.io/v1/screening/travel_rule/vasp",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fireblocks.io/v1/screening/travel_rule/vasp"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.fireblocks.io/v1/screening/travel_rule/vasp")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "did": "did:ethr:0x17fe2dd11a2daa7f6c1fdf22532a4763f963aea6",
      "name": "Fireblocks TST",
      "verificationStatus": "VERIFIED",
      "addressLine1": "657 Campfire Street",
      "city": "New York",
      "country": "US",
      "emailDomains": "[\"fireblocks.com\", \"example.com\"]",
      "website": "https://fireblocks.com",
      "legalStructure": "CORPORATION",
      "legalName": "Fireblocks Inc.",
      "yearFounded": "2019",
      "incorporationCountry": "US",
      "isRegulated": "YES",
      "jurisdictions": "US, EU",
      "travelRule_TRLIGHT": "active",
      "createdAt": "2023-09-19T12:23:59.711Z",
      "hasAdmin": true,
      "isNotifiable": true,
      "issuers": {
        "yearFounded": {
          "issuerDid": "did:ethr:0x7947578140ed0fa32cb025d9ad9a6c6e72c52686",
          "issuedDate": "2024-07-20T13:27:30.958Z",
          "issuerName": "GLEIF"
        },
        "isRegulated": {
          "issuerDid": "did:ethr:0x7947578140ed0fa32cb025d9ad9a6c6e72c52686",
          "issuedDate": "2024-07-20T13:27:30.958Z",
          "issuerName": "GLEIF"
        },
        "regulatoryAuthorities": {
          "issuerDid": "did:ethr:0x7947578140ed0fa32cb025d9ad9a6c6e72c52686",
          "issuedDate": "2024-07-20T13:27:30.958Z",
          "issuerName": "GLEIF"
        },
        "name": {
          "issuerDid": "did:ethr:0x7947578140ed0fa32cb025d9ad9a6c6e72c52686",
          "issuedDate": "2024-07-20T13:27:30.958Z",
          "issuerName": "GLEIF"
        },
        "logo": {
          "issuerDid": "did:ethr:0x7947578140ed0fa32cb025d9ad9a6c6e72c52686",
          "issuedDate": "2024-07-20T13:27:30.958Z",
          "issuerName": "GLEIF"
        },
        "website": {
          "issuerDid": "did:ethr:0x7947578140ed0fa32cb025d9ad9a6c6e72c52686",
          "issuedDate": "2024-07-20T13:27:30.958Z",
          "issuerName": "GLEIF"
        },
        "legalName": {
          "issuerDid": "did:ethr:0x7947578140ed0fa32cb025d9ad9a6c6e72c52686",
          "issuedDate": "2024-07-20T13:27:30.958Z",
          "issuerName": "GLEIF"
        },
        "legalStructure": {
          "issuerDid": "did:ethr:0x7947578140ed0fa32cb025d9ad9a6c6e72c52686",
          "issuedDate": "2024-07-20T13:27:30.958Z",
          "issuerName": "GLEIF"
        },
        "incorporationCountry": {
          "issuerDid": "did:ethr:0x7947578140ed0fa32cb025d9ad9a6c6e72c52686",
          "issuedDate": "2024-07-20T13:27:30.958Z",
          "issuerName": "GLEIF"
        },
        "businessNumber": {
          "issuerDid": "did:ethr:0x7947578140ed0fa32cb025d9ad9a6c6e72c52686",
          "issuedDate": "2024-07-20T13:27:30.958Z",
          "issuerName": "GLEIF"
        },
        "addressLine1": {
          "issuerDid": "did:ethr:0x7947578140ed0fa32cb025d9ad9a6c6e72c52686",
          "issuedDate": "2024-07-20T13:27:30.958Z",
          "issuerName": "GLEIF"
        },
        "city": {
          "issuerDid": "did:ethr:0x7947578140ed0fa32cb025d9ad9a6c6e72c52686",
          "issuedDate": "2024-07-20T13:27:30.958Z",
          "issuerName": "GLEIF"
        },
        "country": {
          "issuerDid": "did:ethr:0x7947578140ed0fa32cb025d9ad9a6c6e72c52686",
          "issuedDate": "2024-07-20T13:27:30.958Z",
          "issuerName": "GLEIF"
        },
        "description": {
          "issuerDid": "did:ethr:0x7947578140ed0fa32cb025d9ad9a6c6e72c52686",
          "issuedDate": "2024-07-20T13:27:30.958Z",
          "issuerName": "GLEIF"
        }
      },
      "addressLine2": "Suite 10",
      "logo": "https://fireblocks.com/logo.png",
      "otherNames": "Fireblocks Test VASP",
      "identificationType": "OTHER",
      "identificationCountry": "US",
      "businessNumber": "123456789",
      "regulatoryAuthorities": "SEC, FINCEN",
      "division": "Downtown",
      "street": "Wall Street",
      "number": "10",
      "unit": "Apt 2B",
      "postCode": "10005",
      "state": "NY",
      "otherLegalName": "SIX Digital Exchange SA, SIX Digital Exchange Ltd",
      "gleifUpdatedAt": "2024-07-20T00:00:00.000Z",
      "leiNumber": "9845001C5PA89625E069",
      "legalForm": "MVII",
      "entityCategory": "GENERAL",
      "entityStatus": "ACTIVE",
      "externalEntityConfig": [
        {
          "provider": "gleif",
          "externalId": "9845001C5PA89625E069",
          "updatedAt": "2024-07-20T00:00:00Z",
          "resolvedAt": "2024-07-20T13:27:30.929Z"
        }
      ],
      "hqStreet": "Hardturmstrasse 201",
      "hqNumber": "201",
      "hqPostcode": "8005",
      "hqRegion": "CH-ZH",
      "hqCity": "Zurich",
      "hqCountry": "CH",
      "certificates": "ISO 27001",
      "description": "A leading provider of crypto security solutions.",
      "travelRule_OPENVASP": "active",
      "travelRule_SYGNA": "inactive",
      "travelRule_TRISA": "pending",
      "travelRule_EMAIL": "inactive",
      "travelRule_TRP": "active",
      "travelRule_SHYFT": "inactive",
      "travelRule_USTRAVELRULEWG": "pending",
      "createdBy": "did:ethr:0x19b5ff8440019b635a86bbb632db854f2ea80423",
      "updatedAt": "2024-08-29T08:23:51.416Z",
      "updatedBy": "did:ethr:0x19b5ff8440019b635a86bbb632db854f2ea80423",
      "lastSentDate": "2024-03-18T09:26:07.988Z",
      "lastReceivedDate": "2024-03-20T11:45:30.212Z",
      "documents": "['license.pdf', 'compliance.pdf']",
      "regulatoryStatus": "Regulated",
      "supervisoryAuthority": "FINMA",
      "registrationLicenseId": "LIC-123456",
      "statusStartDate": "2023-01-01T00:00:00.000Z",
      "statusExpirationDate": "2026-01-01T00:00:00.000Z",
      "lastChecked": "2024-07-20T13:27:30.961Z",
      "additionalInformation": "Licensed for custody and exchange services.",
      "subsidiaryOf": "did:ethr:0x44957e75d6ce4a5bf37aae117da86422c848f7c2",
      "pii_didkey": "86fae05d276b4096a324a1450ed92a6b2c277412bb6a49bce1ed942a0c6726bf",
      "compliancePhase": 3,
      "compliancePhaseData": {},
      "vaspnetId": "vaspnet-123456",
      "vaspnetUpdatedAt": "2024-07-20T13:27:30.961Z",
      "vaspnetImmutableFields": [
        "legalName"
      ],
      "node_didkey": "did:key:z6Mks5CZRaiooKYhq5TwtXQC1gWhwiZnmiKfFrMnYY62MhYf",
      "ddq": "{\"data\":{\"fullLegalName\":\"Fireblocks Inc.\"},\"updatedAt\":\"2024-11-27T08:59:31.178Z\"}",
      "targetProtocol": "TRLIGHT",
      "parentGateway": "did:ethr:0x79189b9b98c95785702f8ecfe16bbe396479e1a0",
      "isActiveSender": true,
      "isActiveReceiver": true,
      "subsidiaries": []
    }
  ],
  "total": 2,
  "next": "eJ0eXAiOiJKV1QiLCJhbGcOiJIUzI1NiJ9"
}

{
  "message": "<string>",
  "code": 123
}

Query Parameters

order

enum<string>

Field to order by

Available options:

ASC,

DESC

pageSize

number

default:500

Records per page

Required range: 100 <= x <= 1000

fields

enum<string>[]

The VASP fields to return.

Optional. If omitted, each VASP is returned with a default subset of six fields: did, name, website, logo, incorporationCountry and jurisdictions. Pass all to return the complete record for each VASP.

Most field names return exactly the requested field. A few behave differently: documents and ddq return a small default set of identifying fields instead of the requested one, and travelRule_EMAIL returns an empty object. An unrecognised field name causes an error. The VASP fields to return. Pass all for the complete record.

Behaviour differs between the two endpoints when this parameter is omitted: Get VASP details returns the complete record, while Get All VASPs returns a six-field subset per VASP. Passing all returns the complete record from both.

Combining all with specific field names is not defined; pass either all alone or a list of specific names.

This list is not exhaustive. Some field names the API accepts are intentionally undocumented, and an unrecognised name causes an error.

Available options:

all,

did,

name,

verificationStatus,

addressLine1,

addressLine2,

city,

country,

emailDomains,

website,

logo,

legalStructure,

legalName,

yearFounded,

incorporationCountry,

isRegulated,

otherNames,

identificationType,

identificationCountry,

businessNumber,

regulatoryAuthorities,

jurisdictions,

division,

street,

number,

unit,

postCode,

state,

otherLegalName,

gleifUpdatedAt,

leiNumber,

legalForm,

entityCategory,

entityStatus,

externalEntityConfig,

hqStreet,

hqNumber,

hqPostcode,

hqRegion,

hqCity,

hqCountry,

certificates,

description,

travelRule_OPENVASP,

travelRule_SYGNA,

travelRule_TRISA,

travelRule_TRLIGHT,

travelRule_EMAIL,

travelRule_TRP,

travelRule_SHYFT,

travelRule_USTRAVELRULEWG,

createdAt,

createdBy,

updatedAt,

updatedBy,

lastSentDate,

lastReceivedDate,

documents,

hasAdmin,

isNotifiable,

issuers,

regulatoryStatus,

supervisoryAuthority,

registrationLicenseId,

statusStartDate,

statusExpirationDate,

lastChecked,

additionalInformation,

subsidiaryOf,

pii_didkey,

compliancePhase,

compliancePhaseData,

vaspnetId,

vaspnetUpdatedAt,

vaspnetImmutableFields,

node_didkey,

ddq,

targetProtocol,

parentGateway,

isActiveSender,

isActiveReceiver,

subsidiaries

Example:

["name", "country", "website"]

string

Search query

reviewValue

any

Filter by the VASP's review status. Possible values include: "TRUSTED", "BLOCKED", "MANUAL", or "NULL". When provided, only VASPs that match the specified reviewValue will be returned (i.e., VASPs that have already been reviewed to this status).

Available options:

TRUSTED,

BLOCKED,

MANUAL,

null

pageCursor

string

Cursor for pagination. When provided, the response will include the next page of results.

Response

Get all VASPs

data

object[]

required

An array of VASP objects, referencing the TravelRuleVASP schema.

Show child attributes

total

integer

The total number of VASPs.

Example:

2

string | null

The URL for the next page of results.

Example:

"eJ0eXAiOiJKV1QiLCJhbGcOiJIUzI1NiJ9"

⌘I

TypeScript

const response: Promise<FireblocksResponse<TravelRuleGetAllVASPsResponse>> = fireblocks.travelRule.getVASPs(travelRuleApiGetVASPsRequest);

const options = {method: 'GET'};

fetch('https://api.fireblocks.io/v1/screening/travel_rule/vasp', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fireblocks.io/v1/screening/travel_rule/vasp",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fireblocks.io/v1/screening/travel_rule/vasp"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.fireblocks.io/v1/screening/travel_rule/vasp")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "did": "did:ethr:0x17fe2dd11a2daa7f6c1fdf22532a4763f963aea6",
      "name": "Fireblocks TST",
      "verificationStatus": "VERIFIED",
      "addressLine1": "657 Campfire Street",
      "city": "New York",
      "country": "US",
      "emailDomains": "[\"fireblocks.com\", \"example.com\"]",
      "website": "https://fireblocks.com",
      "legalStructure": "CORPORATION",
      "legalName": "Fireblocks Inc.",
      "yearFounded": "2019",
      "incorporationCountry": "US",
      "isRegulated": "YES",
      "jurisdictions": "US, EU",
      "travelRule_TRLIGHT": "active",
      "createdAt": "2023-09-19T12:23:59.711Z",
      "hasAdmin": true,
      "isNotifiable": true,
      "issuers": {
        "yearFounded": {
          "issuerDid": "did:ethr:0x7947578140ed0fa32cb025d9ad9a6c6e72c52686",
          "issuedDate": "2024-07-20T13:27:30.958Z",
          "issuerName": "GLEIF"
        },
        "isRegulated": {
          "issuerDid": "did:ethr:0x7947578140ed0fa32cb025d9ad9a6c6e72c52686",
          "issuedDate": "2024-07-20T13:27:30.958Z",
          "issuerName": "GLEIF"
        },
        "regulatoryAuthorities": {
          "issuerDid": "did:ethr:0x7947578140ed0fa32cb025d9ad9a6c6e72c52686",
          "issuedDate": "2024-07-20T13:27:30.958Z",
          "issuerName": "GLEIF"
        },
        "name": {
          "issuerDid": "did:ethr:0x7947578140ed0fa32cb025d9ad9a6c6e72c52686",
          "issuedDate": "2024-07-20T13:27:30.958Z",
          "issuerName": "GLEIF"
        },
        "logo": {
          "issuerDid": "did:ethr:0x7947578140ed0fa32cb025d9ad9a6c6e72c52686",
          "issuedDate": "2024-07-20T13:27:30.958Z",
          "issuerName": "GLEIF"
        },
        "website": {
          "issuerDid": "did:ethr:0x7947578140ed0fa32cb025d9ad9a6c6e72c52686",
          "issuedDate": "2024-07-20T13:27:30.958Z",
          "issuerName": "GLEIF"
        },
        "legalName": {
          "issuerDid": "did:ethr:0x7947578140ed0fa32cb025d9ad9a6c6e72c52686",
          "issuedDate": "2024-07-20T13:27:30.958Z",
          "issuerName": "GLEIF"
        },
        "legalStructure": {
          "issuerDid": "did:ethr:0x7947578140ed0fa32cb025d9ad9a6c6e72c52686",
          "issuedDate": "2024-07-20T13:27:30.958Z",
          "issuerName": "GLEIF"
        },
        "incorporationCountry": {
          "issuerDid": "did:ethr:0x7947578140ed0fa32cb025d9ad9a6c6e72c52686",
          "issuedDate": "2024-07-20T13:27:30.958Z",
          "issuerName": "GLEIF"
        },
        "businessNumber": {
          "issuerDid": "did:ethr:0x7947578140ed0fa32cb025d9ad9a6c6e72c52686",
          "issuedDate": "2024-07-20T13:27:30.958Z",
          "issuerName": "GLEIF"
        },
        "addressLine1": {
          "issuerDid": "did:ethr:0x7947578140ed0fa32cb025d9ad9a6c6e72c52686",
          "issuedDate": "2024-07-20T13:27:30.958Z",
          "issuerName": "GLEIF"
        },
        "city": {
          "issuerDid": "did:ethr:0x7947578140ed0fa32cb025d9ad9a6c6e72c52686",
          "issuedDate": "2024-07-20T13:27:30.958Z",
          "issuerName": "GLEIF"
        },
        "country": {
          "issuerDid": "did:ethr:0x7947578140ed0fa32cb025d9ad9a6c6e72c52686",
          "issuedDate": "2024-07-20T13:27:30.958Z",
          "issuerName": "GLEIF"
        },
        "description": {
          "issuerDid": "did:ethr:0x7947578140ed0fa32cb025d9ad9a6c6e72c52686",
          "issuedDate": "2024-07-20T13:27:30.958Z",
          "issuerName": "GLEIF"
        }
      },
      "addressLine2": "Suite 10",
      "logo": "https://fireblocks.com/logo.png",
      "otherNames": "Fireblocks Test VASP",
      "identificationType": "OTHER",
      "identificationCountry": "US",
      "businessNumber": "123456789",
      "regulatoryAuthorities": "SEC, FINCEN",
      "division": "Downtown",
      "street": "Wall Street",
      "number": "10",
      "unit": "Apt 2B",
      "postCode": "10005",
      "state": "NY",
      "otherLegalName": "SIX Digital Exchange SA, SIX Digital Exchange Ltd",
      "gleifUpdatedAt": "2024-07-20T00:00:00.000Z",
      "leiNumber": "9845001C5PA89625E069",
      "legalForm": "MVII",
      "entityCategory": "GENERAL",
      "entityStatus": "ACTIVE",
      "externalEntityConfig": [
        {
          "provider": "gleif",
          "externalId": "9845001C5PA89625E069",
          "updatedAt": "2024-07-20T00:00:00Z",
          "resolvedAt": "2024-07-20T13:27:30.929Z"
        }
      ],
      "hqStreet": "Hardturmstrasse 201",
      "hqNumber": "201",
      "hqPostcode": "8005",
      "hqRegion": "CH-ZH",
      "hqCity": "Zurich",
      "hqCountry": "CH",
      "certificates": "ISO 27001",
      "description": "A leading provider of crypto security solutions.",
      "travelRule_OPENVASP": "active",
      "travelRule_SYGNA": "inactive",
      "travelRule_TRISA": "pending",
      "travelRule_EMAIL": "inactive",
      "travelRule_TRP": "active",
      "travelRule_SHYFT": "inactive",
      "travelRule_USTRAVELRULEWG": "pending",
      "createdBy": "did:ethr:0x19b5ff8440019b635a86bbb632db854f2ea80423",
      "updatedAt": "2024-08-29T08:23:51.416Z",
      "updatedBy": "did:ethr:0x19b5ff8440019b635a86bbb632db854f2ea80423",
      "lastSentDate": "2024-03-18T09:26:07.988Z",
      "lastReceivedDate": "2024-03-20T11:45:30.212Z",
      "documents": "['license.pdf', 'compliance.pdf']",
      "regulatoryStatus": "Regulated",
      "supervisoryAuthority": "FINMA",
      "registrationLicenseId": "LIC-123456",
      "statusStartDate": "2023-01-01T00:00:00.000Z",
      "statusExpirationDate": "2026-01-01T00:00:00.000Z",
      "lastChecked": "2024-07-20T13:27:30.961Z",
      "additionalInformation": "Licensed for custody and exchange services.",
      "subsidiaryOf": "did:ethr:0x44957e75d6ce4a5bf37aae117da86422c848f7c2",
      "pii_didkey": "86fae05d276b4096a324a1450ed92a6b2c277412bb6a49bce1ed942a0c6726bf",
      "compliancePhase": 3,
      "compliancePhaseData": {},
      "vaspnetId": "vaspnet-123456",
      "vaspnetUpdatedAt": "2024-07-20T13:27:30.961Z",
      "vaspnetImmutableFields": [
        "legalName"
      ],
      "node_didkey": "did:key:z6Mks5CZRaiooKYhq5TwtXQC1gWhwiZnmiKfFrMnYY62MhYf",
      "ddq": "{\"data\":{\"fullLegalName\":\"Fireblocks Inc.\"},\"updatedAt\":\"2024-11-27T08:59:31.178Z\"}",
      "targetProtocol": "TRLIGHT",
      "parentGateway": "did:ethr:0x79189b9b98c95785702f8ecfe16bbe396479e1a0",
      "isActiveSender": true,
      "isActiveReceiver": true,
      "subsidiaries": []
    }
  ],
  "total": 2,
  "next": "eJ0eXAiOiJKV1QiLCJhbGcOiJIUzI1NiJ9"
}

{
  "message": "<string>",
  "code": 123
}

Introduction

Errors & Statuses

Data Objects

API Endpoints

Query Parameters

Response