This guide will help you set up and run the React Native Face Match & ID Check Sample App, which demonstrates how to integrate Verisoul into a React Native application.

About the Sample App

The React Native Face Match & ID Check Sample App is a demonstration project that showcases a working Verisoul integration in a React Native environment.

Prerequisites

Before you begin, you’ll need:

  • Node.js and npm installed on your system
  • Git for cloning the repository
  • A Verisoul API Key (obtain this by scheduling a call)

Installation Steps

1. Clone the Repository

git clone https://github.com/verisoul/react-native-facematch-sample-app.git
cd react-native-facematch-sample-app

2. Configure API Key

Make sure to use the correct API key for the environment you are using:

let headers = {
    "x-api-key": "YOUR_API_KEY_HERE",
    "Content-Type": "application/json"
}

3. Install Dependencies

Install all required npm packages:

npm install

4. Run the Application

Start the app via Expo either on a simulator or a physical device:

npx expo start

ID Check Integration

To run the sample app with ID Check functionality, simply add the ?id=true parameter to the get session URL:

const faceAndIdSession = await fetch(`https://${API_URL}/liveness/session?id=true`, {
    method: 'GET',
    headers: headers,
})

What to Expect

Once running, you’ll see a demonstration of how Verisoul’s Face Match and ID Check work in a React Native environment.

Next Steps

After exploring the sample app, you can use it as a reference for implementing Verisoul in your own React Native applications.

For more detailed documentation, see the Verisoul Verification Guide.