Get VASP List

GET /api/common/v3/vasp/list? supports 2 modes:

• By invoking GET /api/common/v3/vasp/list?showVaspEntities=false, you will get the Brand List.
• By invoking GET /api/common/v3/vasp/list?showVaspEntities=true, you will get the complete VASP List.

For further details of VASP list API, see API Reference: /api/common/v3/vasp/list

Brand List vs VASP List

The VASP Brand List differs from the VASP List by combining same-brand VASPs into a single merged item. This is useful when a VASP operates multiple local exchanges.

For example, Axchange Exchange has multiple local exchanges: Axchange Global, Axchange Japan, and Axchange USA.

By invoking GET /api/common/v3/vasp/list?showVaspEntities=false, you will get only one item named Axchange.

However, by invoking GET /api/common/v3/vasp/list?showVaspEntities=true, you will get 3 item named Axchange Global, Axchange Japan, and Axchange USA.

💡 GTR Implementation Recommendations

• List is changing. Items in the list could be updated, or disappeared.
• You can call this API every hour, if you cache this data in your system.
• When sync fails, keep the previous version.
• Add "Others" as an option to your dropdown list in the Questionnaire.

Not all local entities will be merged into same brand due to policy restrictions. VASP must first implement the Address Detection API to identify the correct VASP.

Brand List

By invoking GET /api/common/v3/vasp/list?showVaspEntities=false, you will get the following response:

{
    "verifyStatus": 100000,
    "verifyMessage": "Success",
    "data": [
        {
            "vaspCode": "pW1CZJyrlJ7lRD2jWaAs7",
            "brandName": "Axchange",
            "supportEntities": []
        },
        {
            "vaspCode": "vHEvE66cKBifLjRyAwd71",
            "brandName": "OoooSwap",
            "supportEntities": []
        }
    ]
}

• vaspCode at the brandName level, is assigned by GTR, which is a representative VASP as the primary interaction to target brand.
• Use the vaspCode from this list to initiate travel rule transactions with the corresponding VASP.
• It is recommended to synchronize this VASP brand list at least once every hour to keep your system up to date with the latest VASPs on the GTR.
• The allianceName field indicates the Travel Rule Service Providers that VASP belongs to. This can help you understand which network or protocol the VASP is part of.
• Please use Common API 2 - Address Routing Detection to detect the correct entity by beneficiary wallet address.

VASP List

VASP List shows each supported local entity under each brand, the vaspCode in the brandName level is selected by one of them.

By invoking GET /api/common/v3/vasp/list?showVaspEntities=true, you will get the following response:

{
    "verifyStatus": 100000,
    "verifyMessage": "Success",
    "data": [
        {
            "vaspCode": "pW1CZJyrlJ7lRD2jWaAs7",
            "brandName": "Axchange",
            "supportEntities": [
                {
                    "vaspCode": "pW1CZJyrlJ7lRD2jWaAs7",
                    "vaspEntityId": "axchange-global",
                    "vaspEntityName": "Axchange Global",
                    "allianceName": "Global Travel Rule",
                    "country": "GLOBAL"
                },
                {
                    "vaspCode": "UybN7AAQ6bqJzihWQwQy1",
                    "vaspEntityId": "axchange-jp",
                    "vaspEntityName": "Axchange Japan",
                    "allianceName": "Global Travel Rule",
                    "country": "JP"
                },
                {
                    "vaspCode": "lDPwXEIe6r1jZp5TdTfyI",
                    "vaspEntityId": "axchange-us",
                    "vaspEntityName": "Axchange USA",
                    "allianceName": "Smile Travel Rule",
                    "country": "US"
                }
            ]
        },
        {
            "vaspCode": "vHEvE66cKBifLjRyAwd71",
            "brandName": "OoooSwap",
            "supportEntities": [
                {
                    "vaspCode": "vHEvE66cKBifLjRyAwd71",
                    "vaspEntityId": "oooo-sg",
                    "vaspEntityName": "OoooSwap Singapore",
                    "allianceName": "Global Travel Rule",
                    "country": "SG"
                }
            ]
        }
    ]
}