Skip to main content
Search

Common API 1 - VASP List

Where should I integrate?​

The VASP List should be synchronized to your system and integrated into your dropdown list in the questionnaire. Include an "Other" option as well.

Best practices:

  • Sync every hour
  • When sync fails, keep the previous version
  • Add "Others" to your dropdown list
  • We recommend implementing Case 2 below to merge same-brand VASPs
  • Filter for supported algorithms before listing

Description​

To know which VASPs are available on the GTR (Global Travel Rule) service, you should synchronize the VASP list (vaspCode, name, country) to your database. This allows your system to map the other party's VASP code when transactions occur, enabling smooth Travel Rule compliance.

How to get the VASP list​

Invoke the following API to get all VASPs currently registered on the GTR server:

GET /api/common/v3/vasp/list?supportAlgorithms[]=x,b,c&supportedPiiSpec[]=a,b,c&supportedCountries[]=a,b,c&groupByBrand=true

For further details of the VASP list API, refer to the API documentation for /api/common/v3/vasp/list.

After you request for VASP list, you may get the following response:

{
    "verifyStatus": 100000,
    "verifyMessage": "Success",
    "data": [
        {
            "vaspCode": "pW1CZJyrlJ7lRD2jWaAs7",
            "vaspEntitySlug": "axchange-global",
            "name": "Axchange Global",
            "brandName": "Axchange",
            "allianceName": "Global Travel Rule",
            "country": "BM"
        },
        {
            "vaspCode": "UybN7AAQ6bqJzihWQwQy1",
            "vaspEntitySlug": "axchange-jp",
            "name": "Axchange Japan",
            "brandName": "Axchange",
            "allianceName": "Global Travel Rule",
            "country": "JP"
        },
        {
            "vaspCode": "lDPwXEIe6r1jZp5TdTfyI",
            "vaspEntitySlug": "axchange-us",
            "name": "Axchange USA",
            "brandName": "Axchange",
            "allianceName": "Smile Travel Rule",
            "country": "US"
        },
        {
            "vaspCode": "vHEvE66cKBifLjRyAwd71",
            "vaspEntitySlug": "oooo-sg",
            "name": "OoooSwap Singapore",
            "brandName": "OoooSwap",
            "allianceName": "Global Travel Rule",
            "country": "SG"
        }
    ]
}
  • Do NOT save the public key permanently from this API response. The public key can change at any time. Always fetch the latest key when needed.
  • Use the vaspCode from this list to initiate travel rule transactions with the corresponding VASP.
  • It is recommended to synchronize this VASP list at least once every hour to keep your system up to date with the latest VASPs on the GTR server.
  • The allianceName field indicates the different service providers or travel rule alliances the VASP belongs to. This can help you understand which network or protocol the VASP is part of.

Case 1: Displaying the VASP List on your application UI​

  • Display the name to your users in the UI dropdown or selection list.
  • Use the corresponding vaspCode as the value to identify the VASP internally and initiate the Travel Rule request.

Case 2: Displaying the Brand List on your application UI​

You can merge the same brand in the dropdown list so that each exchange brand appears only once. However, you must implement Initiator API 1: Address Labeling Detection to determine the correct VASP location. This API will automatically help you select the main entity from the brand.

With group by brand​

GET /api/common/v3/vasp/list?groupByBrand=true

Without group by brand​

GET /api/common/v3/vasp/list?groupByBrand=false

Best practices:

  • Display the brandName to your users in the UI dropdown or selection list.
  • Group by brandName and use one of them as vaspCode to initiate the Travel Rule request.
  • Invoke the Initiator API 1: Address Labeling Detection to determine the correct VASP location.