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 (Required)
- Schema
- Example
address
RequiredString
address is beneficiary address (in all scenario)
Min Length0
Max Length128
Example
E9aX7TbJqvLwzC1f8rYpBnGks3M0QHjVxODUZ_WRmT2yXoLp
network
RequiredString
Network name in short symbol, the reference can check the table.
Min Length0
Max Length128
Example
XRP
originatorAddress
OptionalString
address is originator address (in all scenario), pre-transaction approval: use originator person wallet, post-transaction approval: use hot wallet address that record on blockchain
Min Length0
Max Length255
Example
E9aX7TbJqvLwzC1f8rYpBnGks3M0QHjVxODUZ_WRmT2yXoLp
originatorAddressTag
OptionalString
address is originator address (in all scenario), pre-transaction approval: use originator person wallet, post-transaction approval: use hot wallet address that record on blockchain
Min Length0
Max Length64
Example
E9aX7TbJqvLwzC1f8rYpBnGks3M0QHjVxODUZ_WRmT2yXoLp
publicKey
OptionalString
public key in Curve25519 algorithm. (No need to do base64 if you're using GTR package)
Min Length0
Max Length8192
Example
0szeNNub/IGoe623JCGD4B4bH8I94FozOeZjv1dKlXQ=
requestId
OptionalString
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]"
Example
testexchange-189e9948-64c7-4a6c-bb4f-859c173321c5
sourceVaspCode
OptionalString
*Required if you're TRSP type user, that you have to bring your member vasp's GTR vaspCode here, that we can recognize who made this travel rule.
Min Length0
Max Length32
Example
MAkGAda4ac
tag
OptionalString
some of network like XRP required to input address tag (memo)
Min Length0
Max Length128
Example
466489710
txId
OptionalString
*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
vaspCode
RequiredString
vaspCode in GTR system, this is unique id for each VASP.
Min Length0
Max Length128
Example
MAkGAda4ac
{
"requestId": "testexchange-189e9948-64c7-4a6c-bb4f-859c173321c5",
"txId": "d1029841dacb031098288b257b628a967eb963bbaccf954506ad0694219497a4",
"tag": 466489710,
"network": "XRP",
"originatorAddress": "E9aX7TbJqvLwzC1f8rYpBnGks3M0QHjVxODUZ_WRmT2yXoLp",
"originatorAddressTag": "E9aX7TbJqvLwzC1f8rYpBnGks3M0QHjVxODUZ_WRmT2yXoLp",
"address": "E9aX7TbJqvLwzC1f8rYpBnGks3M0QHjVxODUZ_WRmT2yXoLp",
"vaspCode": "MAkGAda4ac",
"publicKey": "0szeNNub/IGoe623JCGD4B4bH8I94FozOeZjv1dKlXQ=",
"sourceVaspCode": "MAkGAda4ac"
}
Responses
Status HTTP Status: 200, VerifyStatus: 100000
Success
JSON Content
- Schema
- Example
[+]data
OptionalObject
verifyMessage
OptionalString
verifyStatus
OptionalInteger (int32)
{
"verifyStatus": 100000,
"verifyMessage": "Verify Success"
}
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"
}