Navigate to ID Check
Once you have fetched a valid session token, you can navigate the user to ID Check.
ID Check URL
If your user is on mobile, you can open ID Check in a webview or redirect the user to the ID Check url. If your user is on desktop, ID Check will recognize this and display a QR so that the user can complete on mobile.
When integrating into a mobile app it is recommended to open ID Check in a webview. See Best Practices & Tips for more
The ID Check url is https://app.prod.verisoul.ai/
and takes three query parameters:
session_id*
string
secure session token
redirect_url
string
url encoded string that ID Check will redirect to upon completion
lng
supported language code
On Completion
Once the ID Check session is complete, the user will be sent to the redirect_url
configured in the query parameters above; by default, ID Check redirects to https://verisoul.ai
.
The completed redirect URL will contain the following parameters:
session_id*
string
secure session token
success*
boolean
true if session completed without errors
error_message
string
only present if success is false; will contain a relevant error description
Error Handling
Error messages can include:
invalid_session_id
: The session token provided is expired or invalidsession_id_not_found
: No session token was providedfailed_to_get_camera_permission
: The user did not agree to give the browser camera permissionsfailed_to_complete_face_scan
: The user was not able to complete the face scan process (clicked away from window context, etc.)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 ID Check process.
To let a user retry, you will need to fetch a new session token.
For more details on how to maximize user conversation rates: Best Practices & Tips
Last updated