Skip to main content
POST
Start passkey 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 a passkey MFA ceremony for the specified relying party origin.

relying_party
string<uri>
required

Origin where the authenticator runs, such as https://app.example.com.

Response

200 - application/json

WebAuthn registration options.

WebAuthn registration options for the started passkey MFA enrollment.

options
MfaPasskeyAuthenticatorEnrollmentOptions · object
required

WebAuthn registration options as defined by the Web Authentication specification.