Overview

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:1353

Parameters

params
object
required

Response

A successful response returns the following fields:
returns
BaseAuthResult
required
A promise that resolves to a BaseAuthResult, which includes:
  • sessionToken: the signed JWT session token.