Skip to main content
GET
TypeScript

Path Parameters

did
string
required

The Decentralized Identifier (DID) of the VASP.

Query Parameters

fields
enum<string>[]

The VASP fields to return.

Optional. If omitted, or supplied with an empty value, the complete VASP record is returned, which is the same as passing all.

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:

Response

VASP details

A VASP record from the Travel Rule trust framework directory.

The set of keys returned depends on the fields query parameter. When fields is omitted, or supplied with an empty value, this endpoint returns the complete record.

Additional fields may be present in the response beyond those documented here. Clients must ignore unrecognised fields rather than failing to deserialize.

did
string
required

The Decentralized Identifier (DID) of the VASP.

Example:

"did:ethr:0x17fe2dd11a2daa7f6c1fdf22532a4763f963aea6"

name
string
required

The name of the VASP.

Example:

"Fireblocks TST"

verificationStatus
string
required

The current verification status of the VASP.

Example:

"VERIFIED"

addressLine1
string
required

The first line of the VASP's address.

Example:

"657 Campfire Street"

city
string
required

The city where the VASP is located.

Example:

"New York"

country
string
required

The country where the VASP is registered (ISO-3166 Alpha-2 code).

Example:

"US"

emailDomains
string
required

The email domains associated with the VASP. The field's type is string; its content is a JSON-encoded array of domains. Clients must parse this value to obtain the array.

Example:

"[\"fireblocks.com\", \"example.com\"]"

website
string
required

The official website of the VASP.

Example:

"https://fireblocks.com"

The legal structure of the VASP (e.g., Corporation, LLC).

Example:

"CORPORATION"

The legal name of the VASP.

Example:

"Fireblocks Inc."

yearFounded
string
required

The year the VASP was founded. Returned as a string, not an integer.

Example:

"2019"

incorporationCountry
string
required

The country where the VASP is incorporated (ISO-3166 Alpha-2 code).

Example:

"US"

isRegulated
string
required

Indicates whether the VASP is regulated.

Example:

"YES"

jurisdictions
string
required

The jurisdictions where the VASP operates.

Example:

"US, EU"

travelRule_TRLIGHT
string
required

Travel rule compliance status for TRLight.

Example:

"active"

createdAt
string
required

Timestamp when the VASP record was created.

Example:

"2023-09-19T12:23:59.711Z"

hasAdmin
boolean
required

Indicates if the VASP has an admin.

Example:

true

isNotifiable
boolean
required

Indicates if the VASP is notifiable for compliance reasons.

Example:

true

issuers
object
required
addressLine2
string

The second line of the VASP's address (if applicable). May be null.

Example:

"Suite 10"

URL to the logo of the VASP. May be null.

Example:

"https://fireblocks.com/logo.png"

otherNames
string

Other names the VASP is known by. May be null.

Example:

"Fireblocks Test VASP"

identificationType
string

The type of identification used by the VASP.

Example:

"OTHER"

identificationCountry
string

The country of identification for the VASP (ISO-3166 Alpha-2 code). May be null.

Example:

"US"

businessNumber
string

The business registration number of the VASP.

Example:

"123456789"

regulatoryAuthorities
string

The regulatory authorities overseeing the VASP. May be null.

Example:

"SEC, FINCEN"

division
string | null

The division of the VASP's registered address, where applicable.

Example:

"Downtown"

street
string

The street name where the VASP is located. May be null.

Example:

"Wall Street"

number
string

The building number of the VASP's address. May be returned as an empty string when not supplied.

Example:

"10"

unit
string

The unit or suite number of the VASP's address. May be null.

Example:

"Apt 2B"

postCode
string

The postal code of the VASP's location.

Example:

"10005"

state
string

The state or region where the VASP is located.

Example:

"NY"

Alternative legal names of the VASP, as a comma-separated list. Resolved from an external registry, so it is only populated for VASPs with a resolved entity record.

Example:

"SIX Digital Exchange SA, SIX Digital Exchange Ltd"

gleifUpdatedAt
string | null

Timestamp of the last synchronization with the GLEIF registry. Only populated for VASPs with a GLEIF-resolved LEI.

Example:

"2024-07-20T00:00:00.000Z"

leiNumber
string | null

The VASP's Legal Entity Identifier (LEI), a 20-character alphanumeric code. Only populated for VASPs with a GLEIF-resolved LEI.

Example:

"9845001C5PA89625E069"

The GLEIF Entity Legal Form (ELF) code of the VASP. Only populated for VASPs with a GLEIF-resolved LEI.

Example:

"MVII"

entityCategory
string | null

The GLEIF entity category of the VASP. Only populated for VASPs with a GLEIF-resolved LEI.

Example:

"GENERAL"

entityStatus
string | null

The GLEIF entity status of the VASP. Only populated for VASPs with a GLEIF-resolved LEI.

Example:

"ACTIVE"

externalEntityConfig
object[] | null

Entity records resolved from external registries, such as GLEIF. Only populated for VASPs that have been resolved against at least one external registry.

Example:
hqStreet
string | null

The street of the VASP's headquarters address. Only populated for VASPs with a GLEIF-resolved LEI.

Example:

"Hardturmstrasse 201"

hqNumber
string | null

The building number of the VASP's headquarters address. May be returned as an empty string as well as null when not supplied.

Example:

"201"

hqPostcode
string | null

The postal code of the VASP's headquarters address. Only populated for VASPs with a GLEIF-resolved LEI.

Example:

"8005"

hqRegion
string | null

The region of the VASP's headquarters address, as an ISO-3166-2 subdivision code. Only populated for VASPs with a GLEIF-resolved LEI.

Example:

"CH-ZH"

hqCity
string | null

The city of the VASP's headquarters address. Only populated for VASPs with a GLEIF-resolved LEI.

Example:

"Zurich"

hqCountry
string | null

The country of the VASP's headquarters address (ISO-3166 Alpha-2 code). Only populated for VASPs with a GLEIF-resolved LEI.

Example:

"CH"

certificates
string

Certificates or licenses held by the VASP. May be null.

Example:

"ISO 27001"

description
string

A brief description of the VASP. May be null.

Example:

"A leading provider of crypto security solutions."

travelRule_OPENVASP
string

Travel rule compliance status for OpenVASP. Null when the VASP does not support this protocol.

Example:

"active"

travelRule_SYGNA
string

Travel rule compliance status for Sygna. Null when the VASP does not support this protocol.

Example:

"inactive"

travelRule_TRISA
string

Travel rule compliance status for TRISA. Null when the VASP does not support this protocol.

Example:

"pending"

travelRule_EMAIL
string

Travel rule compliance status for EMAIL. Null when the VASP does not support this protocol.

Example:

"inactive"

travelRule_TRP
string

Travel rule compliance status for TRP. Null when the VASP does not support this protocol.

Example:

"active"

travelRule_SHYFT
string

Travel rule compliance status for Shyft. Null when the VASP does not support this protocol.

Example:

"inactive"

travelRule_USTRAVELRULEWG
string

Travel rule compliance status for US Travel Rule WG. Null when the VASP does not support this protocol.

Example:

"pending"

createdBy
string

The DID of the party that created the VASP record. May be null.

Example:

"did:ethr:0x19b5ff8440019b635a86bbb632db854f2ea80423"

updatedAt
string

Timestamp of the last update to the VASP record.

Example:

"2024-08-29T08:23:51.416Z"

updatedBy
string

The DID of the party that last updated the VASP record.

Example:

"did:ethr:0x19b5ff8440019b635a86bbb632db854f2ea80423"

lastSentDate
string

The last date a transaction was sent by the VASP.

Example:

"2024-03-18T09:26:07.988Z"

lastReceivedDate
string

The last date a transaction was received by the VASP.

Example:

"2024-03-20T11:45:30.212Z"

documents
string

Documents associated with the VASP. May be null.

Example:

"['license.pdf', 'compliance.pdf']"

regulatoryStatus
string | null

The regulatory status of the VASP, as free text.

Example:

"Regulated"

supervisoryAuthority
string | null

The supervisory authority responsible for the VASP.

Example:

"FINMA"

registrationLicenseId
string | null

The identifier of the VASP's registration or operating license.

Example:

"LIC-123456"

statusStartDate
string | null

The date the VASP's current regulatory status took effect.

Example:

"2023-01-01T00:00:00.000Z"

statusExpirationDate
string | null

The date the VASP's current regulatory status expires.

Example:

"2026-01-01T00:00:00.000Z"

lastChecked
string | null

Timestamp of the last verification of the VASP's regulatory status.

Example:

"2024-07-20T13:27:30.961Z"

additionalInformation
string | null

Additional free-text information about the VASP.

Example:

"Licensed for custody and exchange services."

subsidiaryOf
string | null

The DID of the parent VASP, when this VASP is a subsidiary of another.

Example:

"did:ethr:0x44957e75d6ce4a5bf37aae117da86422c848f7c2"

pii_didkey
string | null

The VASP's public PII encryption key, published in the trust framework directory. Use it to encrypt IVMS101 personally identifiable information addressed to this VASP.

Example:

"86fae05d276b4096a324a1450ed92a6b2c277412bb6a49bce1ed942a0c6726bf"

compliancePhase
integer | null

The VASP's current compliance onboarding phase.

Example:

3

compliancePhaseData
object | null

The VASP's progress through the Travel Rule compliance onboarding milestones, as a map keyed by milestone code.

Each value indicates whether that milestone has been completed. The set of milestone codes is defined by the Travel Rule provider and may change over time, so clients must not assume any particular key is present. Examples of milestone codes include TX_SENT, TX_NOTIFY_API, TF_VASP_VERIFIED, RULES_CUSTOM_INCOMING and INTEGRATIONS_WIDGET.

vaspnetId
string | null

The VASP's VASPnet identifier.

Example:

"vaspnet-123456"

vaspnetUpdatedAt
string | null

Timestamp of the last synchronization with VASPnet.

Example:

"2024-07-20T13:27:30.961Z"

vaspnetImmutableFields
string[] | null

Names of the fields that are managed by VASPnet and cannot be modified locally. Empty when no fields are locked.

The name of a VASP field managed by VASPnet.

Example:
node_didkey
string | null

The public key of the Travel Rule node serving this VASP record. The format has not been confirmed against a live response; every observed value has been null.

Example:

"did:key:z6Mks5CZRaiooKYhq5TwtXQC1gWhwiZnmiKfFrMnYY62MhYf"

ddq
string | null

The VASP's Due Diligence Questionnaire, as a JSON-encoded string containing a data object and an updatedAt timestamp. Clients must parse this value.

Example:

"{\"data\":{\"fullLegalName\":\"Fireblocks Inc.\"},\"updatedAt\":\"2024-11-27T08:59:31.178Z\"}"

targetProtocol
string | null

The Travel Rule protocol used to reach this VASP, when a specific one is configured.

Example:

"TRLIGHT"

parentGateway
string | null

The DID of the gateway VASP that routes messages on this VASP's behalf.

Example:

"did:ethr:0x79189b9b98c95785702f8ecfe16bbe396479e1a0"

isActiveSender
boolean | null

Indicates if the VASP actively sends Travel Rule transfers.

Example:

true

isActiveReceiver
boolean | null

Indicates if the VASP actively receives Travel Rule transfers.

Example:

true

subsidiaries
any[] | null

The VASP's subsidiary entities. The element schema is not yet documented, as no response containing a populated value has been observed; do not assume a particular element type.

Example: