Links
Comment on page

KycStatus

Members

api : KycApi

The KycApi instance that this object was created with.

status : KycStatusResponse

An object that implements the KycStatusResponse interface.

Methods

constructor(api, status)

Create a new instance of the KycStatus object.
This constructor should not be called directly, use KycInstance.status()instead.

id()

Get the id of the request.
This function returns a string.
const id = kycStatus.id()

isComplete()

Is the KYC verification complete?
This function returns a boolean.
if (kycStatus.isComplete()) {
// do something
}

isSuccessful()

Was the KYC verification successful?
This function returns a boolean.
if (kycStatus.isSuccessful()) {
// do something
}

distance()

Get the machine learning algorithm distance.
This function returns a number between 0 and 1.
if (kycStatus.distance() > 0.9) {
// the user sent something worse than random noise
}

createdAt()

When was the KYC verification requested?
This function returns a Date object.
const createdDate = kycStatus.createdAt()

completedAt()

When was the KYC verification completed?
This function returns a Date object.
const completedDate = kycStatus.completedAt()

webhook()

Get the webhook URL that got / will get called when the request is complete.
This function returns an URL object.
const webhookUrl = kycStatus.webhook()
Last modified 1yr ago