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