Once you have fetched a valid session token, you can navigate the user to Verisoul’s Face Match URL to complete the verification process.

​
Face Match URL

The Face Match URL is: https://app.{env}.verisoul.ai/ where {env} is:

  • prod for production
  • sandbox for sandbox

The Face Match URL accepts the following query parameters:

​
session_id
string
required

The session token obtained from the Verisoul API

​
redirect_url
string

The URL encoded string to redirect to after the verification is complete (default: https://verisoul.ai)

​
lng
string

Optional language parameter to customize the instructions (default: en) See Localization for more details

​
On Completion

Once the Face Match session is complete, the user will be sent to the redirect_url configured in the query parameters. By default, Face Match redirects to https://verisoul.ai.

The completed redirect URL will contain the following parameters:

​
session_id
string

The session ID used for the verification

​
success
boolean

Whether the verification was successful

​
error_message
string

Present only if success is false, contains the reason for failure

For web applications, you can redirect the user to the Face Match URL:

function redirectToFaceMatch(sessionId) {
  const redirectUrl = encodeURIComponent(window.location.origin + '/verification-complete');
  const facematchUrl = `https://app.prod.verisoul.ai/?session_id=${sessionId}&redirect_url=${redirectUrl}`;
  
  window.location.href = facematchUrl;
}

If your user is on desktop, Face Match will automatically recognize this and display a QR code so that the user can complete the verification on their mobile device.

​
Error Handling

Error messages can include:

  • invalid_session_id: The session token provided is expired or invalid
  • session_id_not_found: No session token was provided
  • failed_to_get_camera_permission: The user did not agree to give the browser camera permissions
  • failed_to_complete_face_scan: The user was not able to complete the face scan process
  • liveness_check_failed: The user did not pass liveness verification

It is recommended to parse the error_message and prompt the user to restart the FaceMatch process. To let a user retry, you will need to fetch a new session token.

​
Next Steps

After the user completes the FaceMatch verification, you can verify and enroll the user to implement uniqueness checks or authentication.