Class VerificationsApi

Hierarchy

VerificationDomainApi
- VerificationsApi

Index

Methods

formatTime performStartSmsRequestBodyTransformation reportCalloutById reportCalloutByIdentity reportFlashCallById reportFlashCallByIdentity reportSmsById reportSmsByIdentity startCallout startFlashCall startSeamless startSms

Methods

formatTime

formatTime(date: Date): string
Parameters
- date: Date
Returns string

performStartSmsRequestBodyTransformation

performStartSmsRequestBodyTransformation(
body: StartVerificationWithSms,
): StartVerificationWithSms
Parameters
- body: StartVerificationWithSms
Returns StartVerificationWithSms

reportCalloutById

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

reportCalloutByIdentity

reportCalloutByIdentity(
data: ReportCalloutVerificationByIdentityRequestData,
): Promise<CalloutVerificationReportResponse>
Report a Callout verification using Identity Report the received verification code (OTP) to verify it, using the identity of the user (in most cases, the phone number).
Parameters
- data: ReportCalloutVerificationByIdentityRequestData
  The data to provide to the API call.
Returns Promise<CalloutVerificationReportResponse>

reportFlashCallById

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

reportFlashCallByIdentity

reportFlashCallByIdentity(
data: ReportFlashCallVerificationByIdentityRequestData,
): Promise<FlashCallVerificationReportResponse>
Report a FlashCall verification using Identity Report the received verification code (CLI) to verify it, using the identity of the user (in most cases, the phone number).
Parameters
- data: ReportFlashCallVerificationByIdentityRequestData
  The data to provide to the API call.
Returns Promise<FlashCallVerificationReportResponse>

reportSmsById

reportSmsById(
data: ReportSmsVerificationByIdRequestData,
): Promise<SMSVerificationReportResponse>
Report an SMS verification with ID Report the received verification code to verify it, using the Verification ID of the Verification request.
Parameters
- data: ReportSmsVerificationByIdRequestData
  The data to provide to the API call.
Returns Promise<SMSVerificationReportResponse>

reportSmsByIdentity

reportSmsByIdentity(
data: ReportSmsVerificationByIdentityRequestData,
): Promise<SMSVerificationReportResponse>
Report an SMS verification using Identity Report the received verification code (OTP) to verify it, using the identity of the user (in most cases, the phone number).
Parameters
- data: ReportSmsVerificationByIdentityRequestData
  The data to provide to the API call.
Returns Promise<SMSVerificationReportResponse>

startCallout

startCallout(
data: StartCalloutVerificationRequestData,
): Promise<StartCalloutVerificationResponse>
Start verification with a callout 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: StartCalloutVerificationRequestData
  The data to provide to the API call.
Returns Promise<StartCalloutVerificationResponse>

startFlashCall

startFlashCall(
data: StartFlashCallVerificationRequestData,
): Promise<StartFlashCallVerificationResponse>
Start verification with a FlashCall 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: StartFlashCallVerificationRequestData
  The data to provide to the API call.
Returns Promise<StartFlashCallVerificationResponse>

startSeamless

startSeamless(
data: StartSeamlessVerificationRequestData,
): Promise<StartSeamlessVerificationResponse>
Start seamless verification (= data 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: StartSeamlessVerificationRequestData
  The data to provide to the API call.
Returns Promise<StartSeamlessVerificationResponse>

startSms

startSms(
data: StartSmsVerificationRequestData,
): Promise<StartSmsVerificationResponse>
Start verification with SMS 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: StartSmsVerificationRequestData
  The data to provide to the API call.
Returns Promise<StartSmsVerificationResponse>

Class VerificationsApi

Hierarchy

Index

Methods

Methods

formatTime

Parameters

Returns string

performStartSmsRequestBodyTransformation

Parameters

Returns StartVerificationWithSms

reportCalloutById

Parameters

Returns Promise<CalloutVerificationReportResponse>

reportCalloutByIdentity

Parameters

Returns Promise<CalloutVerificationReportResponse>

reportFlashCallById

Parameters

Returns Promise<FlashCallVerificationReportResponse>

reportFlashCallByIdentity

Parameters

Returns Promise<FlashCallVerificationReportResponse>

reportSmsById

Parameters

Returns Promise<SMSVerificationReportResponse>

reportSmsByIdentity

Parameters

Returns Promise<SMSVerificationReportResponse>

startCallout

Parameters

Returns Promise<StartCalloutVerificationResponse>

startFlashCall

Parameters

Returns Promise<StartFlashCallVerificationResponse>

startSeamless

Parameters

Returns Promise<StartSeamlessVerificationResponse>

startSms

Parameters

Returns Promise<StartSmsVerificationResponse>

Settings

On This Page