Overview

Verifies the OTP code sent to the user.
  • This function verifies the OTP code entered by the user against the OTP sent to their contact information (email or phone) using the auth proxy.
  • If verification is successful, it returns the sub-organization ID associated with the contact (if it exists) and a verification token.
  • The verification token can be used for subsequent login or sign-up flows.
  • Handles both email and SMS OTP types.

Package: core

Defined in: core.ts:1202

Parameters

​
params
object
required

Response

A successful response returns the following fields:
​
returns
object
required
A promise that resolves to an object containing:
  • subOrganizationId: sub-organization ID if the contact is already associated with a sub-organization, or an empty string if not.
  • verificationToken: verification token to be used for login or sign-up.