--- title: "Get All VASPs" method: GET path: "/screening/travel_rule/vasp" tags: ["Travel Rule"] --- # Get All VASPs `GET /screening/travel_rule/vasp` ## Request - Base URL: `https://api.fireblocks.io/v1` - URL: `https://api.fireblocks.io/v1/screening/travel_rule/vasp` - Auth: none declared - TypeScript: (a function with typed inputs; its response is checked against the schema) Get All VASPs. Returns a list of VASPs. VASPs can be searched and sorted. Each VASP in 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 - `order` 'ASC' | 'DESC' - `pageSize` number - `fields` string[]: 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. - `search` string - `reviewValue` unknown - `pageCursor` string ## Response `200` Get all VASPs - TravelRuleGetAllVASPsResponse - `data` TravelRuleVASP[], required: An array of VASP objects, referencing the TravelRuleVASP schema. - `did` string, required: The Decentralized Identifier (DID) of the VASP. - `name` string, required: The name of the VASP. - `verificationStatus` string, required: The current verification status of the VASP. - `addressLine1` string, required: The first line of the VASP's address. - `addressLine2` string, nullable: The second line of the VASP's address (if applicable). May be null. - `city` string, required: The city where the VASP is located. - `country` string, required: The country where the VASP is registered (ISO-3166 Alpha-2 code). - `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. - `website` string, required: The official website of the VASP. - `logo` string, nullable: URL to the logo of the VASP. May be null. - `legalStructure` string, required: The legal structure of the VASP (e.g., Corporation, LLC). - `legalName` string, required: The legal name of the VASP. - `yearFounded` string, required: The year the VASP was founded. Returned as a string, not an integer. - `incorporationCountry` string, required: The country where the VASP is incorporated (ISO-3166 Alpha-2 code). - `isRegulated` string, required: Indicates whether the VASP is regulated. - `otherNames` string, nullable: Other names the VASP is known by. May be null. - `identificationType` string: The type of identification used by the VASP. - `identificationCountry` string, nullable: The country of identification for the VASP (ISO-3166 Alpha-2 code). May be null. - `businessNumber` string: The business registration number of the VASP. - `regulatoryAuthorities` string, nullable: The regulatory authorities overseeing the VASP. May be null. - `jurisdictions` string, required: The jurisdictions where the VASP operates. - `division` string, nullable: The division of the VASP's registered address, where applicable. - `street` string, nullable: The street name where the VASP is located. May be null. - `number` string: The building number of the VASP's address. May be returned as an empty string when not supplied. - `unit` string, nullable: The unit or suite number of the VASP's address. May be null. - `postCode` string: The postal code of the VASP's location. - `state` string: The state or region where the VASP is located. - `otherLegalName` string, 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. - `gleifUpdatedAt` string, nullable: Timestamp of the last synchronization with the GLEIF registry. Only populated for VASPs with a GLEIF-resolved LEI. - `leiNumber` string, nullable: The VASP's Legal Entity Identifier (LEI), a 20-character alphanumeric code. Only populated for VASPs with a GLEIF-resolved LEI. - `legalForm` string, nullable: The GLEIF Entity Legal Form (ELF) code of the VASP. Only populated for VASPs with a GLEIF-resolved LEI. - `entityCategory` string, nullable: The GLEIF entity category of the VASP. Only populated for VASPs with a GLEIF-resolved LEI. - `entityStatus` string, nullable: The GLEIF entity status of the VASP. Only populated for VASPs with a GLEIF-resolved LEI. - `externalEntityConfig` TravelRuleVASPExternalEntityConfig[], nullable: Entity records resolved from external registries, such as GLEIF. Only populated for VASPs that have been resolved against at least one external registry. - `provider` string: The external registry the record was resolved from. Returned in lower case, for example `gleif`. - `externalId` string, nullable: The VASP's identifier within the external registry. For the `gleif` provider this is the Legal Entity Identifier (LEI). - `updatedAt` string, nullable: Timestamp of the last change to the record at the external registry. - `resolvedAt` string, nullable: Timestamp when the record was last resolved from the external registry. - `entity` TravelRuleVASPExternalEntity: The VASP's entity data as held by an external registry. These fields mirror a subset of the top-level VASP fields, but carry the registry's values rather than the VASP's own, so the two may differ. - `legalName` string, nullable: The legal name of the entity as recorded by the external registry. - `otherLegalName` string, nullable: Alternative legal names of the entity, as a comma-separated list. - `legalForm` string, nullable: The Entity Legal Form (ELF) code of the entity. - `legalStructure` string, nullable: The legal structure of the entity. The external registry may return the Entity Legal Form code in this field, so its value can duplicate `legalForm`. - `entityCategory` string, nullable: The category assigned to the entity by the external registry. - `entityStatus` string, nullable: The status of the entity at the external registry. - `businessNumber` string, nullable: The business registration number of the entity. - `yearFounded` string, nullable: The year the entity was founded. Returned as a string, not an integer. - `jurisdictions` string, nullable: The jurisdictions the entity is registered in. - `addressLine1` string, nullable: The first line of the entity's registered address. - `number` string, nullable: The building number of the entity's registered address. May be returned as an empty string as well as `null` when not supplied. - `postCode` string, nullable: The postal code of the entity's registered address. - `city` string, nullable: The city of the entity's registered address. - `state` string, nullable: The state or region of the entity's registered address, as an ISO-3166-2 subdivision code. - `country` string, nullable: The country of the entity's registered address (ISO-3166 Alpha-2 code). - `hqStreet` string, nullable: The street of the entity's headquarters address. - `hqNumber` string, nullable: The building number of the entity's headquarters address. May be returned as an empty string as well as `null` when not supplied. - `hqPostcode` string, nullable: The postal code of the entity's headquarters address. - `hqCity` string, nullable: The city of the entity's headquarters address. - `hqRegion` string, nullable: The region of the entity's headquarters address, as an ISO-3166-2 subdivision code. - `hqCountry` string, nullable: The country of the entity's headquarters address (ISO-3166 Alpha-2 code). - `registration` TravelRuleVASPExternalEntityRegistration: The registration state of the VASP as reported by an external registry. - `status` string, nullable: The registration status at the external registry, for example `ISSUED`, `LAPSED` or `RETIRED`. The value set is defined by the registry, not by Fireblocks. - `nextRenewalDate` string, nullable: The date the registration is next due for renewal at the external registry. - `corroborationLevel` string, nullable: The level to which the registry has corroborated the entity data, for example `FULLY_CORROBORATED`. The value set is defined by the registry, not by Fireblocks. - `hqStreet` string, nullable: The street of the VASP's headquarters address. Only populated for VASPs with a GLEIF-resolved LEI. - `hqNumber` string, nullable: The building number of the VASP's headquarters address. May be returned as an empty string as well as `null` when not supplied. - `hqPostcode` string, nullable: The postal code of the VASP's headquarters address. Only populated for VASPs with a GLEIF-resolved LEI. - `hqRegion` string, 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. - `hqCity` string, nullable: The city of the VASP's headquarters address. Only populated for VASPs with a GLEIF-resolved LEI. - `hqCountry` string, nullable: The country of the VASP's headquarters address (ISO-3166 Alpha-2 code). Only populated for VASPs with a GLEIF-resolved LEI. - `certificates` string, nullable: Certificates or licenses held by the VASP. May be null. - `description` string, nullable: A brief description of the VASP. May be null. - `travelRule_OPENVASP` string, nullable: Travel rule compliance status for OpenVASP. Null when the VASP does not support this protocol. - `travelRule_SYGNA` string, nullable: Travel rule compliance status for Sygna. Null when the VASP does not support this protocol. - `travelRule_TRISA` string, nullable: Travel rule compliance status for TRISA. Null when the VASP does not support this protocol. - `travelRule_TRLIGHT` string, required: Travel rule compliance status for TRLight. - `travelRule_EMAIL` string, nullable: Travel rule compliance status for EMAIL. Null when the VASP does not support this protocol. - `travelRule_TRP` string, nullable: Travel rule compliance status for TRP. Null when the VASP does not support this protocol. - `travelRule_SHYFT` string, nullable: Travel rule compliance status for Shyft. Null when the VASP does not support this protocol. - `travelRule_USTRAVELRULEWG` string, nullable: Travel rule compliance status for US Travel Rule WG. Null when the VASP does not support this protocol. - `createdAt` string, required: Timestamp when the VASP record was created. - `createdBy` string, nullable: The DID of the party that created the VASP record. May be null. - `updatedAt` string: Timestamp of the last update to the VASP record. - `updatedBy` string: The DID of the party that last updated the VASP record. - `lastSentDate` string: The last date a transaction was sent by the VASP. - `lastReceivedDate` string: The last date a transaction was received by the VASP. - `documents` string, nullable: Documents associated with the VASP. May be null. - `hasAdmin` boolean, required: Indicates if the VASP has an admin. - `isNotifiable` boolean, required: Indicates if the VASP is notifiable for compliance reasons. - `issuers` TravelRuleIssuers, required - `yearFounded` TravelRuleIssuer, required: An attestation of a single VASP attribute by an issuing party. - `issuerDid` string, required: The Decentralized Identifier (DID) of the party that issued the attestation. - `issuedDate` string: Timestamp when the attestation was issued. Present on every attestation observed to date, but not guaranteed, so treat it as optional. - `issuerName` string: The human-readable name of the issuing party. Returned only for issuers that publish a name, such as GLEIF; absent for others, including in the same response. - `isRegulated` TravelRuleIssuer, required: An attestation of a single VASP attribute by an issuing party. - `issuerDid` string, required: The Decentralized Identifier (DID) of the party that issued the attestation. - `issuedDate` string: Timestamp when the attestation was issued. Present on every attestation observed to date, but not guaranteed, so treat it as optional. - `issuerName` string: The human-readable name of the issuing party. Returned only for issuers that publish a name, such as GLEIF; absent for others, including in the same response. - `regulatoryAuthorities` TravelRuleIssuer: An attestation of a single VASP attribute by an issuing party. - `issuerDid` string, required: The Decentralized Identifier (DID) of the party that issued the attestation. - `issuedDate` string: Timestamp when the attestation was issued. Present on every attestation observed to date, but not guaranteed, so treat it as optional. - `issuerName` string: The human-readable name of the issuing party. Returned only for issuers that publish a name, such as GLEIF; absent for others, including in the same response. - `name` TravelRuleIssuer, required: An attestation of a single VASP attribute by an issuing party. - `issuerDid` string, required: The Decentralized Identifier (DID) of the party that issued the attestation. - `issuedDate` string: Timestamp when the attestation was issued. Present on every attestation observed to date, but not guaranteed, so treat it as optional. - `issuerName` string: The human-readable name of the issuing party. Returned only for issuers that publish a name, such as GLEIF; absent for others, including in the same response. - `logo` TravelRuleIssuer: An attestation of a single VASP attribute by an issuing party. - `issuerDid` string, required: The Decentralized Identifier (DID) of the party that issued the attestation. - `issuedDate` string: Timestamp when the attestation was issued. Present on every attestation observed to date, but not guaranteed, so treat it as optional. - `issuerName` string: The human-readable name of the issuing party. Returned only for issuers that publish a name, such as GLEIF; absent for others, including in the same response. - `website` TravelRuleIssuer, required: An attestation of a single VASP attribute by an issuing party. - `issuerDid` string, required: The Decentralized Identifier (DID) of the party that issued the attestation. - `issuedDate` string: Timestamp when the attestation was issued. Present on every attestation observed to date, but not guaranteed, so treat it as optional. - `issuerName` string: The human-readable name of the issuing party. Returned only for issuers that publish a name, such as GLEIF; absent for others, including in the same response. - `legalName` TravelRuleIssuer, required: An attestation of a single VASP attribute by an issuing party. - `issuerDid` string, required: The Decentralized Identifier (DID) of the party that issued the attestation. - `issuedDate` string: Timestamp when the attestation was issued. Present on every attestation observed to date, but not guaranteed, so treat it as optional. - `issuerName` string: The human-readable name of the issuing party. Returned only for issuers that publish a name, such as GLEIF; absent for others, including in the same response. - `legalStructure` TravelRuleIssuer, required: An attestation of a single VASP attribute by an issuing party. - `issuerDid` string, required: The Decentralized Identifier (DID) of the party that issued the attestation. - `issuedDate` string: Timestamp when the attestation was issued. Present on every attestation observed to date, but not guaranteed, so treat it as optional. - `issuerName` string: The human-readable name of the issuing party. Returned only for issuers that publish a name, such as GLEIF; absent for others, including in the same response. - `incorporationCountry` TravelRuleIssuer, required: An attestation of a single VASP attribute by an issuing party. - `issuerDid` string, required: The Decentralized Identifier (DID) of the party that issued the attestation. - `issuedDate` string: Timestamp when the attestation was issued. Present on every attestation observed to date, but not guaranteed, so treat it as optional. - `issuerName` string: The human-readable name of the issuing party. Returned only for issuers that publish a name, such as GLEIF; absent for others, including in the same response. - `businessNumber` TravelRuleIssuer, required: An attestation of a single VASP attribute by an issuing party. - `issuerDid` string, required: The Decentralized Identifier (DID) of the party that issued the attestation. - `issuedDate` string: Timestamp when the attestation was issued. Present on every attestation observed to date, but not guaranteed, so treat it as optional. - `issuerName` string: The human-readable name of the issuing party. Returned only for issuers that publish a name, such as GLEIF; absent for others, including in the same response. - `addressLine1` TravelRuleIssuer, required: An attestation of a single VASP attribute by an issuing party. - `issuerDid` string, required: The Decentralized Identifier (DID) of the party that issued the attestation. - `issuedDate` string: Timestamp when the attestation was issued. Present on every attestation observed to date, but not guaranteed, so treat it as optional. - `issuerName` string: The human-readable name of the issuing party. Returned only for issuers that publish a name, such as GLEIF; absent for others, including in the same response. - `city` TravelRuleIssuer, required: An attestation of a single VASP attribute by an issuing party. - `issuerDid` string, required: The Decentralized Identifier (DID) of the party that issued the attestation. - `issuedDate` string: Timestamp when the attestation was issued. Present on every attestation observed to date, but not guaranteed, so treat it as optional. - `issuerName` string: The human-readable name of the issuing party. Returned only for issuers that publish a name, such as GLEIF; absent for others, including in the same response. - `country` TravelRuleIssuer, required: An attestation of a single VASP attribute by an issuing party. - `issuerDid` string, required: The Decentralized Identifier (DID) of the party that issued the attestation. - `issuedDate` string: Timestamp when the attestation was issued. Present on every attestation observed to date, but not guaranteed, so treat it as optional. - `issuerName` string: The human-readable name of the issuing party. Returned only for issuers that publish a name, such as GLEIF; absent for others, including in the same response. - `description` TravelRuleIssuer: An attestation of a single VASP attribute by an issuing party. - `issuerDid` string, required: The Decentralized Identifier (DID) of the party that issued the attestation. - `issuedDate` string: Timestamp when the attestation was issued. Present on every attestation observed to date, but not guaranteed, so treat it as optional. - `issuerName` string: The human-readable name of the issuing party. Returned only for issuers that publish a name, such as GLEIF; absent for others, including in the same response. - `regulatoryStatus` string, nullable: The regulatory status of the VASP, as free text. - `supervisoryAuthority` string, nullable: The supervisory authority responsible for the VASP. - `registrationLicenseId` string, nullable: The identifier of the VASP's registration or operating license. - `statusStartDate` string, nullable: The date the VASP's current regulatory status took effect. - `statusExpirationDate` string, nullable: The date the VASP's current regulatory status expires. - `lastChecked` string, nullable: Timestamp of the last verification of the VASP's regulatory status. - `additionalInformation` string, nullable: Additional free-text information about the VASP. - `subsidiaryOf` string, nullable: The DID of the parent VASP, when this VASP is a subsidiary of another. - `pii_didkey` string, 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. - `compliancePhase` integer, nullable: The VASP's current compliance onboarding phase. - `compliancePhaseData` TravelRuleVASPCompliancePhaseData, 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`. - `vaspnetId` string, nullable: The VASP's VASPnet identifier. - `vaspnetUpdatedAt` string, nullable: Timestamp of the last synchronization with VASPnet. - `vaspnetImmutableFields` string[], nullable: Names of the fields that are managed by VASPnet and cannot be modified locally. Empty when no fields are locked. - `node_didkey` string, 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. - `ddq` string, 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. - `targetProtocol` string, nullable: The Travel Rule protocol used to reach this VASP, when a specific one is configured. - `parentGateway` string, nullable: The DID of the gateway VASP that routes messages on this VASP's behalf. - `isActiveSender` boolean, nullable: Indicates if the VASP actively sends Travel Rule transfers. - `isActiveReceiver` boolean, nullable: Indicates if the VASP actively receives Travel Rule transfers. - `subsidiaries` unknown[], nullable: 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. - unknown - `total` integer: The total number of VASPs. - `next` string, nullable: The URL for the next page of results. ## Other responses - `default`: Error Response --- [API](https://skmtc.dev/fireblocks/apis/fireblocks-api.md) - [All operations](https://skmtc.dev/fireblocks/apis/fireblocks-api/llms.txt) - [OpenAPI document](https://skmtc.dev/fireblocks/apis/fireblocks-api/revisions/4eba9965659a?raw)