Fingerprint Pro React Native

Fingerprint is a device intelligence platform offering industry-leading accuracy.
Fingerprint Pro React Native SDK is an easy way to integrate Fingerprint Pro into your React Native
application to call the native Fingerprint Pro libraries (Android and iOS) and identify devices.

Table of contents

- Fingerprint Pro React Native
- Table of contents
- Requirements and limitations
- Dependencies
- How to install
- Expo setup
- 1. Add config plugin
- 2. Rebuild the native code
- 3. Rebuild the app
- Bare react-native
- 1. Configure iOS dependencies (if developing on iOS)
- 2. Configure Android dependencies (if developing on Android)
- Gradle 7 or newer
- Gradle 6.0 or older
- Usage
- Hooks approach
- API Client approach
- extendedResponseFormat
- Linking and tagging information
- API Reference
- Additional Resources
- Support and feedback
- License

Requirements and limitations

- React Native versions 0.73 through 0.81 are supported
- Expo 51.0.0 or higher is supported
- Android 6.0 (API level 23+) or higher
- iOS 13+/tvOS 15+, Swift 5.9 or higher (stable releases)

- Fingerprint Pro request filtering is not supported right now. Allowed and forbidden origins cannot be used.
- Usage inside the Expo environment is not supported right now.

Dependencies

- Fingerprint Pro iOS
- Fingerprint Pro Android

How to install

Install the package using your favorite package manager:

- NPM:

``shell
npm install @fingerprintjs/fingerprintjs-pro-react-native --save
`

- Yarn:

`shell
yarn add @fingerprintjs/fingerprintjs-pro-react-native
`

- PNPM:
`shell
pnpm add @fingerprintjs/fingerprintjs-pro-react-native
`



Expo setup

> ℹ️ Our SDK cannot be used in Expo Go because it requires custom native code.

Web support

To use the SDK on the web, install the peer dependency with your preferred package manager:

- NPM:

`shell
npm install @fingerprintjs/fingerprintjs-pro-spa --save
`

- Yarn:

`shell
yarn add @fingerprintjs/fingerprintjs-pro-spa
`

- PNPM:
`shell
pnpm add @fingerprintjs/fingerprintjs-pro-spa
`

Then, use the SDK as you would with the native version.


$3


`json
{
"expo": {
"plugins": [
"@fingerprintjs/fingerprintjs-pro-react-native"
]
}
}
`

$3

`bash
npx expo prebuild --clean
`

$3

For Android:
`bash
npx expo run:android
`

For iOS:
`bash
npx expo run:ios
`



Bare react-native setup

$3

`shell
cd ios && pod install
`

$3

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
dependencyResolutionManagement {
repositoriesMode.set(RepositoriesMode.PREFER_SETTINGS)
repositories {
google()
mavenCentral()
maven {
url("https://maven.fpregistry.io/releases") // Add this
}
}
}
`

#### 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
allprojects {
repositories {
mavenCentral()
mavenLocal()
maven {
// All of React Native (JS, Obj-C sources, Android binaries) is installed from npm
url("$rootDir/../node_modules/react-native/android")
}
maven {
// Android JSC is installed from npm
url("$rootDir/../node_modules/jsc-android/dist")
}
maven {
url("https://maven.fpregistry.io/releases") // Add this
}
google()
}
}
`

Usage

To identify visitors, you need a Fingerprint Pro account (you can sign up for free).

- Go to the Fingerprint Pro dashboard.
- Open App Settings > API Keys to find your Public API key.

$3

Configure the SDK by wrapping your application in FingerprintJsProProvider.

`javascript
// src/index.js
import React from 'react';
import { AppRegistry } from 'react-native';
import { FingerprintJsProProvider } from '@fingerprintjs/fingerprintjs-pro-react-native';
import App from './App';
import { name as appName } from './app.json';

const WrappedApp = () => (



)

AppRegistry.registerComponent(appName, () => WrappedApp);
`

Use the useVisitorData hook in your components to perform visitor identification and get the data.

`javascript
// src/App.js
import React from 'react'
import {Button, SafeAreaView, Text, View} from 'react-native'
import {useVisitorData} from '@fingerprintjs/fingerprintjs-pro-react-native'

export default function App() {
const {isLoading, error, data, getData} = useVisitorData()

return (


getData()} />
{isLoading ? (
Loading...
) : (
<>
VisitorId: {data?.visitorId}
Full visitor data:
{error ? error.message : JSON.stringify(data, null, 2)}

)}


)
}
`

$3

`javascript
import React, { useEffect } from 'react';
import { FingerprintJsProAgent } from '@fingerprintjs/fingerprintjs-pro-react-native';

// ...

useEffect(() => {
async function getVisitorInfo() {
try {
const FingerprintClient = new FingerprintJsProAgent({ apiKey: 'PUBLIC_API_KEY', region: 'eu' }); // Region may be 'us', 'eu', or 'ap'
const visitorId = await FingerprintClient.getVisitorId(); // Use this method if you need only visitorId
const visitorData = await FingerprintClient.getVisitorData(); // Use this method if you need additional information about visitor
// use visitor data in your code
} catch (e) {
console.error('Error: ', e);
}
}
getVisitorInfo();
}, []);
`

$3

Two types of responses are supported: "default" and "extended". You don't need to pass any parameters to get the "default" response.
"Extended" is an extended result format that includes geolocation, incognito mode and other information.
It can be requested using the extendedResponseFormat: true parameter. See more details about the responses in the documentation.

Providing extendedResponseFormat using hooks:

`javascript
return (



)
`

Providing extendedResponseFormat using the API Client:

`javascript
const FingerprintClient = new FingerprintJsProAgent({
apiKey: 'PUBLIC_API_KEY',
region: 'eu',
extendedResponseFormat: true,
})
`

$3

The visitorId provided by Fingerprint Identification is especially useful when combined with information you already know about your users, for example, account IDs, order IDs, etc. To learn more about various applications of the linkedId and tag, see Linking and tagging information.

`javascript
const tag = {
userAction: 'login',
analyticsId: 'UA-5555-1111-1'
};
const linkedId = 'user_1234';

// Using hooks
const { getData } = useVisitorData();
const visitorData = await getData(tag, linkedId);

// Using the client
const FingerprintClient = new FingerprintJsProAgent({ apiKey: 'PUBLIC_API_KEY'});
const visitorId = await FingerprintClient.getVisitorId(tag, linkedId);
const visitor = await FingerprintClient.getVisitorData(tag, linkedId);
`

$3

Proximity detection is a complementary, location-based signal available only on mobile platforms.
You can find more information in Android SDK documentation or in
iOS SDK documentation.

The Fingerprint SDK will only collect location data if the allowUseOfLocationData option is set to true.

`javascript
return (



)
`

For Android platform it's possible to configure the location retrieval timeout by setting the locationTimeoutMillisAndroid option to a desired value. By default, it's set to 5 seconds.
The SDK will delay identification up to the specified timeout to collect the device location. If it cannot collect the location information within the specified time, identification continues without location information.

`javascript
return (



)
`

API Reference

See the full generated API Reference.

Additional Resources

- Server-to-Server API
- Fingerprint Pro documentation

Support and feedback

To report problems, ask questions or provide feedback, please
use Issues. If you need private support,
please email us at oss-support@fingerprint.com`.

License

This project is licensed under the MIT license.