Skip to main content
Search

Receiver Callback API 1 - Address Verification

Where should I integrate​

Callback Behaviour​

This callback is to verify the address is exists in your system.

For further details of the request structure, see: RegularizeCallbackVerifyAddressRequest.

When the initiator requests to verify whether the address exists in your service, you will receive the callback request, and the callback type will be 6.

Request From GTR:

{
  "requestId": "FdXI1VL3CepU",
  "invokeVaspCode": "[Invoker VASP Code]",
  "originatorVasp": "[Originator VASP Code]",
  "beneficiaryVasp": "[Beneficiary VASP Code]",
  "callbackType": 6,
  "callbackData": {
    "requestId": "FdXI1VL3CepU",
    "originatorVasp": "[Orignator VASP Code]",
    "originatorVaspName": "[Originator VASP Name]",
    "ticker": "ETC",
    "address": "0x41ebF291D8BFb6481B4Ab1E26c412A96484b1454",
    "tag": "",
    "network": "Sepolia",
    "initiatorVasp": "[Initiator VASP Code]"
  }
}

Please identify callback type - 6 and use the info fields: ticker, address, tag, network to search the target address.

Directly search the user wallet address by address and tag and network, the tag should do pre-processing that if tag="" or tag=null should treat as None or remove from the search query conditions, the address is exact search, cannot using LIKE '%{address}%' or fuzzy to search, it must be equal = '{address}'.

And given the result like below:

If address exists​

Response from your service:

{
  "verifyMessage": "success",
  "verifyStatus": 100000
}

If address not exists​

Response from your service:

{
  "verifyMessage": "address not found",
  "verifyStatus": 200001
}

If many address been found​

It could be happens if some of network (e.g: XLM, TRX, TON) required tag but user doesn't fill it.

Response from your service:

{
  "verifyMessage": "Too many address",
  "verifyStatus": 200001
}

*The Timeout of this API response should be < 2 sec.