Provides an API for FaceID and TouchID (iOS) or the Fingerprint API (Android) to authenticate the user with a face or fingerprint scan.
API documentation
Installation in managed Expo projects
For managed Expo projects, please follow the installation instructions in the API documentation for the latest stable release.
Installation in bare React Native projects
For bare React Native projects, you must ensure that you have installed and configured the expo
package before continuing.
Add the package to your npm dependencies
npx expo install expo-local-authentication
Configure for Android
No additional set up necessary.
This module requires permissions to access the biometric data for authentication purposes. The USE_BIOMETRIC
and USE_FINGERPRINT
permissions are automatically added.
<uses-permission android:name="android.permission.USE_BIOMETRIC" />
<uses-permission android:name="android.permission.USE_FINGERPRINT" />
Configure for iOS
Run npx pod-install
after installing the npm package.
Add NSFaceIDUsageDescription
to your Info.plist
:
<key>NSFaceIDUsageDescription</key>
<string>Allow $(PRODUCT_NAME) to use FaceID</string>
Contributing
Contributions are very welcome! Please refer to guidelines described in the contributing guide.