Address Routing Verify Callback
Method
POST
Url
https://{YOUR_SERVICE_URL}/(address routing verify: 10)
This API endpoint is for verify address and tx id existence in same callback, and if you have multiple-entity in different country, could also implement for VASP routing. verifyTargetType = 1 is to verify address (beneficiary), network, tag belongs to your service. verifyTargetType = 2 is to verify tx id + address (beneficiary), network, tag belongs to your service. *The reason using beneficiary address in txId check, is because originator mostly using hot-wallet to make transfer, so that you as originator should using txid + beneficiary address to identify who is originator. for address routing feature, if the the address in the request is belongs to known other entity from your brand, then you can return correct entity vasp code to response, it will help to improve the address not found rate
Authentication
No authentication
Path Parameters
No path parameters
Query Parameters
No query parameters
Request Body (Required)
- Schema
- Example
{
"initiatorVasp": "string",
"requestId": "string",
"verifyTargetType": 0,
"travelruleId": "string",
"beneficiaryAddress": {
"address": "E9aX7TbJqvLwzC1f8rYpBnGks3M0QHjVxODUZ_WRmT2yXoLp",
"tag": "some of network like XRP required to input address tag (memo)"
},
"transactionInfo": {
"ticker": "string",
"txId": "string",
"network": "string"
}
}
Responses
Status HTTP Status: 200, VerifyStatus: 200001
Address not found case
JSON Content
- Schema
- Example
{
"verifyStatus": 200001,
"verifyMessage": "Address Not Found."
}
Status HTTP Status: 200, VerifyStatus: 200017
default response
JSON Content
- Schema
- Example
{
"verifyStatus": 200017,
"verifyMessage": "Address found but wrong VASP"
}
Status HTTP Status: 200, VerifyStatus: 100000
default response
JSON Content
- Schema
- Example
{
"verifyStatus": 100000,
"verifyMessage": "Verify Success"
}
verifyTargetType= 1 is to verifybeneficiary_address+network+tagbelongs to your VASP or not.verifyTargetType= 2 is to verifytx id+beneficiary_address+network+tagbelongs to your VASP or not.
For the Address Routing feature, if the beneficiary_address in the request belongs to another entity of your brand, you can return the vasp_code of that entity.
This is a tactic to help reduce the ratio of Address Not Found.