signUpWithOtp()

Signs up a user using an OTP verification token.

This function signs up a user using the verification token received after OTP verification (from email or SMS).
Creates a new sub-organization for the user with the provided parameters and associates the contact (email or phone) with the sub-organization.
Automatically generates a new API key pair for authentication and session management.
Stores the resulting session token under the specified session key, or the default session key if not provided.
Handles both email and SMS OTP types, and supports additional sub-organization creation parameters.

Package: core

Defined in: core.ts:1356

params

object

required

Show params details

params.contact

string

required

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

params.createSubOrgParams

CreateSubOrgParams

parameters for creating a sub-organization (e.g., authenticators, user metadata).

params.invalidateExisting

boolean

flag to invalidate existing session for the user.

params.otpType

OtpType

required

type of OTP being used (OtpType.Email or OtpType.Sms).

params.sessionKey

string

session key to use for session creation (defaults to the default session key).

params.verificationToken

string

required

verification token received after OTP verification.

A successful response returns the following fields:

returns

BaseAuthResult

required

A promise that resolves to a BaseAuthResult, which includes: