Skip to main content
POST
Start TOTP MFA enrollment

Authorizations

Authorization
string
header
required

Basic Auth header with your app ID as the username and your app secret as the password.

Headers

privy-app-id
string
required

ID of your Privy app.

privy-user-token
string
required

Access token or custom authentication JWT for the user the request acts on.

Minimum string length: 1
privy-mfa-token
string

MFA token from a completed MFA verification, required on MFA-protected requests for users with MFA enrolled.

Minimum string length: 1

Path Parameters

user_id
string
required

Response

200 - application/json

Authenticator setup information.

Authenticator setup information for the started TOTP MFA enrollment.

options
TotpMfaEnrollmentOptions · object
required

Authenticator setup information for TOTP MFA enrollment.