handleRemovePasskey()

Package: react-wallet-kit

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

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

This function opens a modal with the RemovePasskey component, allowing the user to confirm and remove a passkey authenticator from their account.
It supports specifying the authenticator ID to remove, as well as optional modal title and subtitle for custom UI messaging.
After successful removal, the user details state is refreshed to reflect the updated list of authenticators.
Supports customizing the duration of the success page shown after removal.
Allows specifying the stamper to use for the removal (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet) for granular authentication control.
Handles all error cases and throws a TurnkeyError with appropriate error codes.

params

object

required

Show params details

params.authenticatorId

string

required

The ID of the authenticator (passkey) to remove.

params.stampWith

StamperType

parameter to specify the stamper to use for the removal (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet).

params.subTitle

string

subtitle for the modal.

params.successPageDuration

number

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

params.title

string

title for the modal.

params.userId

string

user ID to remove 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 an array of authenticator IDs that were removed.