8000 docs: biometrics (#633) · NativeScript/plugins@6201be1 · GitHub
[go: up one dir, main page]

Skip to content

Commit 6201be1

Browse files
authored
docs: biometrics (#633)
1 parent 7327e86 commit 6201be1

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

packages/biometrics/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,13 @@ A plugin that allows you to authenticate users with biometrics, such as fingerpr
2323
> **Note**
2424
This plugin replaces [@nativescript/fingerprint-auth](../fingerprint-auth).
2525

26+
### Prerequisites:
27+
Before you can verify a user’s biometrics, the device must already have biometric data (such as fingerprints or a face scan) enrolled at the system level. This enrollment is handled by the device’s operating system settings—your app or this plugin does not capture or store biometric data directly. Users must set up biometrics through their device’s security settings (e.g., `Settings` > `Security` > `Biometrics` on Android, or `Settings` > `Face ID` & `Passcode` on iOS).
28+
29+
### How it works:
30+
When you call the plugin’s verification methods, the plugin asks the operating system to prompt the user for their enrolled biometric (fingerprint, face, etc.) and returns the result. The plugin never sees or manages the actual biometric data—only the OS does.
31+
32+
2633
## Installation
2734

2835
```cli

0 commit comments

Comments
 (0)
0