Skip to main content
Search

11-Cancel Travel Rule (Pre-Transaction)

  • Pre-Transaction Approval - Travel Rule cancellation.
  • After completing a Pre-Transaction Approval request with successful address verification and reaching the PII Verification stage (regardless of PII verification success or failure), this API allows you to cancel the Travel Rule request instead of proceeding with the blockchain transaction and submitting a TXID.
  • This notifies GTR and your counterparty VASP about the cancellation with a specific reason.
  • This is a terminal action for the Travel Rule request. Once cancelled, you cannot proceed with the same request ID to submit a TXID.

Expected Request (VASP → GTR)​

  • Method: POST
  • Base URL: https://uat-platform.globaltravelrule.com
  • Endpoint: /api/verify/v2/end
  • 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:
{
    "requestId": "[ORIGINAL_REQUEST_ID]",
    "reasonType": "SECURITY_COMPLIANCE_FAIL",
    "reason": "Transaction cancelled due to compliance review decision"
}
set -e

export CURL_SSL_BACKEND="openssl"
randomRequestId="test-"$(openssl rand -base64 48 | tr -dc 'a-zA-Z0-9' | head -c "12")"-"$(date '+%Y%m%d%H%M%S')

curl -v --silent --location --request POST 'https://uat-platform.globaltravelrule.com/api/verify/v2/end' \
    -k --cert ./certificate.pem --key ./privateKey.pem \
    --header 'Content-Type: application/json' \
    # Please use one of Authorization or X-Authorization
    --header 'Authorization: Bearer [JWT_TOKEN]' \
    --header 'X-Authorization: [APP_TOKEN]' \
    --data-raw "{
        \"requestId\": \"$randomRequestId\",
        \"reasonType\": \"SECURITY_COMPLIANCE_FAIL\",
        \"reason\": \"Transaction cancelled due to compliance review decision\"
    }"

Hint:

  • requestId must be the exact same request ID used in the original /api/verify/v2/one_step call
  • Prerequisites: You must have successfully completed a Pre-Transaction Approval request (/api/verify/v2/one_step) with successful address verification that reached PII Verification stage
  • Use this endpoint when you decide NOT to execute the blockchain transaction after receiving verification results
  • Available reasonType codes:
    • UNKNOWN: unknown
    • INTERRUPTED: interrupted transaction
    • ADDRESS_BOOK_VERIFY_PURPOSE: For address book whitelisting purposes
    • WITHDRAW_PROCESS_DNC: Withdrawal process disconnected
    • SECURITY_COMPLIANCE_FAIL: Reject based on security/compliance review
    • UNABLE_PROCESS: Unable to process
    • SYSTEM_ISSUE: Internal Error
    • REJECTED: Reject transfer without reason
    • CANCELLED: Cancelled by user or VASP
  • Provide a clear, descriptive reason for the cancellation

Materials:

Expected Response (GTR → VASP)​

When the Travel Rule request is successfully cancelled, the system returns:

  • HTTP Status Code: 200
  • Both GTR and the counterparty VASP will be notified of the cancellation.
{
    "status": "success",
    "code": 200,
    "message": "Travel Rule request has been successfully cancelled",
    "data": {
        "requestId": "[ORIGINAL_REQUEST_ID]",
        "reasonType": "SECURITY_COMPLIANCE_FAIL",
        "reason": "Transaction cancelled due to compliance review decision",
        "cancelledAt": "2024-01-15T10:30:00Z"
    }
}