@caf.io/react-native-face-authenticator v1.3.0

About

The @caf.io/react-native-face-authenticator library is a powerful tool for integrating facial liveness detection functionality into React Native applications. It allows developers to easily incorporate live facial verification, adding an extra layer of security and authentication.

Minimum Requirements

Android

iOS

Getting Started

yarn add @caf.io/react-native-face-authenticator
# or 
npm install @caf.io/react-native-face-authenticator

Usage

import React from 'react';
import { View, Button, StyleSheet } from 'react-native';
import { 
  startFaceAuthenticator,
  useFaceAuthenticator, 
  FaceAuthenticatorOptions, 
  Stage, 
  Filter, 
  Time 
} from '@caf.io/react-native-face-authenticator';

export default function App() {
  const mobileToken: string = "";
  const peopleId: string = "";

  const options: FaceAuthenticatorOptions = {
    cafStage: Stage.PROD,
    filter: Filter.NATURAL,
    imageUrlExpirationTime: Time.THREE_HOURS,
    enableScreenshots: true,
    loadingScreen: true
  } // optional

  const { 
    result, 
    error, 
    cancelled, 
    isLoading 
  } = useFaceAuthenticator(options);

  return (
    <View style={styles.container}>
      <Button 
        title="Press" 
        onPress={() => startFaceAuthenticator(mobileToken, peopleId)} 
      />
    </View>
  );
} 

const styles = StyleSheet.create({
  container: {
    flex: 1,
    alignItems: 'center',
    justifyContent: 'center',
  },
});

Methods

startFaceAuthenticator

This method inicialize the face authenticator.

Params

Hooks

useFaceAuthenticator

This hook provides the responses of method startFaceAuthenticator and make the settings for face authenticator.

Params

Responses

FaceAuthenticatorResponse

Types

FaceAuthenticatorResult

signedResponse params

FaceAuthenticatorError

FaceAuthenticatorResponse

FaceAuthenticatorOptions

Enums

Stage

Filter

Time

Error