Skip to main content

isAvailable

Resolves { available, supportsFaceId, supportsFingerprint }.

authenticate

string
Text shown in the system prompt.
string
Cancel button label.
string
Label of the device passcode fallback.
boolean
default:"false"
Disallow falling back to the device passcode.
Resolves { success, error? }.
Biometrics is shell-only. In a browser, isAvailable resolves available: false and authenticate resolves success: false, error: 'not_available'. For sign-in or signing that also works in a browser, use passkeys.
Functions: checkBiometricsAvailable, authenticateBiometrics.