Sign in
Passkeys

Generate Authentication Options

Generate options to authenticate with an existing passkey.

post/user-authenticators/passkey/authentication-options

Request body

challengeIdstring

The ID of the challenge returned by Initiate Challenge. Only required if you want to customize the action code associated with the passkey sign-in.

usernamestring

If passed, will restrict the allowed credentials for the passkey sign-in to those associated with the given username. Recommended for when using passkeys for MFA or step-up authentication.

securePaymentConfirmationboolean

Request a Secure Payment Confirmation (SPC) ceremony for a 3-D Secure payment. When true, the response offers only payment-capable credentials and includes the payment transaction set server-side via track custom data.

Response

OK

challengeIdstring required

The ID of the passkey challenge. Should be passed back to the complete the challenge.

optionsobject required

The options for public key credential authentication, including rpId and challenge.

Changes

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