addPasskey() - Turnkey

Adds a new passkey authenticator for the user.

This function prompts the user to create a new passkey (WebAuthn/FIDO2) and adds it as an authenticator for the user.
Handles both web and React Native environments, automatically selecting the appropriate passkey creation flow.
If a userId is provided, the passkey is added for that specific user; otherwise, it uses the current session’s userId.
The passkey’s name and display name can be customized; if not provided, defaults are generated.
The resulting passkey attestation and challenge are registered with Turnkey as a new authenticator.

Package: core

Defined in: core.ts:3141

params

object

Show params details

params.displayName

string

display name of the passkey (defaults to the value of name).

params.name

string

name of the passkey (defaults to “Turnkey Passkey-timestamp”).

params.stampWith

StamperType

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

params.userId

string

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

A successful response returns the following fields:

returns

string[]

required

A promise that resolves to an array of authenticator IDs for the newly added passkey(s).