FIfireblocks
Travel Rule

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.

get/screening/travel_rule/vasp/{did}

Request

Path parameters

didstring required

The Decentralized Identifier (DID) of the VASP.

Query parameters

fieldsstring[]

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.

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.

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

Response

VASP details

didstring required

The Decentralized Identifier (DID) of the VASP.

namestring required

The name of the VASP.

verificationStatusstring required

The current verification status of the VASP.

addressLine1string required

The first line of the VASP's address.

addressLine2string nullable

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

citystring required

The city where the VASP is located.

countrystring required

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

emailDomainsstring 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.

websitestring required

The official website of the VASP.

logostring nullable

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

legalStructurestring required

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

legalNamestring required

The legal name of the VASP.

yearFoundedstring required

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

incorporationCountrystring required

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

isRegulatedstring required

Indicates whether the VASP is regulated.

otherNamesstring nullable

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

identificationTypestring

The type of identification used by the VASP.

identificationCountrystring nullable

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

businessNumberstring

The business registration number of the VASP.

regulatoryAuthoritiesstring nullable

The regulatory authorities overseeing the VASP. May be null.

jurisdictionsstring required

The jurisdictions where the VASP operates.

divisionstring nullable

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

streetstring nullable

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

numberstring

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

unitstring nullable

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

postCodestring

The postal code of the VASP's location.

statestring

The state or region where the VASP is located.

otherLegalNamestring nullable

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.

gleifUpdatedAtstring nullable

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

leiNumberstring nullable

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

legalFormstring nullable

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

entityCategorystring nullable

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

entityStatusstring nullable

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

hqStreetstring nullable

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

hqNumberstring nullable

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

hqPostcodestring nullable

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

hqRegionstring nullable

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

hqCitystring nullable

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

hqCountrystring nullable

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

certificatesstring nullable

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

descriptionstring nullable

A brief description of the VASP. May be null.

travelRule_OPENVASPstring nullable

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

travelRule_SYGNAstring nullable

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

travelRule_TRISAstring nullable

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

travelRule_TRLIGHTstring required

Travel rule compliance status for TRLight.

travelRule_EMAILstring nullable

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

travelRule_TRPstring nullable

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

travelRule_SHYFTstring nullable

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

travelRule_USTRAVELRULEWGstring nullable

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

createdAtstring required

Timestamp when the VASP record was created.

createdBystring nullable

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

updatedAtstring

Timestamp of the last update to the VASP record.

updatedBystring

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

lastSentDatestring

The last date a transaction was sent by the VASP.

lastReceivedDatestring

The last date a transaction was received by the VASP.

documentsstring nullable

Documents associated with the VASP. May be null.

hasAdminboolean required

Indicates if the VASP has an admin.

isNotifiableboolean required

Indicates if the VASP is notifiable for compliance reasons.

regulatoryStatusstring nullable

The regulatory status of the VASP, as free text.

supervisoryAuthoritystring nullable

The supervisory authority responsible for the VASP.

registrationLicenseIdstring nullable

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

statusStartDatestring nullable

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

statusExpirationDatestring nullable

The date the VASP's current regulatory status expires.

lastCheckedstring nullable

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

additionalInformationstring nullable

Additional free-text information about the VASP.

subsidiaryOfstring nullable

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

pii_didkeystring nullable

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.

compliancePhaseinteger nullable

The VASP's current compliance onboarding phase.

compliancePhaseDataTravelRuleVASPCompliancePhaseData nullable

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.

vaspnetIdstring nullable

The VASP's VASPnet identifier.

vaspnetUpdatedAtstring nullable

Timestamp of the last synchronization with VASPnet.

vaspnetImmutableFieldsstring[] nullable

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

node_didkeystring nullable

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.

ddqstring nullable

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

targetProtocolstring nullable

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

parentGatewaystring nullable

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

isActiveSenderboolean nullable

Indicates if the VASP actively sends Travel Rule transfers.

isActiveReceiverboolean nullable

Indicates if the VASP actively receives Travel Rule transfers.

Example response

{
  "did": "did:ethr:0x17fe2dd11a2daa7f6c1fdf22532a4763f963aea6",
  "name": "Fireblocks TST",
  "verificationStatus": "VERIFIED",
  "addressLine1": "657 Campfire Street",
  "addressLine2": "Suite 10",
  "city": "New York",
  "country": "US",
  "emailDomains": "[\"fireblocks.com\", \"example.com\"]",
  "website": "https://fireblocks.com",
  "logo": "https://fireblocks.com/logo.png",
  "legalStructure": "CORPORATION",
  "legalName": "Fireblocks Inc.",
  "yearFounded": "2019",
  "incorporationCountry": "US",
  "isRegulated": "YES",
  "otherNames": "Fireblocks Test VASP",
  "identificationType": "OTHER",
  "identificationCountry": "US",
  "businessNumber": "123456789",
  "regulatoryAuthorities": "SEC, FINCEN",
  "jurisdictions": "US, EU",
  "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_TRLIGHT": "active",
  "travelRule_EMAIL": "inactive",
  "travelRule_TRP": "active",
  "travelRule_SHYFT": "inactive",
  "travelRule_USTRAVELRULEWG": "pending",
  "createdAt": "2023-09-19T12:23:59.711Z",
  "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']",
  "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"
    }
  },
  "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,
  "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": []
}

Changes

No recorded changes to this operation across all 1 revision of this API.