WebSDK messages
Interpret event messages from Sumsub WebSDK.
This article explains how to handle event messages from the Sumsub WebSDK after you configure an on
handler function. This handler allows you to receive messages from the WebSDK about various important events, such as changes in applicant status, applicant actions, and more. The following table describes each message type and provides payload details on specific status changes and significant actions.
Note
All message types are prefixed with
idCheck
.
Message type | Payload | Description |
---|---|---|
|
Empty | WebSDK resources have been loaded. |
|
Empty | The first screen is rendered. |
|
|
A screen that corresponds to |
|
In WebSDK:
In WebSDK and WebSDK 2.0:
|
Step |
|
|
Applicant with ID |
|
Empty | Documents were submitted for verification. |
|
|
Applicant status has been changed. |
|
Empty | Documents re-submitted for verification. |
|
|
Applicant action with ID |
|
Empty | Applicant action was submitted. |
|
|
Applicant action |
|
|
The result of the standalone module has been presented to the user. Valid only for the "module" customization types. Happens either when the user has just completed the check or when user reopened the module for the previously completed check. Possible answers:
Not shown if the rejection is not final. |
|
|
WebSDK frame has been resized. |
|
Empty | Video call was started by the user. |
|
Empty | Video call was answered by operator. |
|
Empty | Video call was completed by operator. |
|
|
Uploaded document was rejected. |
|
|
Warnings about the uploaded document. |
|
|
The state of the navigation controls in the SDK. Pass |
Updated 1 day ago