Message events

introduction to keep your app informed about the user's progress within the plug in, we transmit data via message events at various stages this page 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 prerequisites make sure you've first gone through the docid\ qghldn2mla8w9rpkeigwn documentation, which explains the key concepts and the face scan flow to learn how to listen for these data messages in web apps, refer to the docid 1phy94phttsvfmacmkepv page in mobile apps, everything is detailed in the docs of the sdk you're using docid\ wytsjd2muuwcxgohtmsjv overview we distinguish the following events startnewmeasurement recordingstarted recordingstopped dismiss > notifies you when to dismiss the plug in camera > lets you handle paths for customers with no camera summary of event occurrences upon reaching the recording screen, where the actual face scan takes place, users are welcomed by the smart assistant after confirming they are at rest, the initial quality check kicks in if the conditions are favourable and the check passes, the actual recording starts and a recordingstarted event is sent the progress bar starts running, and once all results are in, the measurement succesfully concludes, prompting a recordingstopped event a modal appears to inform the users about the completion of the scan clicking on 'continue' triggers the final dismiss event 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 if this situation drags on for too long, 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 ‘ quit ’ button choosing the 'try again' option brings them back to the start of the face scan process if they select the 'quit' option, no biomarkers can be calculated and a dismiss event is again sent in short the dismiss event indicates the plug in iframe may be closed (dismissed) this may be due to either succesful completion of the face scan – in which case the data hasresults property will be true another reason, e g the user chose to quit – in which case the data hasresults property will be false the event types are further explained in detail below event types the diagram below illustrates the different stages within the plug in and the corresponding events triggered any other message events not mentioned in this documentation, may be send for diagnostic or test purposes and should not be used recording started (informative) sent when the user clicks the record button and the timer starts event data success { "stage" "recordingstarted", "uuid" "380cae2a32ed4023be60a63c3ee97e95", } stage "recordingstarted" uuid face scan id (unique id of the face scan) recording stopped (informative) sent when the recording stopped, i e the recording timer ends event data success { "stage" "recordingstopped", "uuid" "380cae2a32ed4023be60a63c3ee97e95", } stage "recordingstopped" uuid face scan id (unique id of the face scan) dismiss we will notify you with a "dismiss" event when the plug in can be closed (dismissed) this is an overarching event, covering any situation where the plug in should be closed the data hasresults property (boolean) can be used to distinguish whether the user finished the face scan successfully ( hasresults true ), or if the face scan was aborted ( hasresults false ) sent when the web plugin should be closed event data json { "stage" "dismiss", "uuid" "380cae2a32ed4023be60a63c3ee97e95", "data" { "hasresults" true } } stage "dismiss" uuid face scan id (unique id of the face scan) data additional event data camera this event is sent whenever a camera related update is available this post message has 4 possible options for its status value prompting > we asked the user for camera access and are waiting for a response available > the user has a camera and has granted access denied > the user has a camera but denied access no camera > the user has no camera available for use these events allow you to provide the user with a different path if they have no camera or denied access to the camera event data json { "stage" "camera", "data" { "status" "available" } } stage "camera" data additional event data