Users MFA

Start SMS MFA enrollment

Changed on

Sends an SMS MFA enrollment code to a phone number.

post/v1/users/{user_id}/mfa/sms/enrollment/init

Request

  • Base URL
    https://api.privy.io
  • URL
    https://api.privy.io/v1/users/{user_id}/mfa/sms/enrollment/init
  • Auth
    HTTP basic

Path parameters

user_idstring required

Headers

privy-app-idstring required

ID of your Privy app.

privy-user-tokenstring required

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

privy-mfa-tokenstring

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

Request body

phone_numberstring required

Response

Enrollment code sent.

successboolean required

Changes