Address Routing Verify Callback

Version: 3.0.0

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 (Optional)

Schema

[+]beneficiaryAddress

RequiredObject

initiatorVasp

RequiredString

the vasp who initiate this request

Min Length0

Max Length32

Example

[vaspCode]

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

[+]transactionInfo

RequiredObject

verifyTargetType

RequiredInteger (int32)

Example

{
  "initiatorVasp": "[vaspCode]",
  "requestId": "testexchange-189e9948-64c7-4a6c-bb4f-859c173321c5",
  "verifyTargetType": 0,
  "beneficiaryAddress": {
    "address": "E9aX7TbJqvLwzC1f8rYpBnGks3M0QHjVxODUZ_WRmT2yXoLp",
    "tag": "some of network like XRP required to input address tag (memo)"
  },
  "transactionInfo": {
    "ticker": "USDT",
    "txId": "d1029841dacb031098288b257b628a967eb963bbaccf954506ad0694219497a4",
    "network": "XRP"
  }
}

Responses

Status 200

OK

JSON Content

Schema

[+]data

OptionalObject

verifyMessage

OptionalString

verifyStatus

RequiredInteger (int32)

VerifyStatus

Example

100000

Example

{
  "data": {
    "redirectVaspCode": "string"
  },
  "verifyStatus": 100000,
  "verifyMessage": "string"
}

Status HTTP Status: 200, VerifyStatus: 200001

Address not found case

JSON Content

Schema

[+]data

OptionalObject

verifyMessage

OptionalString

verifyStatus

RequiredInteger (int32)

VerifyStatus

Example

100000

Example

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

Status HTTP Status: 200, VerifyStatus: 200017

JSON Content

Schema

[+]data

OptionalObject

verifyMessage

OptionalString

verifyStatus

RequiredInteger (int32)

VerifyStatus

Example

100000

Example

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

Status HTTP Status: 200, VerifyStatus: 100000

JSON Content

Schema

[+]data

OptionalObject

verifyMessage

OptionalString

verifyStatus

RequiredInteger (int32)

VerifyStatus

Example

100000

Example

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

• verifyTargetType = 1 is to verify beneficiary_address + network + tag belongs to your VASP or not.
• verifyTargetType = 2 is to verify tx id + beneficiary_address + network + tag belongs 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.