Skip to main content
Search

Update TXID

Version: 3.0.0

Method​

POST

Url​

https://platform.globaltravelrule.com/api/verify/v2/notify_tx_id

This API endpoint is usually to be called when your VASP serves as Originating VASP and Travel Rule Request Initiator. You should call this API to notify the txId to your counterparty after you send the transaction to the blockchain.

Authentication​

No authentication

Path Parameters​

No path parameters

Query Parameters​

No query parameters

Request Body (Optional)​

requestId
RequiredString
requestId is the unique id for all transaction, the same travelrule-request invoke process flow should be using same requestId, the recommend format is: "[YOUR_VASP_NAME]-[UUIDv4]"
Min Length4
Max Length64
Pattern
[\w\d_=-]+
Example
testexchange-189e9948-64c7-4a6c-bb4f-859c173321c5
txId
RequiredString
*if the travel rule is after on chain, then the txId is required. the tx id format type can check the table.
Min Length0
Max Length256
Example
d1029841dacb031098288b257b628a967eb963bbaccf954506ad0694219497a4

Responses​

Status 200​

OK

JSON Content​

[+]data
OptionalObject
verifyMessage
OptionalString
verifyStatus
RequiredInteger (int32)
VerifyStatus
Example
100000

Status HTTP Status: 200, VerifyStatus: 100000​

Success

JSON Content​

[+]data
OptionalObject
verifyMessage
OptionalString
verifyStatus
RequiredInteger (int32)
VerifyStatus
Example
100000

In a Travel Rule request, you should call this API to notify the txId to your counterparty after you send crypto asset to the blockchain.

If you decide to cancel this outbound transaction (asset withdrawal) after PII verification passed, please use /end to explicitly terminate the Travel Rule process.

Request Example 1: Update Transaction ID to GTR​

{
  "requestId": "[requestId]",
  "txId": "[txId]"
}

Response Example: Success​

HTTP Status: 200, VerifyStatus: 100000

{
  "verifyStatus": 100000,
  "verifyMessage": "Verify Success"
}