Verify Address Existence
Method
POST
Url
https://platform.globaltravelrule.com/api/verify/v2/verify_address
This API endpoint is to verify the address. In asynchronous API flow, this endpoint is necessary to be called before triggering the PII verification.
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 Length1
Example
E9aX7TbJqvLwzC1f8rYpBnGks3M0QHjVxODUZ_WRmT2yXoLp
network
RequiredString
Network name in short symbol, the reference can check the table.
Min Length0
Max Length64
Example
XRP
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
tag
OptionalString
some of network like XRP required to input address tag (memo)
Example
some of network like XRP required to input address tag (memo)
targetVaspCode
RequiredString
targetVaspCode here is the counter-party VASP that you want to send the travel rule request (*Not the assets transfer direction), vaspCode is GTR system's format
Min Length4
Max Length64
Example
MAkGAda4ac
ticker
RequiredString
ticker (coin) is the symbol of coin money, could refer to CMC
Min Length1
Max Length64
Example
USDT
txId
RequiredString
*if the travel rule is after on chain, then the txId is required. the tx id format type can check the table.
Example
d1029841dacb031098288b257b628a967eb963bbaccf954506ad0694219497a4
{
"ticker": "USDT",
"address": "E9aX7TbJqvLwzC1f8rYpBnGks3M0QHjVxODUZ_WRmT2yXoLp",
"requestId": "testexchange-189e9948-64c7-4a6c-bb4f-859c173321c5",
"txId": "d1029841dacb031098288b257b628a967eb963bbaccf954506ad0694219497a4",
"tag": "some of network like XRP required to input address tag (memo)",
"targetVaspCode": "MAkGAda4ac",
"network": "XRP"
}
Responses
Status HTTP Status: 200, VerifyStatus: 200001
Address not found case
JSON Content
- Schema
- Example
[+]data
OptionalObject
verifyMessage
OptionalString
verifyStatus
OptionalInteger (int32)
{
"verifyStatus": 200001,
"verifyMessage": "Address Not Found."
}
Status HTTP Status: 200, VerifyStatus: 100000
Success case
JSON Content
- Schema
- Example
[+]data
OptionalObject
verifyMessage
OptionalString
verifyStatus
OptionalInteger (int32)
{
"verifyStatus": 100000,
"verifyMessage": "Verify Success"
}