Query the VASP to which the wallet address belongs.
A VASP intending to transfer virtual assets might integrate this API at the initial step of the process. It will help identify the VASP to which the beneficiary's wallet address(address + tag(optional)) belongs.
This API allows the elimination of a process where users select an exchange on the UI, enabling more streamlined flow. Even more, it proves highly beneficial when the user is unaware of the counterpart VASP.
Only data from VASPs affiliated with CODE and certain other supported protocols can be queried. A 'NOT_FOUND_ADDRESS' response indicates that the queried address either does not belong to a currently searchable VASP or could not be retrieved due to a temporary server issue on the member VASP's side.
❗️This search targets only the user wallets(capable of receiving deposits) associated with VASPs. It does not include the cold wallets of VASPs.
❗️After making a request to an API that operates asynchronously, you can either receive the result using a Callback URL or check the result via the 'Search VASP by Wallet Result' API. The result data is the same for both methods.
Request
| Name | Required | Description |
|---|---|---|
| currency | Required | The symbol of the virtual asset you wish to transfer. (Case insensitive) |
| addressNumber | Required | Beneficiary's wallet address. Attach secondary addresses like tag or memo after a ':' delimiter. |
| network | Optional | -This is written to distinguish coins that exist on multiple networks. -VASPs integrated with other solution providers may require this information, so please refer to the interoperability page with other protocols. -If entered, VASPs affiliated with GTR will also be searched(Binance). |
| requestId | Required | This is the request ID for querying the result. It must be unique. |
| callbackUrl | Optional | -Callback URL in https:// format to receive the result. -The specified URL must allow inbound connections from CODE's IP address. |
{
"currency": "xrp",
"addressNumber": "rHcFoo6a9qT5NHiVn1THQRhsEGcxtYCV4d:memo or tag",
"network":"xrp",
"requestId": "fafd59e2-aff7-4cff-b7d8-9caa0cda70da",
"callbackUrl": "https://endpoint.com"
}
Response
| Name | Required | Description |
|---|---|---|
| result | Required | Result for a request. |
result: Result for a request.
-SUCCESS: Returned in the case of a valid request