KycApi
Interfaces
KycStatusResponse
KycStatusResponse
interface KycStatusResponse {
complete: boolean,
success: boolean,
distance: number,
createdAt: string,
completedAt: string,
webhook: string|null
}
KycDetailsResponse
KycDetailsResponse
interface KycDetailsResponse {
idCardPictureUrl: string,
selfiePictureUrl: string
}
Methods
constructor(app, endpoint)
constructor(app, endpoint)
Create a KYC API object.
app
should be an instance of theApplicationReference
object.endpoint
should be the Vulos Identity endpoint.
const kycApi = new KycApi(appRef, endpoint)
async status(kycId)
async status(kycId)
Get the status of a KYC verification instance by ID.
The result implements the KycStatusResponse
interface.
const status = await kycApi.status(kycId)
async list(page, pageSize)
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.
const first10 = await kycApi.list()
async upload(selfiePicture, idCardPicture)
async upload(selfiePicture, idCardPicture)
Upload KYC verification details for later use, both of the arguments must be objects that inherit from Blob
(like File
).
The result implements the KycDetailsResponse
interface.
const details = await kycApi.upload(selfieFile, idCardFile);
async create(selfiePicture, idCardPicture, webhook)
async create(selfiePicture, idCardPicture, webhook)
Make a KYC verification request, the first two arguments may be objects that inherit from Blob
or URLs returned by the upload()
method, the webhook
argument is optional.
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.
const kycId = await kycApi.create(selfieFile, idCardFile, 'http://example.com/webhook');
Last updated