Get VASP details
Get VASP Details.
Returns information about a VASP that has the specified DID.
The response may contain fields that are not documented in the schema below. Clients must ignore unrecognised fields rather than failing to deserialize.
Path Parameters
The Decentralized Identifier (DID) of the VASP.
Query Parameters
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.
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 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.
The Decentralized Identifier (DID) of the VASP.
"did:ethr:0x17fe2dd11a2daa7f6c1fdf22532a4763f963aea6"
The name of the VASP.
"Fireblocks TST"
The current verification status of the VASP.
"VERIFIED"
The first line of the VASP's address.
"657 Campfire Street"
The city where the VASP is located.
"New York"
The country where the VASP is registered (ISO-3166 Alpha-2 code).
"US"
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.
"[\"fireblocks.com\", \"example.com\"]"
The official website of the VASP.
"https://fireblocks.com"
The legal structure of the VASP (e.g., Corporation, LLC).
"CORPORATION"
The legal name of the VASP.
"Fireblocks Inc."
The year the VASP was founded. Returned as a string, not an integer.
"2019"
The country where the VASP is incorporated (ISO-3166 Alpha-2 code).
"US"
Indicates whether the VASP is regulated.
"YES"
The jurisdictions where the VASP operates.
"US, EU"
Travel rule compliance status for TRLight.
"active"
Timestamp when the VASP record was created.
"2023-09-19T12:23:59.711Z"
Indicates if the VASP has an admin.
true
Indicates if the VASP is notifiable for compliance reasons.
true
The second line of the VASP's address (if applicable). May be null.
"Suite 10"
URL to the logo of the VASP. May be null.
"https://fireblocks.com/logo.png"
Other names the VASP is known by. May be null.
"Fireblocks Test VASP"
The type of identification used by the VASP.
"OTHER"
The country of identification for the VASP (ISO-3166 Alpha-2 code). May be null.
"US"
The business registration number of the VASP.
"123456789"
The regulatory authorities overseeing the VASP. May be null.
"SEC, FINCEN"
The division of the VASP's registered address, where applicable.
"Downtown"
The street name where the VASP is located. May be null.
"Wall Street"
The building number of the VASP's address. May be returned as an empty string when not supplied.
"10"
The unit or suite number of the VASP's address. May be null.
"Apt 2B"
The postal code of the VASP's location.
"10005"
The state or region where the VASP is located.
"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.
"SIX Digital Exchange SA, SIX Digital Exchange Ltd"
Timestamp of the last synchronization with the GLEIF registry. Only populated for VASPs with a GLEIF-resolved LEI.
"2024-07-20T00:00:00.000Z"
The VASP's Legal Entity Identifier (LEI), a 20-character alphanumeric code. Only populated for VASPs with a GLEIF-resolved LEI.
"9845001C5PA89625E069"
The GLEIF Entity Legal Form (ELF) code of the VASP. Only populated for VASPs with a GLEIF-resolved LEI.
"MVII"
The GLEIF entity category of the VASP. Only populated for VASPs with a GLEIF-resolved LEI.
"GENERAL"
The GLEIF entity status of the VASP. Only populated for VASPs with a GLEIF-resolved LEI.
"ACTIVE"
Entity records resolved from external registries, such as GLEIF. Only populated for VASPs that have been resolved against at least one external registry.
The street of the VASP's headquarters address. Only populated for VASPs with a GLEIF-resolved LEI.
"Hardturmstrasse 201"
The building number of the VASP's headquarters address. May be returned as an empty string as well as null when not supplied.
"201"
The postal code of the VASP's headquarters address. Only populated for VASPs with a GLEIF-resolved LEI.
"8005"
The region of the VASP's headquarters address, as an ISO-3166-2 subdivision code. Only populated for VASPs with a GLEIF-resolved LEI.
"CH-ZH"
The city of the VASP's headquarters address. Only populated for VASPs with a GLEIF-resolved LEI.
"Zurich"
The country of the VASP's headquarters address (ISO-3166 Alpha-2 code). Only populated for VASPs with a GLEIF-resolved LEI.
"CH"
Certificates or licenses held by the VASP. May be null.
"ISO 27001"
A brief description of the VASP. May be null.
"A leading provider of crypto security solutions."
Travel rule compliance status for OpenVASP. Null when the VASP does not support this protocol.
"active"
Travel rule compliance status for Sygna. Null when the VASP does not support this protocol.
"inactive"
Travel rule compliance status for TRISA. Null when the VASP does not support this protocol.
"pending"
Travel rule compliance status for EMAIL. Null when the VASP does not support this protocol.
"inactive"
Travel rule compliance status for TRP. Null when the VASP does not support this protocol.
"active"
Travel rule compliance status for Shyft. Null when the VASP does not support this protocol.
"inactive"
Travel rule compliance status for US Travel Rule WG. Null when the VASP does not support this protocol.
"pending"
The DID of the party that created the VASP record. May be null.
"did:ethr:0x19b5ff8440019b635a86bbb632db854f2ea80423"
Timestamp of the last update to the VASP record.
"2024-08-29T08:23:51.416Z"
The DID of the party that last updated the VASP record.
"did:ethr:0x19b5ff8440019b635a86bbb632db854f2ea80423"
The last date a transaction was sent by the VASP.
"2024-03-18T09:26:07.988Z"
The last date a transaction was received by the VASP.
"2024-03-20T11:45:30.212Z"
Documents associated with the VASP. May be null.
"['license.pdf', 'compliance.pdf']"
The regulatory status of the VASP, as free text.
"Regulated"
The supervisory authority responsible for the VASP.
"FINMA"
The identifier of the VASP's registration or operating license.
"LIC-123456"
The date the VASP's current regulatory status took effect.
"2023-01-01T00:00:00.000Z"
The date the VASP's current regulatory status expires.
"2026-01-01T00:00:00.000Z"
Timestamp of the last verification of the VASP's regulatory status.
"2024-07-20T13:27:30.961Z"
Additional free-text information about the VASP.
"Licensed for custody and exchange services."
The DID of the parent VASP, when this VASP is a subsidiary of another.
"did:ethr:0x44957e75d6ce4a5bf37aae117da86422c848f7c2"
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.
"86fae05d276b4096a324a1450ed92a6b2c277412bb6a49bce1ed942a0c6726bf"
The VASP's current compliance onboarding phase.
3
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.
The VASP's VASPnet identifier.
"vaspnet-123456"
Timestamp of the last synchronization with VASPnet.
"2024-07-20T13:27:30.961Z"
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.
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.
"did:key:z6Mks5CZRaiooKYhq5TwtXQC1gWhwiZnmiKfFrMnYY62MhYf"
The VASP's Due Diligence Questionnaire, as a JSON-encoded string containing a data object and an updatedAt timestamp. Clients must parse this value.
"{\"data\":{\"fullLegalName\":\"Fireblocks Inc.\"},\"updatedAt\":\"2024-11-27T08:59:31.178Z\"}"
The Travel Rule protocol used to reach this VASP, when a specific one is configured.
"TRLIGHT"
The DID of the gateway VASP that routes messages on this VASP's behalf.
"did:ethr:0x79189b9b98c95785702f8ecfe16bbe396479e1a0"
Indicates if the VASP actively sends Travel Rule transfers.
true
Indicates if the VASP actively receives Travel Rule transfers.
true
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.