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.

Generate the session

Generate an onboarding session url for a customer (see API reference)

Redirect user to the session

Redirect the customer to this url (send the url by sms, HTTP redirection, or open an iframe)

Get notified when the session ends

At the end of the session, we redirect the user to a page you define or we let you close the iframe. You also get a webhook notification to inform your server that a session just ended or when an agent change the decision of a session. (see API reference)

Obtain the session results

In any cases, call our APIs to get more details about the finished session (see API reference)

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:

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

Event	Description
`end_session`	The session is finished, you can close the iframe or redirect the user to another page.
`reload`	We 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.

0 or 1. Enable or not the consent page.

string

default:"1"

0 or 1. Enable or not the ready page.

string

default:"0"

0 or 1. Enable or not the speech synthesis.

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)

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

string

default:"1"

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

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.

string

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

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.

string

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

Go!Chat SDK

Go!Vid SDK

Process overview

Prerequisites

Integration

Use a redirection

Use an iframe

Session customization and accessibility

​Process overview

​Prerequisites

​Integration

​Use a redirection

​Use an iframe

​Session customization and accessibility

Process overview

Prerequisites

Integration

Use a redirection

Use an iframe

Session customization and accessibility