End Travel Rule

Version: 3.0.0

Method

POST

Url

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

Authentication

No authentication

Path Parameters

No path parameters

Query Parameters

No query parameters

Request Body (Optional)

Schema

	Property	Type	Required	Description
	reason	String	Yes	Reason of end the travel rule
	reasonType	String	Yes	Reason Type of end travel rule, see structure of: EndTravelRuleType
	requestId	String	Yes	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

{
  "reason": "for address book verify purpose",
  "requestId": "testexchange-189e9948-64c7-4a6c-bb4f-859c173321c5",
  "reasonType": "ADDRESS_BOOK_VERIFY"
}

Responses

Status 200

OK

JSON Content

Schema

	Property	Type	Description
	data	Object
Property Type Description No properties
	verifyMessage	String
	verifyStatus	Integer

Example

{
  "data": {},
  "verifyStatus": 0,
  "verifyMessage": "string"
}

Status HTTP Status: 200, VerifyStatus: 100000

Success

JSON Content

Schema

	Property	Type	Description
	data	Object
Property Type Description No properties
	verifyMessage	String
	verifyStatus	Integer

Example

{
  "data": {},
  "verifyStatus": 0,
  "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"
}