Skip to main content
Fingerprint React Native is an official open-source library for projects written in React Native for iOS and Android platforms. This library allows developers to use Fingerprint capabilities in the React Native context. All Fingerprint agent capabilities are fully supported. View our React Native quickstart for a step-by-step guide to get started.

Requirements

The React Native SDK uses the Android and iOS SDKs under the hood, so it has the same minimum OS version requirements:
  • Android 5.0 (API level 21+) or higher
  • iOS 12 or higher (or tvOS 12 or higher), Swift 5.7 or higher
  • Expo SDK 51 or higher

How to install

To install with Expo, please see the repository’s Expo setup section.

1. Install the package using your favorite package manager:

2. Configure iOS dependencies (if developing on iOS)

3. Configure Android dependencies (if developing on Android)

Add the repositories to your Gradle configuration file. The location for these additions depends on your project’s structure and the Gradle version you’re using:

Gradle 7 or newer

For Gradle 7.0 and higher (if you’ve adopted the new Gradle settings file approach), you likely manage repositories in the dependencyResolutionManagement block in {rootDir}/android/settings.gradle. Add the Maven repositories in this block:
Groovy

Gradle 6.0 or older

For Gradle versions before 7.0, you likely have an allprojects block in {rootDir}/android/build.gradle. Add the Maven repositories within this block:
Groovy

Usage

Configure the SDK by wrapping your application in FingerprintJsProProvider.
JavaScript
Use the useVisitorData hook in your components to perform visitor identification and get the data.
JavaScript
To integrate outside of a React component, use the underlying API client directly.

Documentation

You can find the full documentation in the official GitHub repository.

Limitations

  • Fingerprint request filtering is not supported right now. Allowed and forbidden origins cannot be used.