Class VerificationsApi

Hierarchy

VerificationDomainApi
- VerificationsApi

Index

Methods

formatTime performReportPhoneCallByIdentityRequestBodyTransformation performReportPhoneCallByIdRequestBodyTransformation performStartPhoneCallRequestBodyTransformation performStartSmsRequestBodyTransformation reportCalloutById reportCalloutByIdentity reportFlashCallById reportFlashCallByIdentity reportPhoneCallById reportPhoneCallByIdentity reportSmsById reportSmsByIdentity startCallout startData startFlashCall startPhoneCall startSeamless startSms

Methods

formatTime

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

reportCalloutById

reportCalloutById(
data: ReportCalloutVerificationByIdRequestData,
): Promise<PhoneCallVerificationReportResponse>
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<PhoneCallVerificationReportResponse>
Deprecated
Use the method reportPhoneCallById() instead

reportCalloutByIdentity

reportCalloutByIdentity(
data: ReportCalloutVerificationByIdentityRequestData,
): Promise<PhoneCallVerificationReportResponse>
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<PhoneCallVerificationReportResponse>
Deprecated
Use the method reportPhoneCallByIdentity() instead

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>

reportPhoneCallById

reportPhoneCallById(
data: ReportPhoneCallVerificationByIdRequestData,
): Promise<PhoneCallVerificationReportResponse>
Report a Phone Call verification with ID Report the received verification code to verify it, using the Verification ID of the Verification request.
Parameters
- data: ReportPhoneCallVerificationByIdRequestData
  The data to provide to the API call.
Returns Promise<PhoneCallVerificationReportResponse>

reportPhoneCallByIdentity

reportPhoneCallByIdentity(
data: ReportPhoneCallVerificationByIdentityRequestData,
): Promise<PhoneCallVerificationReportResponse>
Report a Phone Call 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: ReportPhoneCallVerificationByIdentityRequestData
  The data to provide to the API call.
Returns Promise<PhoneCallVerificationReportResponse>

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<StartPhoneCallVerificationResponse>
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<StartPhoneCallVerificationResponse>
Deprecated
Use the method startPhoneCall() instead

startData

startData(
data: StartDataVerificationRequestData,
): Promise<StartDataVerificationResponse>
Start 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: StartDataVerificationRequestData
  The data to provide to the API call.
Returns Promise<StartDataVerificationResponse>

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>

startPhoneCall

startPhoneCall(
data: StartPhoneCallVerificationRequestData,
): Promise<StartPhoneCallVerificationResponse>
Start verification with a phone call 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: StartPhoneCallVerificationRequestData
  The data to provide to the API call.
Returns Promise<StartPhoneCallVerificationResponse>

startSeamless

startSeamless(
data: StartSeamlessVerificationRequestData,
): Promise<StartDataVerificationResponse>
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<StartDataVerificationResponse>
Deprecated
Use the method startData() instead

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

performReportPhoneCallByIdentityRequestBodyTransformation

Parameters

Returns PhoneCallVerificationReportRequestServerModel

performReportPhoneCallByIdRequestBodyTransformation

Parameters

Returns PhoneCallVerificationReportRequestServerModel

performStartPhoneCallRequestBodyTransformation

Parameters

Returns StartVerificationWithPhoneCallServerModel

performStartSmsRequestBodyTransformation

Parameters

Returns StartVerificationWithSms

reportCalloutById

Parameters

Returns Promise<PhoneCallVerificationReportResponse>

Deprecated

reportCalloutByIdentity

Parameters

Returns Promise<PhoneCallVerificationReportResponse>

Deprecated

reportFlashCallById

Parameters

Returns Promise<FlashCallVerificationReportResponse>

reportFlashCallByIdentity

Parameters

Returns Promise<FlashCallVerificationReportResponse>

reportPhoneCallById

Parameters

Returns Promise<PhoneCallVerificationReportResponse>

reportPhoneCallByIdentity

Parameters

Returns Promise<PhoneCallVerificationReportResponse>

reportSmsById

Parameters

Returns Promise<SmsVerificationReportResponse>

reportSmsByIdentity

Parameters

Returns Promise<SmsVerificationReportResponse>

startCallout

Parameters

Returns Promise<StartPhoneCallVerificationResponse>

Deprecated

startData

Parameters

Returns Promise<StartDataVerificationResponse>

startFlashCall

Parameters

Returns Promise<StartFlashCallVerificationResponse>

startPhoneCall

Parameters

Returns Promise<StartPhoneCallVerificationResponse>

startSeamless

Parameters

Returns Promise<StartDataVerificationResponse>

Deprecated

startSms

Parameters

Returns Promise<StartSmsVerificationResponse>

Settings

On This Page