Our facial recognition algorithm is globally top-ranked by NIST in the FRVT 1:1 leaderboards.

Latest NIST FRVT evaluation report 2024-12-20

🆔 ID Document Liveness Detection - Linux - Here

🤗 Hugging Face - Here

📚 Product & Resources - Here

🛟 Help Center - Here

💼 KYC Verification Demo - Here

🙋‍♀️ Docker Hub - Here

FaceRecognition-React-Native

Overview

This repository demonstrates both face liveness detection and face recognition technology for React-Native on Android and iOS platforms.

In this repository, we integrated KBY-AI's face liveness detection and face recognition technology into the React-Native project for both Android and iOS.

◾FaceSDK(Mobile) Details

Basic	🔽 Standard	Premium
Face Detection	Face Detection	Face Detection
Face Liveness Detection	Face Liveness Detection	Face Liveness Detection
Pose Estimation	Pose Estimation	Pose Estimation
	Face Recognition	Face Recognition
		68 points Face Landmark Detection
		Face Quality Calculation
		Face Occlusion Detection
		Eye Closure Detection
		Age, Gender Estimation

◾FaceSDK(Mobile) Product List

No.	Repository	SDK Details
1	Face Liveness Detection - Android	Basic SDK
2	Face Liveness Detection - iOS	Basic SDK
3	Face Recognition + Face Liveness Detection - Android	Standard SDK
4	Face Recognition + Face Liveness Detection - iOS	Standard SDK
5	Face Recognition + Face Liveness Detection - Flutter	Standard SDK
6	Face Recognition + Face Liveness Detection - Ionic-Cordova	Standard SDK
➡️	Face Recognition + Face Liveness Detection - React-Native	Standard SDK
8	Face Attribute - Android	Premium SDK
9	Face Attribute - iOS	Premium SDK
10	Face Attribute - Flutter	Premium SDK

To get Face SDK(server), please visit products here.

Try with Demo App

Google Play

App Store

Performance Video

You can visit our YouTube video here to see how well our demo app works.

Screenshots

SDK License

The face recognition project relies on KBY-AI's SDK, which requires a license for each application ID.

• The code below shows how to use the license:

  FaceRecognition-React-Native/example/src/MainPage.tsx

  Lines 17 to 34 in 170b598

  	const initSDKAsync = async () => {
  	try {
  	if(Platform.OS == 'ios') {
  	var ret = await FaceSDKModule.setActivation("JT0eKB2YoRpN67t6Uu820HQFN2mGBmxcKdimmBw05PBmGB1avf0impc0g+VomsgQ7DemNOdQ56bp" +
  	"2CaQmkE2b8nXxq+YTcbSNXEap0ds1kfRHS4R4tn/RHobGfaR97TPuLg+xP3Fn7Xro5xNjI1TiC50" +
  	"SPEfFAgiu+mbQKMaTHxiTSEqQkIDtbAHpiqxip/vZFKyby+/uYTZkaaLVleC8EeA4UEl2TNxQLS5" +
  	"eChxPQU/N9HIS/zij4ABeLpD8vbjq+EFptOE7guRbbdzpUHQwQ12eifCmCZZJhXFsIQR3WLWC9kR" +
  	"mWaKZhqYIXSz87+wfcHH5PhwL3CkN+0d9i5fNg==");
  	console.log("set activation:", ret);
  	} else {
  	var ret = await FaceSDKModule.setActivation("YeakDoPY+pf4Nf9Qx0efEuHfBnbJj5AxLpY20YbRJJ6/KQBclaIC/rqz9emhT/BpyurD/HXU6ezU" +
  	"fkJmn3P0yrStJtotgUOcC6+Nvpstm3HPRlHIIo1nTNQC1SJoEXvowPwkdvZrA+pFtzlZmPoQs4Jc" +
  	"byvCRU/MzCICAV+2unCZdfIBNa1Qbfkv1VJ9dPUpX6hAFjyuU6gCLJhE5Xg1TeLB/1KMrR3kU5rd" +
  	"uwOO+rOF3Hi1mFZBKI6HSLgCbEkYVNJTpeatsaBKcoN3hIPR7dNU54ICsHA6DyumTCVU31Pz+EGX" +
  	"gFdvq10c80LqcRPzScJjhTHm9in4m2VtQXA/Qw==");
  	console.log("set activation:", ret);
  	}

• To request a license, please contact us:
  🧙Email: contact@kby-ai.com
  🧙Telegram: @kbyaisupport
  🧙WhatsApp: +19092802609
  🧙Discord: KBY-AI
  🧙Teams: KBY-AI
  

How To Run

1. Setting Up React-Native Development Environment

Make sure you have React-Native installed.
If you don't have React-Native installed, please follow the instructions provided in the official React-Native documentation here.

2. Running the Android App

Run the following commands:

yarn
cd example
yarn
yarn android

Or you can run build by npm instead of yarn as follows:

npm i
cd example
npm i
npx react-native run-android

3. Running the iOS App

Run the following commands:

yarn
cd example
yarn
cd ios
pod install
cd ..
yarn ios

Please open the FaceRecognitionSdkExample.xcworkspace in Xcode and run the app. Or you can build project by npm instead of yarn as follows:

npm i
cd example
npm i
cd ios
pod install
cd ..
npx react-native run-ios

About SDK

1. Setup

1.1 Setting Up Face SDK

Android

• Copy the SDK (folder: libfacesdk) to the folder android in your project path.
  
• Add the SDK to the project in settings.gradle

include ':libfacesdk'

2 API Usages

2.1 FaceSDKModule

• Activate the FaceSDKModule by calling the setActivation method:

      var ret = await FaceSDKModule.setActivation("...");
      console.log("set activation:", ret);

• Initialize the FaceSDKModule by calling the initSDK method:

    var ret = await FaceSDKModule.initSDK();

• Set parameters using the setParam method:

  var ret = await FaceSDKModule.setParam(checkLivenessLevel);

• Extract faces using the extractFaces method:

  var faceBoxes = await FaceSDKModule.extractFaces(uri);

• Calculate the similarity between faces using the similarityCalculation method:

  const similarity = await FaceSDKModule.similarityCalculation(
      face.templates,
      person.templates
  );

2.2 FaceRecognitionSdkView

• To build the native camera screen and process face detection, please refer to the example/src/FaceRecognitionPage.tsx file in the repository.

  <FaceRecognitionSdkView style={styles.box} livenessLevel={1} cameraLens={1} />

• To obtain the face detection results, use the following code:

      const eventEmitter = new NativeEventEmitter(FaceSDKModule);
      let eventListener = eventEmitter.addListener('onFaceDetected', (event) => {
          setFaces(event);
          if (recognized == false) {
              identifyPerson(event);
          }
      });

• To start and stop the camera, use the following code:

    //Start Camera
    const startCamera = async () => {
        await FaceSDKModule.startCamera();
    }

    //Stop Camera
    const stopCamera = async () => {
        await FaceSDKModule.stopCamera();
    }