​
Process overview

Go!Vid is a fully automated solution to verify the identity of your end users. The integration web based and can then be integrated in an iframe or a webview or by redirecting the end user.

There is an overview of a basic integration workflow with Go!Vid. Of course we can define other workflows, with or without human agents to validate the sessions, with or without accessing the session details, with customized UI and more.

​
Prerequisites

To use Go!Vid, first check that you have access to this product on the Algoreg backoffice, you can verify this in the billing page.

Make sure you:

Optionally, you may also want to:

​
Integration

After generating the session you will get a session_id string that you can use as described bellow either in an iframe or redirection.

​
Use a redirection

Simply redirect the user to the following url:

https://vid.algoreg.com/?session_id={session_id}
# Or https://vid.{instance}.algoreg.com/?session_id={session_id} if you're using a custom instance

​
Use an iframe

The integration is using the same url than the redirection but with &iframe_callback=1 to receive cross-windows events. To ensure that the iframe gets the video and microphone access, you need to add the following attributes to the iframe tag:

<iframe
  src="https://vid.algoreg.com/?session_id={session_id}&iframe_callback=1"
  allow="camera https://vid.algoreg.com; microphone https://vid.algoreg.com; geolocation https://vid.algoreg.com”
/>

The iframe will then send events to the parent window. You must handle them to correctly integrate the session.

window.addEventListener(
  "message",
  (msg) => {
    if (msg.data.event == "reload") {
      window.location.reload();
    }
    if (msg.data.event == "end_session") {
      console.log("The session ended");
    }
  },
  false
);
EventDescription
end_sessionThe session is finished, you can close the iframe or redirect the user to another page.
reloadWe need to restart the browser, usually to get the camera access.

​
Session customization and accessibility

From the Algoreg backoffice panel, you can customize the CSS stylesheet of a scenario. You can also change all the texts from the session. In addition to this, you can specify some parameters directly into the url.

​
show_consent
string
default:"1"

0 or 1. Enable or not the consent page.

​
show_ready
string
default:"1"

0 or 1. Enable or not the ready page.

​
use_speech
string
default:"0"

0 or 1. Enable or not the speech synthesis.

​
force_manual
string
default:"0"

0 or 1. Set to 1 to disable automatic speech recognition after speech. (The user will need to push the mic button)

​
ask_camera_access
string
default:"1"

0 or 1. Do not ask for camera access (only use this option if you do multiple scenario one after the other and that the camera access was already granted!)

​
show_final
string
default:"1"

0 or 1. Enable or not the final text page.

​
iframe_callback
string
default:"0"

0 or 1. Enable iframe callback. In this case we’ll send an event to the parent window instead of redirecting user to another URL.

​
return_url
string

Specify a return_url (override all previously defined return_url) More about return url here

​
theme
string

auto,light or dark. Set the theme brightness. Use “auto” for automatic theme detection, “light” for a light theme, or “dark” for a dark theme.

​
powered_by
string

0 or 1. Enable the display of a block with your Algoreg Logo