Before Integration
Before any API integration with GTR, your VASP should have already registered a GTR Account with a valid subscription (Trial or Professional Version).
Once ready, you can follow this guide to start integrating with GTR's API endpoints.
1. Web Server Preparation
You must prepare a Web Server to handle both API requests initiated by you and Webhook notifications received from GTR.
In GTR, your VASP may take two roles.
| Role | Description |
|---|---|
| Travel Rule Request Initiator | As an Initiator, your server will send API requests to GTR. |
| Travel Rule Request Receiver | As a Receiver, your server will receive Webhook requests from GTR. |
2. Whitelist GTR IP Addresses
If your server has deployed an IP Whitelist security control, you are required to add GTR's server IP addresses to your IP Whitelist to allow incoming traffic from GTR.
GTR's IP Addresses:
35.74.112.8443.206.88.633.114.14.124
💡 GTR's Production and Test environments share the same list of IP addresses.
3. Settings on GTR Dashboard
Complete the following Test Environment configurations on GTR Dashboard before starting to integrate with GTR's API endpoints.
- ✅ Configure your server's IP to GTR's IP Whitelist: Set Test Environment IP
- ✅ Let GTR know the Callback URL for your server: Set Test Environment Callback URL
- ✅ Generate API Key to invoke GTR's API endpoints: Generate Test Environment API Key
- ✅ Configure Public Key of your VASP for PII encryption: Generate or Upload Test Environment Public Key
💡 These setups are only for the Testing Environment.
You should repeat these steps with appropriate configurations before going live in production.
See Post-Integration.
4. Integration Resources
The following downloadable resources on GTR GitHub should help when you are doing integration with GTR.
Cryptography
| Resource | Purpose/Description | Download Links |
|---|---|---|
| Curve25519 Tools (Encryption) | Tools for key encryption. Supports multiple architectures. | darwin_x64, darwin_arm, win_x86, win_x64, win_arm, linux_x64, linux_x86 |
| Curve25519 Tools (Decryption) | Tools for key decryption. Supports multiple architectures. | darwin_x64, darwin_arm, win_x86, win_x64, win_arm, linux_x64, linux_x86 |
| Curve25519 Tools (Generator) | Tools for key generation. Supports multiple architectures. | darwin_x64, darwin_arm, win_x86, win_x64, win_arm, linux_x64, linux_x86 |
Certificate
| Resource | Purpose/Description | Download Links |
|---|---|---|
| CSR Generator | Certificate Signing Request (CSR) generation script. You will attach CSR file on Create API Key for PROD API Key configuration. | csr_generator.sh |
Token & Auth
| Resource | Purpose/Description | Download Links |
|---|---|---|
| XAPI Token Generator | Script for generating the XAPI authentication token. This is an alternative authorization method of login. | apitokengen.sh |
| Token Login Scripts | Example scripts for logging in and acquiring a Token. | logintoken.sh |
mTLS
| Resource | Purpose/Description | Download Links |
|---|---|---|
| PEM/Key to P12 Converter | Script to convert .pem and .key files into .p12 format. | pem2p12converter.sh |
| mTLS Request Example (.p12) | mTLS request example using a .p12 certificate. | mtlspkcs12.sh |
| mTLS Request Example (.pem + .key) | mTLS request example using separate .pem and .key files. | mtlspemkey.sh |
Utility Scripts
| Resource | Purpose/Description | Download Links |
|---|---|---|
| SHA512 Scripts | Scripts for SHA512 hashing operations. | sha512.sh |