Skip to main content
Search

02-VASP List

  • Successfully retrieve VASP list from GTR server.
  • This API allows users to obtain a comprehensive list of all available VASPs for Travel Rule processing.
  • The response can show either brand-level VASP list or detailed entity-level information based on the optional parameter.

Expected Request (VASP → GTR)​

  • Method: GET
  • Base URL: https://uat-platform.globaltravelrule.com
  • Endpoint: /api/common/v3/vasp/list
  • Query Parameters:
    • showVaspEntities - Optional boolean parameter to show detailed local entities (default: false)
  • Authentication:
    • mTLS (Mutual Transport Layer Security) when sending the API
    • JWT Bearer Token or App Token authentication via Authorization header
  • Header:
    • Content-Type: application/json
    • Authorization: Bearer [JWT_TOKEN] or X-Authorization: [APP_TOKEN]
  • Body: No request body required for this GET request.
set -e

export CURL_SSL_BACKEND="openssl"

# Get Brand List (default)
curl -v --silent --location --request GET 'https://uat-platform.globaltravelrule.com/api/common/v3/vasp/list' \
    -k --cert ./certificate.pem --key ./privateKey.pem \
    --header 'Content-Type: application/json' \
    --header 'ignore-detect: true' \
    # Please use one of Authorization or X-Authorization
    --header 'Authorization: Bearer [JWT_TOKEN]' \
    --header 'X-Authorization: [APP_TOKEN]'

# Get VASP Entity List (optional)
curl -v --silent --location --request GET 'https://uat-platform.globaltravelrule.com/api/common/v3/vasp/list?showVaspEntities=true' \
    -k --cert ./certificate.pem --key ./privateKey.pem \
    --header 'Content-Type: application/json' \
    --header 'ignore-detect: true' \
    # Please use one of Authorization or X-Authorization
    --header 'Authorization: Bearer [JWT_TOKEN]' \
    --header 'X-Authorization: [APP_TOKEN]'

Hint:

  • showVaspEntities parameter is optional - only use when you want to see which local entities are online
  • Default behavior (showVaspEntities=false) returns brand-level VASP list suitable for dropdown UI
  • Set showVaspEntities=true to get detailed information about all local entities under each brand

Materials:

Expected Response (GTR → VASP)​

  • HTTP Status Code: 200

Brand List Response​

When showVaspEntities is set to false or not specified:

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

VASP Entity List Response​

When showVaspEntities is set to 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": "vHEvE66cKBifLjRyAwd71",
            "brandName": "OoooSwap",
            "supportEntities": [
                {
                    "vaspCode": "vHEvE66cKBifLjRyAwd71",
                    "vaspEntityId": "oooo-sg",
                    "vaspEntityName": "OoooSwap Singapore",
                    "allianceName": "Global Travel Rule",
                    "country": "SG"
                }
            ]
        }
    ]
}