Use biometrics confirm device owner presence or authenticate users. A couple of methods are provided to handle user credentials. These are securely stored using Keychain (iOS) and Keystore (Android).

A free, comprehensive biometric authentication plugin with secure credential storage:

• All biometric types - Face ID, Touch ID, Fingerprint, Face Authentication, Iris
• Secure credential storage - Keychain (iOS) and Keystore (Android) integration
• Flexible fallback - Optional passcode fallback when biometrics unavailable
• Customizable UI - Full control over prompts, titles, descriptions, button text
• Detailed error codes - Unified error handling across iOS and Android
• Modern package management - Supports both Swift Package Manager (SPM) and CocoaPods (SPM-ready for Capacitor 8)

Perfect for banking apps, password managers, authentication flows, and any app requiring secure user verification.

The most complete doc is available here: https://capgo.app/docs/plugins/native-biometric/

• npm i @capgo/capacitor-native-biometric

import { NativeBiometric, BiometryType } from "@capgo/capacitor-native-biometric";

async performBiometricVerification(){
  const result = await NativeBiometric.isAvailable();

  if(!result.isAvailable) return;

  const isFaceID = result.biometryType == BiometryType.FACE_ID;

  const verified = await NativeBiometric.verifyIdentity({
    reason: "For easy log in",
    title: "Log in",
    subtitle: "Maybe add subtitle here?",
    description: "Maybe a description too?",
  })
    .then(() => true)
    .catch(() => false);

  if(!verified) return;

  const credentials = await NativeBiometric.getCredentials({
    server: "www.example.com",
  });
}

// Save user's credentials
NativeBiometric.setCredentials({
  username: "username",
  password: "password",
  server: "www.example.com",
}).then();

// Delete user's credentials
NativeBiometric.deleteCredentials({
  server: "www.example.com",
}).then();

This is a plugin specific list of error codes that can be thrown on verifyIdentity failure, or set as a part of isAvailable. It consolidates Android and iOS specific Authentication Error codes into one combined error list.

• isAvailable(...)
• verifyIdentity(...)
• getCredentials(...)
• setCredentials(...)
• deleteCredentials(...)
• isCredentialsSaved(...)
• getPluginVersion()
• Interfaces
• Enums

isAvailable(options?: IsAvailableOptions | undefined) => Promise<AvailableResult>

Checks if biometric authentication hardware is available.

Returns: Promise<AvailableResult>

Since: 1.0.0

verifyIdentity(options?: BiometricOptions | undefined) => Promise<void>

Prompts the user to authenticate with biometrics.

Since: 1.0.0

getCredentials(options: GetCredentialOptions) => Promise<Credentials>

Gets the stored credentials for a given server.

Returns: Promise<Credentials>

Since: 1.0.0

setCredentials(options: SetCredentialOptions) => Promise<void>

Stores the given credentials for a given server.

Since: 1.0.0

deleteCredentials(options: DeleteCredentialOptions) => Promise<void>

Deletes the stored credentials for a given server.

Since: 1.0.0

isCredentialsSaved(options: IsCredentialsSavedOptions) => Promise<IsCredentialsSavedResult>

Checks if credentials are already saved for a given server.

Returns: Promise<IsCredentialsSavedResult>

Since: 7.3.0

getPluginVersion() => Promise<{ version: string; }>

Get the native Capacitor plugin version.

Returns: Promise<{ version: string; }>

Since: 1.0.0

Result from isAvailable() method indicating biometric authentication availability.

To use FaceID Make sure to provide a value for NSFaceIDUsageDescription, otherwise your app may crash on iOS devices with FaceID.

This value is just the reason for using FaceID. You can add something like the following example to App/info.plist:

<key>NSFaceIDUsageDescription</key>
<string>For an easier and faster log in.</string>

To use android's BiometricPrompt api you must add the following permission to your AndroidManifest.xml:

<uses-permission android:name="android.permission.USE_BIOMETRIC">

Jonthia QliQ.dev Brian Weasner Mohamed Diarra

Learn about contributing HERE

Hasn't been tested on Android API level 22 or lower.