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.

A valid result will be returned only if the counterpart VASP is a member of the CODE alliance. The 'NOT_FOUND_ADDRESS' response indicates that either the beneficiary is not a CODE member, or the address could not be found temporarily due to a server issue with a member VASP.

❗️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.
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.

{
    "currency": "xrp",
    "addressNumber": "rHcFoo6a9qT5NHiVn1THQRhsEGcxtYCV4d:memo or tag",
    "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

Search VASP by Wallet Request

Request

Response

Example