Callbacks
Interpret WebSDK messages.
When providing the on
handler, you will receive messages from the WebSDK for the selected callback message type
onLoad & onReady
The onLoad
callback is called when the workflow finishes loading and is ready to be displayed.
The onReady
callback is called when the workflow is ready for user interaction.
onComplete
The onComplete
callback is called when the workflow has completed and the individual clicks on the complete button to close the flow.
onEvent
The onEvent
callback is called at certain points in the One Stop flow.
Event Name | Description |
---|---|
start | Triggered when a workflow has been created in the individual |
document-country-select | The individual selected the country of government ID verification. |
document-type-select | The individual selected the type of government ID verification. |
document-camera-capture | The individual took a photo for the government ID verification. |
document-capture-failure | The individual took a photo for the government ID verification, but an error occurred. |
document-upload | The individual uploaded a government ID photo. |
selfie-camera-capture | The individual took a photo for the selfie verification. |
selfie-capture-failure | The individual took a photo for the selfie verification, but an error occurred. |
enable-camera | Ask for the camera permission |
retry | The individual accessed the retry page |
failure | The workflow failure |
cross-device | |
form | The individual accessed the form page. |
form-submit | The individual submitted the form. |
decline | The individual accessed the decline page. |
success | The individual accessed the success page. |
pending | The individual accessed the pending page. |
complete | The individual is exiting the flow after verifying their identity. |
video-recorded | The individual has completed the liveness verification, and video data was captured successfully. only captureConfig.type is video trigger. |
start-image-capture | The event that starts capturing an image. Only captureConfig.type is image trigger. |
image-capture | The event that an image has been captured. Only captureConfig.type is image trigger. |
stop-image-capture | The event that stops capturing an image. Only captureConfig.type is image trigger. |
Updated 7 months ago