Overview
This page lists all API integration test suites for GTR 2.0 VASP clients. Each test suite targets a specific integration capability:
| Suite | Description |
|---|---|
| Test Suite 1 | - VASP calls GTR APIs to initiate Travel Rule requests - Test scenarios: - Authentication and VASP discovery - Address routing and correction - PII sending and verification (Natural Person / Legal Person) - TX ID update and cancellation |
| Test Suite 2 | - VASP implements a callback server to receive Travel Rule requests from GTR - Test scenarios: - Health check - Address routing (Pre/Post-Transaction) - Address and TX verification - TX ID update, cancellation, and full transaction flows |
| Test Suite 3 | - VASP implements PII verification logic on the callback server to verify PII data - Test scenarios: - KYC (Natural Person) verification (Pre/Post-Transaction) - KYB (Legal Person) verification (Pre/Post-Transaction) - Correct and incorrect PII data handling |
Your VASP should select one or more test suites based on your business scenarios and compliance requirements. Consider the following questions:
- Do your VASP need to send Travel Rule requests and customer PII to other VASPs? → Complete Test Suite 1
- Do your VASP need to receive Travel Rule requests from other VASPs? → Complete Test Suite 2
- After receiving a Travel Rule request, do your VASP need to verify the accuracy of the PII data from the counterparty? → Complete Test Suite 3
Test Suite 1: Initiator-Side API Tests
This suite verifies that your VASP can correctly call GTR APIs to initiate Travel Rule requests.
| Test Case | Test Objective |
|---|---|
| 01 - Login Successful with App Token | - Test App Token authentication and API access - GET /api/common/v3/vasp/list - Auth: mTLS + App Token ( X-Authorization) |
| 02 - Get VASP List V3 | - Test retrieval of available VASPs connected to GTR - GET /api/common/v3/vasp/list - Supports brand-level or entity-level listing |
| 03 - Get VASP Detail V3 | - Test retrieval of VASP details after address routing - GET /api/common/v3/vasp/detail?vaspCode= - Returns public keys, supported features, PII requirements |
| 04 - Pre-Transaction - Address Routing | - Pre-Transaction - Test VASP code auto-correction within the same corporate group - POST /api/verify/v2/auto_address_vasp_detection |
| 05 - Pre-Transaction - Wrong Address | - Pre-Transaction - Test error handling when submitting incorrect beneficiary address - POST /api/verify/v2/one_step with verifyDirection: 2 |
| 06 - Pre-Transaction with Natural Person and Verify Fields | - Pre-Transaction / Natural Person beneficiary - Test PII verification success with correct KYC data - POST /api/verify/v2/one_step → all verifyFields status = 1 (matched) |
| 07 - Pre-Transaction with Legal Person and Verify Fields | - Pre-Transaction / Legal Person beneficiary - Test PII verification success with correct KYB data - POST /api/verify/v2/one_step → all verifyFields status = 1 (matched) |
| 08 - Pre-Transaction - MISMATCH Natural Person | - Pre-Transaction / Natural Person beneficiary - Test PII verification failure with incorrect KYC data - POST /api/verify/v2/one_step → at least one verifyFields status = 2 (mismatch) |
| 09 - Pre-Transaction - MISMATCH Legal Person | - Pre-Transaction / Legal Person beneficiary - Test PII verification failure with incorrect KYB data - POST /api/verify/v2/one_step → at least one verifyFields status = 2 (mismatch) |
| 10 - Pre-Transaction - Update TX ID | - Pre-Transaction - Test submission of blockchain TX ID after on-chain transfer - POST /api/verify/v2/notify_tx_id with original requestId |
| 11 - Pre-Transaction - Cancel | - Pre-Transaction - Test cancellation of a Travel Rule request with reason - POST /api/verify/v2/end — terminal action, cannot submit TX ID after this |
| 12 - Post-Transaction - Address Routing | - Post-Transaction - Test VASP code auto-correction within the same corporate group - POST /api/verify/v2/auto_address_vasp_detection with txId (required) |
| 13 - Post-Transaction - Failed TX ID | - Post-Transaction - Test error handling when submitting incorrect or non-existent TX ID - POST /api/verify/v2/one_step with verifyDirection: 1 |
| 14 - Post-Transaction with Natural Person and Verify Fields | - Post-Transaction / Natural Person originator - Test PII verification success with correct KYC data in Originator field - POST /api/verify/v2/one_step → all verifyFields status = 1 (matched) |
| 15 - Post-Transaction with Legal Person and Verify Fields | - Post-Transaction / Legal Person originator - Test PII verification success with correct KYB data in Originator field - POST /api/verify/v2/one_step → all verifyFields status = 1 (matched) |
| 16 - Post-Transaction - MISMATCH Natural Person | - Post-Transaction / Natural Person originator - Test PII verification failure with incorrect KYC data in Originator field - POST /api/verify/v2/one_step → at least one verifyFields status = 2 (mismatch) |
| 17 - Post-Transaction - MISMATCH Legal Person | - Post-Transaction / Legal Person originator - Test PII verification failure with incorrect KYB data in Originator field - POST /api/verify/v2/one_step → at least one verifyFields status = 2 (mismatch) |
Test Suite 2: Receiver-Side Callback Server Tests
This suite verifies that your callback server can correctly receive and process Travel Rule requests from GTR.
| Test Case | Test Objective |
|---|---|
| 01 - Callback Server Health Check | - Test callback server availability and basic response - GTR sends callbackType: 0 to your callback endpoint - Should be the first test before complex scenarios |
| 02 - Pre-Transaction - Address Routing | - Pre-Transaction - Test address routing detection on your callback server - GTR sends callbackType: 10, verifyTargetType: 1 — check beneficiaryAddress only (txId is null) |
| 03 - Post-Transaction - Address Routing | - Post-Transaction - Test address routing detection on your callback server - GTR sends callbackType: 10, verifyTargetType: 2 — check both beneficiaryAddress and txId |
| 04 - Pre-Transaction Address Verification - Correct | - Pre-Transaction - Test successful address ownership confirmation - GTR sends callbackType: 6 with a valid beneficiary address → return verifyStatus: 100000 |
| 05 - Pre-Transaction Address Verification - Wrong | - Pre-Transaction - Test address verification failure handling - GTR sends callbackType: 6 with an incorrect address → return appropriate error code |
| 06 - Post-Transaction TX Verification - Correct | - Post-Transaction - Test successful TX ID and address ownership confirmation - GTR sends callbackType: 9 with a valid TX ID → return verifyStatus: 100000 |
| 07 - Post-Transaction TX Verification - Wrong | - Post-Transaction - Test TX verification failure handling - GTR sends callbackType: 9 with an incorrect TX ID → return appropriate error code |
| 08 - Pre-Transaction - Update TX ID | - Pre-Transaction — full sequential flow - GTR sends 3 callbacks with same requestId: callbackType: 6 → 4 → 7 (address verification → PII verification → TX ID update) |
| 09 - Pre-Transaction - Cancel | - Pre-Transaction — full sequential flow ending with cancellation - GTR sends 3 callbacks with same requestId: callbackType: 6 → 4 → 17 (address verification → PII verification → cancellation) |
| 10 - Receive Only (No Verification) | - Pre-Transaction — receive PII without verification - GTR sends 2 callbacks: callbackType: 6 → 4 (address verification → PII notification) - Decrypt and persist PII payload, no PII field-level verification required |
Test Suite 3: Receiver-Side PII Verification Callback Tests
This suite verifies that your callback server can correctly validate PII data (KYC / KYB) in received Travel Rule requests.
| Test Case | Test Objective |
|---|---|
| 01 - Pre-Transaction PII Verification - Correct Natural Person | - Pre-Transaction / Natural Person (KYC) - Test PII verification success — decrypt payload and verify Natural Person fields - GTR sends 3 callbacks: callbackType: 6 → 4 → 7 — all verifyFields status = 1 (matched) |
| 02 - Pre-Transaction PII Verification - Wrong Natural Person | - Pre-Transaction / Natural Person (KYC) - Test PII verification failure — decrypt payload with intentionally incorrect data - GTR sends 3 callbacks: callbackType: 6 → 4 → 7 — at least one verifyFields status = 2 (mismatch) |
| 03 - Pre-Transaction PII Verification - Correct Legal Person | - Pre-Transaction / Legal Person (KYB) - Test PII verification success — decrypt payload and verify Legal Person fields - GTR sends 3 callbacks: callbackType: 6 → 4 → 7 — all verifyFields status = 1 (matched) |
| 04 - Pre-Transaction PII Verification - Wrong Legal Person | - Pre-Transaction / Legal Person (KYB) - Test PII verification failure — decrypt payload with intentionally incorrect data - GTR sends 3 callbacks: callbackType: 6 → 4 → 7 — at least one verifyFields status = 2 (mismatch) |
| 05 - Post-Transaction PII Verification - Correct Natural Person | - Post-Transaction / Natural Person (KYC) - Test PII verification success — decrypt payload and verify Natural Person fields - GTR sends 2 callbacks: callbackType: 9 → 4 — all verifyFields status = 1 (matched) |
| 06 - Post-Transaction PII Verification - Wrong Natural Person | - Post-Transaction / Natural Person (KYC) - Test PII verification failure — decrypt payload with intentionally incorrect data - GTR sends 2 callbacks: callbackType: 9 → 4 — at least one verifyFields status = 2 (mismatch) |
| 07 - Post-Transaction PII Verification - Correct Legal Person | - Post-Transaction / Legal Person (KYB) - Test PII verification success — decrypt payload and verify Legal Person fields - GTR sends 2 callbacks: callbackType: 9 → 4 — all verifyFields status = 1 (matched) |
| 08 - Post-Transaction PII Verification - Wrong Legal Person | - Post-Transaction / Legal Person (KYB) - Test PII verification failure — decrypt payload with intentionally incorrect data - GTR sends 2 callbacks: callbackType: 9 → 4 — at least one verifyFields status = 2 (mismatch) |