Sign in
MFA API

Initiate MFA Setup

Use this endpoint to initiate MFA setup for a user. Returns a secret and recovery codes to be stored by the user before verification.

post/v1/users/{id}/mfa/setup

Path parameters

idstring required

The unique identifier of the user you want to retrieve.

Request body

mfaType'app' | 'email' | 'sms' required

The type of MFA to configure.

Response

MFA setup initiated successfully. Store the secret and recovery codes before proceeding to verification.

secretstring

TOTP secret to be stored securely by the user or app.

urlstring

OTP Auth URL for QR code generation (TOTP only).

recoveryCodesstring[]

One-time recovery codes to be stored by the user.

mfaType'app' | 'email' | 'sms'

The MFA type that was configured.

enabledboolean

Indicates whether MFA is currently enabled.

Changes

No recorded changes to this endpoint across all 1 revision of this API.