This guide will help you quickly implement Face Match verification in your application. The entire process takes just a few minutes to set up.

To run the app a Verisoul API Key is required. Schedule a call to get started.

​
Get Started

1

Fetch a Face Match session

Use your Verisoul API Key to create a new Face Match session:

curl --location 'https://api.sandbox.verisoul.ai/liveness/session' \
--header 'x-api-key: {VERISOUL_API_KEY}'

This will return a session_id that you’ll need for the next steps.

2

Navigate to Face Match

Direct your user to the Face Match verification page in any browser:

https://app.sandbox.verisoul.ai?session_id={VERISOUL_SESSION_ID}

The user will complete a quick verification process that includes taking a selfie video and completing liveness checks.

3

Use Verisoul API to Enroll the session

Tie the completed session to a unique account identifier:

curl --location 'https://api.sandbox.verisoul.ai/liveness/enroll' \
--header 'Content-Type: application/json' \
--header 'x-api-key: {VERISOUL_API_KEY}' \
--data '{
    "session_id": "{VERISOUL_SESSION_ID}",
    "account_id": "facematch-quickstart-account"
}'

Replace facematch-quickstart-account with your actual user’s unique identifier.

​
That’s it!

Now you can navigate to the Face Match dashboard to see a record of your session.

​
Alternative Testing Option

If you prefer to quickly test Face Match with some users, we offer a Public Redirect endpoint that doesn’t require a full integration.

This endpoint provides a public URL that you can share with test users. Please note that this is not the recommended integration method and is intended only for temporary testing purposes. Since the redirect link is completely public, users can share it with others, which may lead to increased costs.

For more details on this endpoint, see our API Reference.

​
Next Steps

Integration Guide

Detailed instructions for integrating Face Match into your application

API Reference

Complete API documentation for Face Match endpoints