fingerprintjs
</picture>
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
Requirements and limitations
- React Native versions 0.73 through 0.79 are supported
- Android 5.0 (API level 21+) or higher
iOS 13+/tvOS 15+, Swift 5.7 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
How to install
1. Install the package using your favorite package manager:
NPM:
npm install @fingerprintjs/fingerprintjs-pro-react-native --saveYarn:
yarn add @fingerprintjs/fingerprintjs-pro-react-nativePNPM:
pnpm add @fingerprintjs/fingerprintjs-pro-react-native
2. Configure iOS dependencies (if developing on iOS)
cd ios && pod install3. 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:
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:
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.
Hooks approach
Configure the SDK by wrapping your application in FingerprintJsProProvider.
// 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 = () => (
<FingerprintJsProProvider apiKey={'your-fpjs-public-api-key'} region={'eu'}>
<App />
</FingerprintJsProProvider>
)
AppRegistry.registerComponent(appName, () => WrappedApp);Use the useVisitorData hook in your components to perform visitor identification and get the data.
// 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 (
<SafeAreaView>
<View style={{ margin: 8 }}>
<Button title='Reload data' onPress={() => getData()} />
{isLoading ? (
<Text>Loading...</Text>
) : (
<>
<Text>VisitorId: {data?.visitorId}</Text>
<Text>Full visitor data:</Text>
<Text>{error ? error.message : JSON.stringify(data, null, 2)}</Text>
</>
)}
</View>
</SafeAreaView>
)
}API Client approach
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();
}, []);extendedResponseFormat
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:
return (
<FingerprintJsProProvider apiKey={PUBLIC_API_KEY} extendedResponseFormat={true}>
<App />
</FingerprintJsProProvider>
)Providing extendedResponseFormat using the API Client:
const FingerprintClient = new FingerprintJsProAgent({
apiKey: 'PUBLIC_API_KEY',
region: 'eu',
extendedResponseFormat: true,
})Linking and tagging information
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.
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); API Reference
See the full generated API Reference.
Additional Resources
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.