KycApi
Last updated
Last updated
You need or to access some parts of this API.
KycStatusResponse
KycDetailsResponse
constructor(app, endpoint)
Create a KYC API object.
app
should be an instance of the ApplicationReference
object.
endpoint
should be the Vulos Identity endpoint.
async status(kycId)
Get the status of a KYC verification instance by ID.
async list(page, pageSize)
Get a list of all the KYC verification instance IDs.
page
defaults to 0;
pageSize
defaults to 10;
The result is an array of KYC Instance IDs.
async upload(selfiePicture, idCardPicture)
Upload KYC verification details for later use, both of the arguments must be objects that inherit from Blob
(like File
).
async create(selfiePicture, idCardPicture, webhook)
The result is the ID of the KYC Instance that was created.
The webhook must be in the application's redirect URLs otherwise the server will return the "Bad Request" response.
The result implements the interface.
This method's response has the kyc:status
prefix.
This method's response has the kyc:list
prefix.
The result implements the interface.
Make a KYC verification request, the first two arguments may be objects that inherit from Blob
or URLs returned by the method, the webhook
argument is optional.