Start enrolling an authenticator app

POST

auth

mfa

totp

enroll

Error

A valid request URL is required to generate request examples

{
  "factor_id": "01M6PCKV82N6P5MKKYG7WNMDBJ",
  "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

The body is of type object.

Response

Success.

factor_id

string

required

secret

string

required

otpauth_uri

string

required

Error

A valid request URL is required to generate request examples

{
  "factor_id": "01M6PCKV82N6P5MKKYG7WNMDBJ",
  "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 enrolling an authenticator app

Authorizations

Body

Response