{"id":18498784,"url":"https://github.com/smallcase/react-native-simple-biometrics","last_synced_at":"2025-05-15T20:04:12.032Z","repository":{"id":40560190,"uuid":"337110905","full_name":"smallcase/react-native-simple-biometrics","owner":"smallcase","description":"simple interface to verify user authenticity","archived":false,"fork":false,"pushed_at":"2025-03-07T05:54:21.000Z","size":3929,"stargazers_count":212,"open_issues_count":7,"forks_count":19,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-05-08T03:37:36.919Z","etag":null,"topics":["android","authentication","biometrics","faceid","fingerprint","ios","react-native"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/react-native-simple-biometrics","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/smallcase.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-02-08T14:57:00.000Z","updated_at":"2025-05-05T04:01:24.000Z","dependencies_parsed_at":"2024-06-21T13:01:48.917Z","dependency_job_id":"12f1109d-561f-4b25-81b9-f2a6e36ea063","html_url":"https://github.com/smallcase/react-native-simple-biometrics","commit_stats":{"total_commits":53,"total_committers":4,"mean_commits":13.25,"dds":0.09433962264150941,"last_synced_commit":"f743291453530c806fa6645d5499ba72c186ad72"},"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smallcase%2Freact-native-simple-biometrics","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smallcase%2Freact-native-simple-biometrics/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smallcase%2Freact-native-simple-biometrics/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smallcase%2Freact-native-simple-biometrics/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/smallcase","download_url":"https://codeload.github.com/smallcase/react-native-simple-biometrics/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254414498,"owners_count":22067272,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["android","authentication","biometrics","faceid","fingerprint","ios","react-native"],"created_at":"2024-11-06T13:42:35.672Z","updated_at":"2025-05-15T20:04:09.217Z","avatar_url":"https://github.com/smallcase.png","language":"Java","readme":"# React Native Simple Biometrics\n\n![npm](https://img.shields.io/npm/v/react-native-simple-biometrics?color=%231F7AE0)\n\n## Overview\n\nReact Native Simple Biometrics is a straightforward and minimalistic React Native package designed to provide developers with an API for implementing user authentication using on-device biometrics. This library facilitates the quick verification of the app's user, ensuring that sensitive information is only accessible to authorized individuals, such as the phone owner or a trustee.\n\n![demo](./demo.gif?raw=true \"demo\")\n\n## Installation\n\nTo get started with React Native Simple Biometrics, you can add it to your project using Yarn:\n\n```bash\n$ yarn add react-native-simple-biometrics\n```\n\n## Minimum Requirements\n\n- iOS target: `8.0`\n- Android minSdkVersion: `21`\n\n## iOS Permission\n\nTo utilize the Face ID system on iOS devices, it is mandatory to include an entry in your iOS app's `info.plist`, explaining the valid reason for using biometrics:\n\n```xml\n\u003ckey\u003eNSFaceIDUsageDescription\u003c/key\u003e\n\u003cstring\u003ea valid reason to use biometrics\u003c/string\u003e\n```\n\nWhen you call the `authenticate` function, iOS users will be automatically prompted for permission. For more granular control over when to request permissions, you can utilize the [react-native-permissions](https://www.npmjs.com/package/react-native-permissions) package.\n\n## Usage\n\nReact Native Simple Biometrics offers two main methods:\n\n1. `canAuthenticate()`: Checks whether the device supports biometric authentication. Returns `true` if the hardware is available or if permission for Face ID (iOS) was granted.\n\n2. `requestBioAuth(promptTitle: string, promptMessage: string)`: Initiates the biometric authentication process, displaying a user-friendly prompt with the specified title and message. This function can be used for user authentication.\n\nHere's a code snippet demonstrating how to use these methods:\n\n```javascript\nimport RNBiometrics from \"react-native-simple-biometrics\";\n\n// Check if biometric authentication is available\nconst can = await RNBiometrics.canAuthenticate();\n\nif (can) {\n  try {\n    await RNBiometrics.requestBioAuth(\"prompt-title\", \"prompt-message\");\n    // Code to execute when authenticated\n    // ...\n  } catch (error) {\n    // Code to handle authentication failure\n    // ...\n  }\n}\n```\n\n## Credits\n\nReact Native Simple Biometrics is a simplified version of [react-native-biometrics](https://www.npmjs.com/package/react-native-biometrics). If you require advanced features such as key generation, signatures, and more, consider using react-native-biometrics.","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmallcase%2Freact-native-simple-biometrics","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsmallcase%2Freact-native-simple-biometrics","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmallcase%2Freact-native-simple-biometrics/lists"}