Capacitor Face ID Plugin

Allow users to authenticate with Face ID or Touch ID on iOS devices

Installation

npm install capacitor-face-id

iOS Notes

iOS requires the following usage description be added and filled out for your app in Info.plist:

Name: Privacy - Face ID Usage Description Key: NSFaceIDUsageDescription

Example

import { Plugins, PluginResultError } from '@capacitor/core';

const { FaceId } = Plugins;

...
// check if device supports Face ID or Touch ID
FaceId.isAvailable().then(checkResult => {
  if(checkResult.value) {
    FaceId.auth().then(() => {
      console.log('authenticated');
    }).catch((error: PluginResultError) => {
      // handle rejection errors
      console.error(error.message);
    });
  } else {
    // use custom fallback authentication here
  }
});

API

| Method | Default | Type | Description | | --------------------------------- | --------------------------------------------------- | ---------------------------- | ------------------------------------------------------------------- | | isAvailable() | | Promise<{ value: string }> | Checks if Face ID or Touch ID is available, and returns type if so. | | auth(options?: {reason?: string}) | options: {reason: "Access requires authentication"} | Promise<void> | Displays the Face ID or Touch ID screen |