Class VerificationsApi

Hierarchy

VerificationApi
- VerificationsApi

Index

Methods

reportById reportByIdentity setBasePath start

Methods

reportById

reportById(
data: ReportVerificationByIdRequestData,
): Promise<VerificationResponse>
Report a verification with ID Report the received verification code to verify it, using the Verification ID of the Verification request.
Parameters
- data: ReportVerificationByIdRequestData
  The data to provide to the API call.
Returns Promise<VerificationResponse>

reportByIdentity

reportByIdentity(
data: ReportVerificationByIdentityRequestData,
): Promise<VerificationResponse>
Report a verification using Identity Report the received verification code to verify it, using the identity of the user (in most cases, the phone number). For an SMS PIN verification or Phone Call verification, this is the OTP code. For flashcalls, this is the CLI.
Parameters
- data: ReportVerificationByIdentityRequestData
  The data to provide to the API call.
Returns Promise<VerificationResponse>

setBasePath

setBasePath(basePath: string): void
Update the default basePath for the API
Parameters
- basePath: string
  The new base path to use for the APIs.
Returns void
Inherited from VerificationApi.setBasePath

start

start(data: StartVerificationRequestData): Promise<InitiateVerificationResponse>
Start verification This method is used by the mobile and web Verification SDKs to start a verification. It can also be used to request a verification from your backend, by making a request.
Parameters
- data: StartVerificationRequestData
  The data to provide to the API call.
Returns Promise<InitiateVerificationResponse>