Sign in
Passkeys

Generate Registration Options

Generate options to register a new passkey.

post/user-authenticators/passkey/registration-options

Request body

usernamestring

The username which uniquely identifies the user, e.g. email address. Will be inferred from an existing user identifier if not passed.

displayNamestring

An additional identifier which will be displayed to the user to help them recognize the passkey.

authenticatorAttachment'platform' | 'cross-platform' nullable

The preferred authenticator type. Set to platform for the device authenticator, cross-platform for a roaming authenticator, or null to let the user choose.

securePaymentConfirmationboolean

Register a Secure Payment Confirmation (SPC) credential for use in 3-D Secure payments. When true, Authsignal forces a platform authenticator with required user verification and the WebAuthn payment extension, and marks the stored credential payment-capable.

instrumentDisplayNamestring

An optional payment instrument label (e.g. "Visa ••1234") persisted against an SPC credential and shown in future payment dialogs. Only applies when securePaymentConfirmation is true.

Response

OK

challengeIdstring required

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

optionsobject required

The options for public key credential creation, based on https://w3c.github.io/webauthn/#dictdef-publickeycredentialcreationoptionsjson.

Changes

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