Start the second-factor setup a sign-in is waiting on

POST

auth

mfa

setup

start

Error

A valid request URL is required to generate request examples

{
  "method": "totp",
  "factor_id": "01M5Y1G7AF0N78A9EP71BV68MT",
  "secret": "••••••••",
  "otpauth_uri": "••••••••"
}

Authorizations

apikey

string

header

required

Your publishable (pb_pk_…) or secret (pb_sk_…) key.

Authorization

string

header

required

The signed-in person's access token.

Body

application/json

mfa_token

string

required

The token returned when sign-in required enrolment.

Required string length: 1 - 2048

method

enum<string>

required

totp for an authenticator app, email for emailed codes.

Available options:

totp,

email

Response

Success.

method

string

required

factor_id

string

required

secret

string

required

otpauth_uri

string<email>

required

Error

A valid request URL is required to generate request examples

{
  "method": "totp",
  "factor_id": "01M5Y1G7AF0N78A9EP71BV68MT",
  "secret": "••••••••",
  "otpauth_uri": "••••••••"
}

Storage

AI

Flows

Inbound webhooks

Health

Accounts and sign-in

Social sign-in

Company sign-in (SAML)

Two-step verification

Sessions

Organizations and teams

User API keys

Devices

Realtime

Start the second-factor setup a sign-in is waiting on

Authorizations

Body

Response