completeOtp()

Overview

Completes the OTP authentication flow by verifying the OTP code and then either signing up or logging in the user.

• This function first verifies the OTP code for the provided contact and OTP type.
• If the contact is not associated with an existing sub-organization, it will automatically create a new sub-organization and complete the sign-up flow.
• If the contact is already associated with a sub-organization, it will complete the login flow.
• Supports passing a custom public key for authentication, invalidating existing session, specifying a session key, and providing additional sub-organization creation parameters.
• Handles both email and SMS OTP types.

Package: core

Defined in: clients/core.ts:1571

Parameters

params · CompleteOtpParams · 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 sub-organization creation (e.g., authenticators, user metadata).

Show createSubOrgParams details

params.createSubOrgParams.apiKeys

object[]

list of api keys

params.createSubOrgParams.authenticators

object[]

list of authenticators

params.createSubOrgParams.customWallet

CustomWallet

custom wallets to create during sub-org creation time

Show customWallet details

params.createSubOrgParams.customWallet.walletAccounts

v1WalletAccountParams[]

required

list of wallet accounts to create

params.createSubOrgParams.customWallet.walletName

string

required

name of the wallet created

params.createSubOrgParams.oauthProviders

Provider[]

list of oauth providers

params.createSubOrgParams.subOrgName

string

name of the sub-organization

params.createSubOrgParams.userEmail

string

email of the user

params.createSubOrgParams.userName

string

name of the user

params.createSubOrgParams.userPhoneNumber

string

phone number of the user

params.createSubOrgParams.userTag

string

tag of the user

params.createSubOrgParams.verificationToken

string

verification token if email or phone number is provided

params.invalidateExisting

boolean

flag to invalidate existing sessions for the user.

params.otpCode

string

required

OTP code entered by the user.

params.otpId

string

required

ID of the OTP to complete (returned from initOtp).

params.otpType

OtpType

required

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

params.publicKey

string

public key to use for authentication. If not provided, a new key pair may be generated.

params.sessionKey

string

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

Response

A successful response returns the following fields:

returns · BaseAuthResult & object · required

A promise that resolves to an object containing:

• sessionToken: the signed JWT session token.
• verificationToken: the OTP verification token.
• action: whether the flow resulted in a login or signup (AuthAction).