Skip to main content
POST
Start email 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

Body

application/json

Starts email MFA enrollment by sending a code to the email address.

email_address
string<email>
required

Response

200 - application/json

Enrollment code sent.

A simple success response.

success
boolean
required