To keep your app informed about the user's progress within the plug-in, we transmit data via message events at various stages. This document describes the different types of events, when they are sent, and their data format. The events are in JSON format and contain information about the Face Scan's progress.

Make sure you've gone through the following documentation:

To learn how to listen for these data messages in web apps, refer to the Listening to message events page.

We currently distinguish the following events:

When the user clicks the 'Perform Measurement' button on the welcome screen, a startNewMeasurement event is sent. Upon reaching the recording screen, users encounter the camera stream along with a start button. Pressing the start button initiates the quality-checking process. If the conditions are favourable and the check passes, the actual recording starts and a recordingStarted event is sent. The timer begins counting down, and upon reaching zero, the measurement concludes, prompting a recordingStopped event. The subsequent events depend on the outcome of the measurement.

If the measurement is successful, a faceScanSuccessful event is sent, indicating that the results are available and can be requested via the API.

However, there might be instances where the quality deteriorates too much during the Face Scan, rendering an accurate assessment unfeasible. For instance, this could occur if the lighting abruptly dims. In such cases, an errorevent is sent and users are presented with two choices: they can restart the Face Scan by selecting the ‘try again’ option, or they can opt to conclude the Face Scan without completing it successfully by clicking the ‘continue’ button. Choosing the 'try again' option brings them back to the start of the Face Scan process. If they select the 'continue' option, no biomarker results will be generated, and a userFinished event will be sent.

The dismiss event is sent whenever the web plugin should be closed.

The event types are further explained in detail below.

The diagram below illustrates the different stages within the plug-in and the corresponding events triggered.

Event Data



Event Data

Event Data

Event Data

Occasionally, the conditions may deteriorate while performing the Face Scan, making an accurate health assessment unfeasible. For instance, this might happen if the lighting suddenly gets very dim. In such instances, users are presented with two choices: they can restart the health check by selecting the ‘try again’ option, or they can opt to conclude the health check without completing it successfully by clicking the ‘continue’ button. If they select the latter option, no biomarker results will be generated. We will notify you of this outcome with a “userFinished” event.

This event is also sent when the user's device does not have a camera or when the necessary permissions to access the camera have not been granted.

Event Data

We will notify you with a "dismiss" event when the web plugin can be closed. This can be because of the following reasons:

Event Data