VerifyVASP
Search…
User Verification
post
http://<enclave-endpoint>
/v1/verifications
User verification request
The API is for requesting beneficiary verification to the beneficiary VASP
As the verification process works in an asynchronous manner, you can check the result by (1) polling (calling API repeatedly) the result by verificationUuid, or (2) implementing a callback VASP API enabling you to get the result notification.å
Callback option is recommended.

Request Body

Request Body Examples
Field Name
Data Type
Required
Description
keyType
string
true
A Public Key type which will be used to encrypt personal information
One type of the three ”PerVasp”, “PerEoa”, and “PerVerification” can be chosen.
BeneficiaryVASP needs to provide a Public Key corresponding to the key type chosen by the OriginatingVASP.
beneficiaryVaspId
string
true
The Vasp ID of the beneficiary VASP
requiredBeneficiaryInfo
string
true
A list of verification required personal information fields of the beneficiary, separated with comma(,)
assetInfo.symbol
string
true
The symbol of virtual asset
assetInfo.amount
string
true
Transaction amount in virtual asset
assetInfo.isExceedingThreshold
boolean
true
Flag field showing whether the withdrawal request exceeds the amount the law states.
assetInfo.tradeCurrency
string
true
Legal currency code used when converting to legal currency (ISO 4217 standard)
assetInfo.tradePrice
string
true
Virtual asset amount converted in legal currency. If there is no market price of the VASP, convert via the market price API of other VASPs.
assetInfo.tradeISODatetimee
string
true
The standard time at which VA was converted into legal currency
payload
object
true
Information about Originator, Beneficiary, OI, BI IVMS101 format.
payload.version
string
true
A version regarding the IVMS101 message format.
payload.ivms101
object
true
Information about the originator and the beneficiary in ivms101 format Refer to the IVMS101 message protocol. Refer to the IVMS101 message guide document.

Response Body

Success case

Response Body Examples
Field Name
Data Type
Required
Description
verificationUuid
string
true
User verification request ID
createdAt
date
true
Datetime of verification requested
  • There are 2 available options to get the verification result.
    • polling : Repeatedly asking for results via Verification Result API while the process is done.
    • Callback API : Implementing the callback API on VASP side and set it as an environment variable in order to make the enclave call the API to notify the result.

Error Codes

Missing mandatory parameter case

Response Body Examples

The invalid value of parameters

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 case the request processing exceeds the timeout.

Response Body Examples

Links

IVMS101 Codes for types of personal information fields
  • Refer below link to find available codes for the requiredBeneficiaryInfo field in the request payload.