VerifyVASP
Search…
⌃K

User Account Verification

post
http://<enclave-endpoint>
/v1/verifications/account
User Account Verification
This API requests verification of whether the beneficiary address (wallet address or account number input by originator) belongs to a beneficiary VASP.
When a withdrawal is requested to the originating VASP, it passes input wallet address and beneficiary's name (an optional field).
If the name exists in beneficiary VASP's side, the VASP confirms and returns the combination of wallet address and name under the assumption that the withdrawal amount is over the legal baseline.
If the name is unknown to beneficiary VASP, the VASP verifies only the wallet address as it regards the amount is under the baseline.

Request Body

Request Body Examples
Field Name
Data Type
Required
Description
keyType
string
true
beneficiaryVaspId
string
true
symbol
string
true
Virtual Asset.
The symbol of virtual assets (ex. ETH instead of Ethereum or Ether)
payload
object
true
IVMS101 format of beneficiary information (wallet address and name)
payload.version
string
true
IVMS101 message format version
payload.ivms101
object
true
Refer IVMS101 protocol for this field

Response Body

Success case

Response Body Examples

Response Body

Field Name
Data Type
Required
Example
Description
accountVerificationResult
string
true
"DENIED"
The result of verification
reason
string
false
"UNKNOWN-ADDRESS"
The reason field means that the detailed error code for when accountVerificationResult is DENIED
verifiedAt
date
true
"2022-03-03T18:19:20.092Z"
The verification datetime
  • accountVerificationResult field can be "VERIFIED" or "DENIED"
    • VERIFIED: Successfully verified account in beneficiary VASP.
    • DENIED: Unknown account or name, not verified on beneficiary VASP side.
  • reason field specification is as follows.
    • The field is valid only when result field is DENIED.
    • Refer to the below table for the message field value.
reason (string)
result (string)
message (string)
Description
UNKNOWN-SYMBOL
DENIED
The value of symbol name (which is not supported in VASP)
Unknown or not supported asset symbol
UNKNOWN-ADDRESS
DENIED
The unknown wallet address
Unknown wallet address to the VASP
MISMATCHED-NAME
DEINED
-
Name mismatch
UNDEFINED-ERROR
DEINED
Error description
Undefined errors
BLACKLISTED
DENIED
-
The beneficiary is blacklisted
UNVERIFIED-KYC
DENIED
-
The beneficiary's KYC has not been verified

Error Codes

MISSING-* in case of missing mandatory parameters

Response Body Examples

INVALID-* in case of invalid parameter input

Response Body Examples

The case of using a non-alliance member VASP ID

Response Body Examples

The case of the beneficiaryVaspId of VASP is in inactive status

Response Body Examples

The input symbol that is invalid or not supported by the VASP

Response Body Examples

The input of an invalid wallet address.

Response Body Examples

Mismatch to the address.

Response Body Examples