As shown in Event webhook → Additional info about end-user events, events 7007-7010 may send additional info. The payload may include:
actionstring, naming the webhook action (see the table in Possible events over webhook)
a
contextobject, containing the optional:reasonstring, which gives some context to theactionstring in the payloadstatestrings, which tries to indicate the state of the end-user flow at the moment of flow stopping (e.g., because the flow was finished or abandoned)
Event name |
| Description |
|---|---|---|
waiting_complete |
| Session got a final decision |
waiting_complete |
| Session got a final decision (websocket) |
waiting_complete |
| The end-user clicked on the Continue button after the final decision was passed |
flow_finished |
| The end-user clicked on the Confirmed button in the "leave session dialog" |
flow_cancelled |
| Sent if the end-user clicked on the Exit button in the "leave session dialog" |
flow_cancelled |
| Sent if the end-user clicked on the Exit button in the "error screen" |
flow_cancelled |
| Sent if the end-user clicked on the Cancel button on "consent screen" |
flow_cancelled |
| Sent on two occasions: a) once the "mobile handover screen" is shown, only for Desktop devices (no state passed here since no screen is shown yet) b) when video webRTC failed or an unexpected error occurred when getting end-user's camera |
The state string sends a value trying to indicate the state of the end-user flow at the moment of flow stopping (e.g., because the flow was finished or abandoned). Table below lists the possible values for the string.
The "Description" column explains the type of screen the end-user sees, and whether they are prompted to take some action.
| Description |
|---|---|
| First event that is triggered when the end-user opens the web app or the SDK |
| The introductions screen (first screen of the flow) is shown |
| Session status changed from “created” to “started”. The end-user has started the flow. |
| Session status changed from “started” to "submitted". The end-user has completed the flow. |
| End-user clicks “Start session” on the introduction screen |
| React requests camera/mic permission from the end-user. If the end-user has not granted them already then they will see a popup. |
| End-user gave permission to use the device's camera/mic |
| End-user declined to give permission to use the device's camera/mic |
| The document and country selection screen is shown |
| The country select screen is shown |
| The screen where the end-user can select the document type is shown |
| If the system fails to assign a document, the end-user needs to input the details manually |
| End-user manually assigns the correct document |
| The document select screen is shown |
| End-user selects a document from the list as the correct one |
| End-user confirms the detected document |
| The screen with instructions how to make a passport signature picture is shown |
| End-user is informed to get ready to grant camera/microphone permissions |
| End-user is asked to grant camera/microphone permissions, which means that these were not initially granted |
| End-user clicks to continue and the barcode scan process starts |
| The screen to scan the barcode is shown |
| Barcode scan failed due a timeout and the end-user is redirected back to the flow |
| Barcode scanned |
| Barcode was successfully scanned and the end-user is asked to continue with the flow |
| The screen to scan the QR-code is shown |
| The consent screen is shown |
| End-user clicks on "Proceed” button with selected “I don’t consent” disclaimer |
| End-user clicks on "Proceed’ button with selected “I consent” disclaimer |
| End-user is prompted to manually enter the 12-digit document number |
| End-user sees the one-time password (OTP) screen where they can enter the OTP code |
| End-user did not see any errors after submitting their one-time password, meaning the flow has been successfully completed |
| End-user sees a screen informing that they will be directed to use a mobile device for verification |
| End-user sees the mobile handover screen where they are prompted to check their mobile or check their email to continue |
| End-user is given the option to fallback via sms or QR code. This event is triggered when the end-user tries with either method |
| The resubmission feedback screen is shown |
| The final screen of the flow is shown, where the end-user is informed that session is successfully finished |
| End-user clicks on the confirm button |
| End-user sees the "waiting decision" screen, where they are asked to wait until the final decision is made |
| End-user clicks in the “Continue” button in the waiting decision screen |
| The decision took too long and a timeout was triggered |
| The final decision screen is shown, “Approved” or “Declined” |
| An error screen is shown |
| End-user sees the consent screen after pressing the button on the intro screen to start the session |
| The resubmission feedback screen is shown |
| End-user clicks “Continue” on the resubmission feedback screen. It substitutes |
| End-user sees the screen where they need to capture their selfie |
| End-user clicks the button to take a selfie |
| End-user sees the screen where they need to capture the document front |
| End-user clicks the button to take a picture of the document front |
| End-user sees the screen where they need to capture the document back |
| End-user clicks the button to take a picture of the document back |
| End-user sees the screen where they need to capture the document front and take a selfie |
| End-user sees the screen where they need to scan the barcode |
| End-user sees the screen where they need to capture their passport |
| End-user sees the screen where they need to capture their Proof of Address (PoA) document |
| End-user sees the screen where they need to capture the passport signature |
| End-user gets feedback about the selfie taken and is asked to capture it again |
| End-user clicks on “Continue” on the selfie feedback screen |
| End-user retries taking a selfie after the feedback |
| End-user gets feedback about the image of the document front taken and is asked to capture it again |
| End-user clicks on “Continue” on the document front feedback screen |
| End-user retries taking a picture of the document front after seeing the document front feedback |
| End-user gets feedback about the image of the document back taken and is asked to capture it again |
| End-user clicks on “Continue” on the document back feedback screen |
| End-user retries taking a picture of the document back after seeing the document back feedback |
| Assisted image capture. The end-user sees a screen informing that the picture taken is too dark. |
| Assisted image capture. The end-user is informed that the picture being too dark is fixed. |
| Assisted image capture. The end-user is informed that multiple people are detected in the image for the selfie. |
| Assisted image capture. The end-user is informed that there are no people detected in the image for the selfie. |
| Assisted image capture responds to various issues with the image taken. Response event to an image upload. An event is sent when an image is approved or declined by an assisted image capture service. |
| Assisted image capture. Feedback response limit reached and skipped. |
| Assisted image capture. 4 seconds timeout is reached. End-user is taken forward to the next image capture. |
| Assisted image capture. The end-user responds to feedback and the issue detection no longer is being triggered. |
| End-user gets feedback about the image of the document and selfie taken and is asked to capture them again |
| End-user gets feedback about the barcode captured and is asked to scan it again |
| End-user gets feedback about the image of the passport and is asked to capture it again |
| End-user gets feedback about image of the proof of address document taken and is asked to capture it again |
| End-user gets feedback about the passport signature taken and is asked to capture it again |
| End-user sees the screen notifying them about an error |
| End-user clicks on the error screen exit button |
| end-user clicks on the “Try again” button on the error screen |
| End-user sees a screen notifying about a timeout, after the session has been active for too long |
| End-user clicks on the timeout error screen exit button |
| End-user clicks on the “Try again” button on the timeout error screen |
Article versioning
Date | Description |
|---|---|
May 7, 2025 | Documentation published |