handleAddPasskey()

Package: react-wallet-kit

Defined in: react-wallet-kit/src/providers/client/Types.tsx:621

Handles the addition of a passkey (authenticator) for the user.

This function opens a modal-driven flow for adding a new passkey authenticator (WebAuthn/FIDO2) to the user’s account.
If a name or displayName is provided, those will be used for the passkey metadata; otherwise, defaults are generated based on the website and timestamp.
The passkey is created and linked to the specified user (by userId) or the current session’s user if not provided.
After successful addition, a success page is shown for the specified duration (or skipped if successPageDuration is 0).
Supports stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet) for granular authentication control.
Automatically refreshes the user details state after successful addition to ensure the latest authenticators list is available in the provider.
Handles all error cases and throws a TurnkeyError with appropriate error codes.

params

object

Show params details

params.displayName

string

display name for the passkey (shown to the user in the UI).

params.name

string

internal name for the passkey (for backend or developer reference).

params.stampWith

StamperType

parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet).

params.successPageDuration

number

duration (in ms) for the success page after addition (default: 0, no success page).

params.userId

string

user ID to add the passkey for a specific user (defaults to current session’s userId).

A successful response returns the following fields:

returns

string[]

required

A promise that resolves to the user’s updated passkeys.