Skip to main content
Search

Integration Steps

Steps During Integration and Development

GTR Accounts​

First, apply for a GTR account and submit your company information for review to gain access to the dashboard.

Get Test API Keys​

Log into the GTR Dashboard and navigate to My Account > Travel Rule Info > Create API Key > Test Environment to download the API Keys. The file includes:

  • Curve25519 Public Key and Private Key Pair
  • Certificates for mTLS request and Trust Store
  • Test Scripts that can initiate the travel rule instead

Note that this key-pair is generated by GTR. You will need to generate a new one for production before going live.

* If you need test API keys while your account is still under company review, contact the GTR team to obtain them.

In the test environment, you will find various testing scripts such as the following:

├── convert_p12.sh
├── curve25519_from_file
├── curve25519_from_file_x86
├── ed25519_generator
│   ├── ed25519_generator_amd64.exe
│   ├── ed25519_generator_linux_amd64
│   ├── ed25519_generator_osx_amd64
│   └── ed25519_generator_osx_arm64
├── ivms.json
├── template
│   ├── get-auth-token.sh
│   ├── login-uat.sh
│   ├── standard2-sync-onestep-off-reg.sh <- after on chain
│   ├── standard2-sync-onestep-reg-reg.sh <- before on chain
│   ├── vasp-detail.sh
│   └── vasp-list.sh
├── wizard.sh
├── setup.sh
├── api_key.csv
├── privateKey.pem
├── certificate.pem
└── client-truststore.pem

Most files like privateKey.pem are pre-generated by GTR, but they will not be provided in the production environment. Follow the instructions in Get API Key & mTLS Certificates to generate them.

These scripts help you get started and understand how the API works.

Add the Test Environment IP Whitelist​

Please submit the IP from your gateway to GTR dashboard > My Account > Settings > IP Whitelist > Test Environment.

*The Test Environment IP Whitelist application takes 0-2 days. You can also ask the GTR team to help with the review. *(!! IMPORTANT) Please note that changes to the PRODUCTION ENVIRONMENT take 2-4 days to review. Submit your request early to avoid delays.

Understand the Integration Tools - As Initiator​

The GTR Dashboard provides debug tools and a development instruction wizard in My Account > Integration Check.

Start Development - As Initiator​

Begin developing your program as an initiator to send mTLS HTTPS requests to the GTR API.

Understand the Integration Tools - As Receiver​

The GTR Dashboard provides debug tools and a development instruction wizard in My Account > Integration Check.

Start Development - As Receiver​

Begin developing your program as a receiver (server) to handle HTTPS requests from GTR.

Setup mTLS Certificate to your server​

Set up the client-truststore.pem as Trust CA Anchor files on your server. Note that this file may be updated in the future, so ensure it can be updated easily.

Setup Test Callback URL​

Set up the callback URL using a fully qualified domain name (FQDN) with HTTPS, and add the GTR server IPs to your whitelist to allow inbound requests from the following IPs:

35.74.112.84/32
43.206.88.63/32
3.114.14.124/32

UAT Integration Test​

Once your program is nearly complete, you can start testing by sending requests to vaspCode: gdummy in the UAT environment for integration testing.

Steps Before Go Live

Add IP Whitelist​

Please submit your production server IP to GTR Dashboard > My Account > Settings > IP Whitelist > Production Environment.

*(!! IMPORTANT) Please note that changes to the PRODUCTION ENVIRONMENT take 2-4 days to review. Submit your request early to avoid delays.

Setup Production Callback URL​

Set up the callback URL using a fully qualified domain name (FQDN) with HTTPS, and add the GTR server IPs to your whitelist to allow inbound requests from the following IPs:

35.74.112.84/32
43.206.88.63/32
3.114.14.124/32

Setup Public Key​

Generate an ED25519 key-pair locally, keep your private key secure, and submit the public key via GTR Dashboard > My Account > Public Key > Add Public Key > Self Custody.

*Public key changes take effect immediately. Note that every key rotation will impact production services.

Generate CSR for requesting production environment's API Keys​

Simply copy the following command could easily to generate the key for certificate for GTR.

cd Desktop && openssl req -new -newkey rsa:4096 -nodes -keyout PRIVATE.key -out CSR.csr

*For detailed instructions, refer to mTLS Certificates.

Finish Integration Check​

Before going live with your travel rule program, you must pass the Integration Check in GTR Dashboard > My Account > Integration Check to ensure everything is working properly.

Turn On Visibility​

The final step to go live is enabling visibility at GTR Dashboard > My Account > Settings > Network Visibility.