Quickstart

Get started with Verisoul Face Match verification

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?account_id=facematch-quickstart-account' \
   --header 'x-api-key: {VERISOUL_API_KEY}'
   

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

   account_id is your unique identifier for the user — replace facematch-quickstart-account with your actual user’s identifier. The completed session is tied to this account automatically.

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 Verify the session

   Get the verification result for the completed session:

   curl --location 'https://api.sandbox.verisoul.ai/liveness/verify-face' \
   --header 'Content-Type: application/json' \
   --header 'x-api-key: {VERISOUL_API_KEY}' \
   --data '{
       "session_id": "{VERISOUL_SESSION_ID}"
   }'
   

   The response includes the Decision, Risk Score, and Risk Flags. See Response Signals for how to interpret them.

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