A VASP who wants to transfer assets need to know which VASP owns the address (address + tag(optional)) of a virtual asset to which a user wants to transfer his or her asset by using this API in the first step of the entire process.

❗️This API works in a synchronous manner, providing an immediate response upon request.

Path Parameter

Name	Required	Type	Description
BeneficiaryVaspEntityId	Required	string	This is the EntityID of the VASP which owns the address to which the asset is transferred.

Request

Name	Required	Type
currency	Required	string
payload	Required	string
address	Optional	string
tag	Optional	string
network	Optional	string

currency: This is a symbol of the virtual asset you want to transfer. (This is case insensitive.)

payload: Since only the wallet address is verified at this point as an encrypted IVMS101 object, it is not necessary to input the entire IVMS101 object. Thearray<accountNumber> within the 'Beneficiary' object is required, while beneficiaryPersons should be empty array.

address: Wallet address of the beneficiary. Since some VASPs integrated with other solutions may required this field, please refer to Interoperability with Other Protocols page.

tag: Include this if a Tag or Memo exists (e.g., XRP). Since some VASPs integrated with other solutions may required this field, please refer to Interoperability with Other Protocols page.

network: This is included to distinguish when a single coin exists on multiple networks. Since some VASPs integrated with other solutions may required this field, please refer to Interoperability with Other Protocols page.


{
  "currency": "XRP",
  "address": "TestXrpAddress",
  "tag": "1000001",
  "network": "XRP",
  "payload": "encrypted ivms101 payload"
}

{
   "ivms101": {
      "Beneficiary": {
        "beneficiaryPersons": [],
        "accountNumber": ["rHcFoo6a9qT5NHiVn1THQRhsEGcxtYCV4d:memo or tag"]
      }
   }
}

Response

Name	Required	Type
result	Required	string
reasonType	Optional	string
reasonMsg	Optional	string
beneficiaryVaspEntityId	Required	string

result: This is a virtual asset address verification result.

-valid: This is a normal address

-invalid: This is the result of virtual asset address search. You can classify the details by the reasonType value.

reasonType: If the result field value is invalid, you need to add this field to send error details.

-NOT_FOUND_ADDRESS: This is a case where a virtual asset address cannot be found.

-NOT_SUPPORTED_SYMBOL: This is a currency symbol which cannot be traded.

-NOT_KYC_USER: This is a case where the owner did not process KYC verification.

-SANCTION_LIST: Virtual asset addresses or owners are subject to the sanction of the beneficiary VASP.

-LACK_OF_INFORMATION: This is a case where there is no the information necessary to make an asset transfer decision.

-UNKNOWN: This refers to other reasons.

reasonMsg: It defines a detailed message if invalid.

beneficiaryVaspEntityId: If there is a VASP that owns a virtual asset address to be looked up, this is the Entity ID of the corresponding VASP.

Example

200200