Get Started

​

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:

• did define a first scenario
• know ho to generate a session using the API.

Optionally, you may also want to:

• define status that the robot and your agents will be able to affect to the session.
• create a customer if you want your session attached to a customer.
• configure a webhook to be notified when a session is completed.

​

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
);

​

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.