Skip to main content
Search

Common API 1 - VASP Brand 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. This API merges them all into one item called Axchange.

Note that local entities may not be combined with the same brand due to policy restrictions. You must implement the Address Detection API to identify the correct VASP.

Where should I integrate?​

The VASP Brand 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
  • The list may change, update, or disappear

Description​

To know which VASPs are available on the GTR (Global Travel Rule) service, you should synchronize the VASP brand list (vaspCode, brandName) 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 brand list​

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

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

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

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

{
    "verifyStatus": 100000,
    "verifyMessage": "Success",
    "data": [
        {
            "vaspCode": "pW1CZJyrlJ7lRD2jWaAs7",
            "brandName": "Axchange",
            "supportEntities": []
        },
        {
            "vaspCode": "vHEvE66cKBifLjRyAwd71",
            "brandName": "Axchange",
            "supportEntities": []
        }
    ]
}
  • 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 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.

To know the child local entities of this brand​

You can view the child entities that are part of the brand by using the parameter showVaspEntities=true.

GET /api/common/v3/vasp/list?showVaspEntities=true
{
    "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": "Axchange",
            "supportEntities": [
                {
                    "vaspCode": "vHEvE66cKBifLjRyAwd71",
                    "vaspEntityId": "oooo-sg",
                    "vaspEntityName": "OoooSwap Singapore",
                    "allianceName": "Global Travel Rule",
                    "country": "SG"
                }
            ]
        }
    ]
}