Skip to content

React Native

This is a React Native-specific Face SDK installation guide. Before proceeding further, make sure you've read the Installation page and have selected the Core type to install.


  • For iOS, the minimum target is iOS 11.0
  • For Android, the minimum Android API level is 21


The Face SDK is available on npm.

1. Run the following command to add the SDK to the project:

npm install @regulaforensics/react-native-face-api
npm install @regulaforensics/react-native-face-core-basic
npm install @regulaforensics/react-native-face-api
npm install @regulaforensics/react-native-face-core-match

2. Add the following configuration into android section of your android/app/build.gradle:

    aaptOptions {
        noCompress "Regula/faceSdkResource.dat"

Import the Face SDK

You should now be able to import face_api:

import FaceSDK from '@regulaforensics/react-native-face-api';


You can always use our demo application on GitHub.

Next Step