Address Existence Verify Callback

Version: 3.0.0

Method

POST

Url

https://{YOUR_SERVICE_URL}/(address exists verify: 6)

This API endpoint is for address verification. The initiator will send a verification request via GTR. You need to verify whether the address belongs to your service. Please note that if the tag is null, it should be treated as empty or not used as a search condition for your service. The address refers to the beneficiary address. Please return this response after you verify the address. verifyStatus: 100000 - Address Exists (Success) verifyStatus: 200001 - Address/Tag Not Found

Authentication

No authentication

Path Parameters

No path parameters

Query Parameters

No query parameters

Request Body (Optional)

Schema

address

RequiredString

address is beneficiary address (in all scenario)

Min Length0

Max Length256

Example

E9aX7TbJqvLwzC1f8rYpBnGks3M0QHjVxODUZ_WRmT2yXoLp

initiatorVasp

RequiredString

the vasp who initiate this request

Min Length0

Max Length64

Example

[vaspCode]

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)

Min Length0

Max Length64

Example

466489710

ticker

RequiredString

ticker (coin) is the symbol of coin money, could refer to CMC

Min Length0

Max Length64

Example

USDT

Example

{
  "initiatorVasp": "[vaspCode]",
  "ticker": "USDT",
  "address": "E9aX7TbJqvLwzC1f8rYpBnGks3M0QHjVxODUZ_WRmT2yXoLp",
  "requestId": "testexchange-189e9948-64c7-4a6c-bb4f-859c173321c5",
  "tag": "466489710",
  "network": "XRP"
}

Responses

Status 200

OK

JSON Content

Schema

verifyMessage

OptionalString

verifyStatus

RequiredInteger (int32)

VerifyStatus

Example

100000

Example

{
  "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: 100000

Success case

JSON Content

Schema

[+]data

OptionalObject

verifyMessage

OptionalString

verifyStatus

RequiredInteger (int32)

VerifyStatus

Example

100000

Example

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

Note: If tag is null, treat it as empty or exclude it from your search criteria.

Response Example 1: Success

HTTP Status: 200, VerifyStatus: 100000

{"verifyStatus": 100000,"verifyMessage": "Verify Success"}

This response indicates that the address do exist in your service.

Response Example 2：Address Not Found

HTTP Status: 200, VerifyStatus: 200001

{"verifyStatus": 200001,"verifyMessage": "Address Not Found."}