A Capacitor plugin providing comprehensive access to native biometric authentication APIs on iOS, Android, and web.
capacitor-biometric-auth is a Capacitor plugin that provides a unified JavaScript API for accessing native biometric authentication systems on iOS and Android, including Touch ID, Face ID, fingerprint, face, and iris recognition. It solves the problem of securely authenticating users in cross-platform mobile apps while handling platform differences, device credential fallbacks, and availability changes. The plugin also includes a web simulator to test authentication logic without native hardware.
Mobile developers building cross-platform apps with Capacitor who need to integrate secure, native biometric authentication with support for iOS, Android, and web testing scenarios.
Developers choose this plugin for its comprehensive platform coverage, detailed error handling, and ability to simulate biometrics on the web—enabling consistent authentication logic across all platforms without sacrificing native capabilities or requiring extensive platform-specific code.
Easy access to native biometric auth APIs on iOS and Android
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.
Offers a single, type-safe JavaScript interface for iOS and Android biometric systems, reducing the need for platform-specific code while exposing native nuances.
Provides comprehensive CheckBiometryResult with error codes and reasons, plus app resume listeners to dynamically track biometry status changes.
Allows fine-tuning of authentication prompts via AuthenticateOptions, including titles, subtitles, and biometry strength, tailored to each platform's capabilities.
Includes methods like setBiometryType() to simulate any biometric type and enrollment state on web, enabling full authentication flow testing without native hardware.
The README admits Android's biometry support is 'a bit of a mess,' with hardware types not always usable by apps, forcing reliance on isAvailable flags over biometryType.
Requires adding NSFaceIDUsageDescription to Info.plist for Face ID, an extra manual step that can be overlooked and cause runtime failures.
Notes 'somewhat incomplete auto-generated documentation' in the README, which may hinder developers seeking detailed guidance for advanced use cases.
Lists multiple breaking changes across versions, such as requiring Capacitor 8+ and altered method behaviors, complicating upgrades and maintenance.