initOtp() - Turnkey

Initializes the OTP process by sending an OTP code to the provided contact.

This function initiates the OTP flow by sending a one-time password (OTP) code to the user’s contact information (email address or phone number) via the auth proxy.
Supports both email and SMS OTP types.
Returns an OTP ID that is required for subsequent OTP verification.

Package: core

Defined in: core.ts:1151

params

object

required

Show params details

params.contact

string

required

contact information for the user (e.g., email address or phone number).

params.otpType

OtpType

required

type of OTP to initialize (OtpType.Email or OtpType.Sms).

A successful response returns the following fields:

returns

string

required

A promise that resolves to the OTP ID required for verification.