End Travel Rule
Method
POST
Url
https://platform.globaltravelrule.com/api/verify/v2/end
This API endpoint is usually to be called when your VASP serves as Originating VASP and Travel Rule Request Initiator. If your VASP decides to not transfer any funds on the blockchain after successful PII verification, you should call this endpoint to notify the status of "Terminated" to your counterparty, the Beneficiary VASP via GTR. *This API should be called for audit purposes.
Authentication
No authentication
Path Parameters
No path parameters
Query Parameters
No query parameters
Request Body (Optional)
- Schema
- Example
{
"reason": "for address book verify purpose",
"requestId": "testexchange-189e9948-64c7-4a6c-bb4f-859c173321c5",
"reasonType": "ADDRESS_BOOK_VERIFY"
}
Responses
Status 200
OK
JSON Content
- Schema
- Example
{
"data": {},
"verifyStatus": 100000,
"verifyMessage": "string"
}
Status HTTP Status: 200, VerifyStatus: 100000
Success
JSON Content
- Schema
- Example
{
"data": {},
"verifyStatus": 100000,
"verifyMessage": "string"
}
This /end API is usually called after you receive success response from the previous call of /one_step.
You can use this /end API to explicitly terminate the Travel Rule process for a variety of reasons.
Specifying a concrete reason will help GTR & your counterparty to understand why a Travel Rule request successfully complete but no following blockchain transaction.
| Reason Type | Description |
|---|---|
| UNKNOWN | Unknown |
| INTERRUPTED | interrupted transaction |
| ADDRESS_BOOK_VERIFY | For address book whitelisting purposes |
| WITHDRAW_PROCESS_DNC | Withdrawal process disconnected, possibly due to user interruption |
| UNABLE_PROCESS | Unable to process, please contact VASP for more information |
| SYSTEM_ISSUE | Internal Error |
| REJECTED | Reject transfer without reason |
| CANCELLED | Cancelled by user |
| TRANSFER_REJECTED | Reject transfer without reason |
Request Example 1: END Travel Rule Status Update
{
"requestId": "[requestId]",
"reasonType": "ADDRESS_BOOK_VERIFY_PURPOSE",
"reason": "some reason here"
}
Response Example 1: Success
HTTP Status: 200, VerifyStatus: 100000
{
"verifyStatus": 100000,
"verifyMessage": "Verify Success"
}