Navigate to ID Check

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

ID Check URL

The ID Check URL is: https://app.{env}.verisoul.ai/ where {env} is:

prod for production
sandbox for sandbox

The ID Check URL accepts the following query parameters:

string

required

The session token obtained from the Verisoul API

string

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

string

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

On Completion

Once the ID Check session is complete, the user will be sent to the redirect_url configured in the query parameters. By default, ID Check redirects to https://verisoul.ai. The completed redirect URL will contain the following parameters:

string

The session ID used for the verification

boolean

Whether the verification was successful

string

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

Web
Mobile

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

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

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.

For mobile applications, you can open Face Match in a webview:

import { WebView } from 'react-native-webview';

function IDCheckVerification({ sessionId, onComplete }) {
  const idcheckUrl = `https://app.prod.verisoul.ai/?session_id=${sessionId}&redirect_url=yourapp://verification-complete`;
  
  return (
    <WebView
      source={{ uri: facematchUrl }}
      onNavigationStateChange={(navState) => {
        // Handle redirect back to your app
        if (navState.url.startsWith('yourapp://')) {
          // Extract parameters from URL
          const url = new URL(navState.url);
          const status = url.searchParams.get('status');
          const errorMessage = url.searchParams.get('error_message');
          
          onComplete({ status, errorMessage });
        }
      }}
    />
  );
}

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
liveness_check_failed: The session ended in a non-success state, for example the user cancelled a step
face_match_failed: The face match/liveness step reached the maximum number of attempts without succeeding
failed_to_process_id_scan: The identity document scan could not be processed
failed_to_collect_device_data: Required device or network data could not be collected from the user’s device
max_duration_exceeded: The session was never completed and can no longer be completed. Sessions stay completable for 30 days after creation, so this can arrive well after the user last interacted with the flow

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

Webhooks give your backend a record of every session outcome, even when the user’s browser never reaches this redirect. See Webhooks for more information.

Next Steps

After the user completes the ID Check verification, you can verify the user to implement uniqueness checks or authentication.

Overview

Integration

Signals & Scores

Action

Dashboard

Email Intelligence API

Verifications

Navigate to ID Check

ID Check URL

On Completion

Navigation Options

Error Handling

Next Steps

​ID Check URL

​On Completion

​Navigation Options

​Error Handling

​Next Steps

ID Check URL

On Completion

Navigation Options

Error Handling

Next Steps