Skip to main content
Capgo logo
Back to plugins
@capgo/capacitor-native-biometric
Tutorial
by github.com/Cap-go

Native Biometric

Secure authentication using Face ID, Touch ID, and Android biometric APIs

Downloads/week

502.7k

GitHub Stars

71

Guide

Tutorial on Native Biometric

Using @capgo/capacitor-native-biometric

This plugin gives access to the native biometric apis for android and iOS.

Install

bun add @capgo/capacitor-native-biometric
bunx cap sync

What This Plugin Exposes

  • isAvailable - Checks if biometric authentication hardware is available.
  • verifyIdentity - Prompts the user to authenticate with biometrics.
  • getCredentials - Gets the stored credentials for a given server.
  • setCredentials - Stores the given credentials for a given server.

Example Usage

isAvailable

Checks if biometric authentication hardware is available.

import { NativeBiometric } from '@capgo/capacitor-native-biometric';

await NativeBiometric.isAvailable();

verifyIdentity

Prompts the user to authenticate with biometrics.

import { NativeBiometric } from '@capgo/capacitor-native-biometric';

await NativeBiometric.verifyIdentity();

getCredentials

Gets the stored credentials for a given server.

import { NativeBiometric } from '@capgo/capacitor-native-biometric';

await NativeBiometric.getCredentials({} as GetCredentialOptions);

setCredentials

Stores the given credentials for a given server.

import { NativeBiometric } from '@capgo/capacitor-native-biometric';

await NativeBiometric.setCredentials({} as SetCredentialOptions);

Full Reference