@capgo/capacitor-native-biometric
This plugin gives access to the native biometric apis for android and iOS.
Overview
Section titled “Overview”This plugin gives access to the native biometric apis for android and iOS.
Core Capabilities
Section titled “Core Capabilities”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.
Public API
Section titled “Public API”| Method | Description |
|---|---|
isAvailable | Checks if biometric authentication hardware is available. |
addListener | Adds a listener that is called when the app resumes from background. This is useful to detect if biometry availability has changed while the app was in the background (e.g., user enrolled/unenrolled biometrics). |
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. |
deleteCredentials | Deletes the stored credentials for a given server. |
getSecureCredentials | Gets the stored credentials for a given server, requiring biometric authentication. Credentials must have been stored with accessControl set to BIOMETRY_CURRENT_SET or BIOMETRY_ANY. |
isCredentialsSaved | Checks if credentials are already saved for a given server. |
getPluginVersion | Get the native Capacitor plugin version. |
Source Of Truth
Section titled “Source Of Truth”This reference is synced from src/definitions.ts in capacitor-native-biometric.
Keep going from @capgo/capacitor-native-biometric
Section titled “Keep going from @capgo/capacitor-native-biometric”If you are using @capgo/capacitor-native-biometric to plan authentication and account flows, connect it with Using @capgo/capacitor-native-biometric for the native capability in Using @capgo/capacitor-native-biometric, @capgo/capacitor-social-login for the implementation detail in @capgo/capacitor-social-login, @capgo/capacitor-passkey for the implementation detail in @capgo/capacitor-passkey, Two-factor authentication for the implementation detail in Two-factor authentication, and SSO (Enterprise) for the implementation detail in SSO (Enterprise).