Event Handling
The SDK provides three primary event handling methods that give you complete control and visibility over the document processing lifecycle:
onUpdate Handler
The onUpdate
handler provides real-time status updates throughout the scanning process. It receives a status object:
VeryfiLens.onUpdate((status) => {
console.log("Current status:", status.status);
});
Status values include:
Status | Description |
---|---|
validation_started | Partner validation begins |
validation_completed | Partner validation successful |
validation_failed | Partner validation failed |
camera_failed | Camera access failed or errored |
capture_started | Image capture begins |
capture_completed | Image capture successful |
processing_started | Document processing begins |
processing_completed | Document processing complete |
submission_started | Server submission begins |
submission_completed | Server submission successful |
submission_failed | Server submission failed |
stitching_started | Long document stitching begins |
stitching_completed | Long document stitching complete |
onSuccess Handler
Called when an operation completes successfully. The data structure varies based on the context:
VeryfiLens.onSuccess((result) => {
console.log("Operation successful:", result);
});
Triggered in these scenarios:
- Document processing completion
- Credit card scanning completion
- Long document stitching completion
- Server submission completion
Response format examples:
// For documents/checks
{
image: "base64_encoded_string",
// Additional document metadata
}
// For credit cards
{
number: "4111111111111111",
name: "JOHN DOE",
date: "12/24",
cvv: "123"
}
onFailure Handler
Called when errors occur during any stage of processing:
VeryfiLens.onFailure((error) => {
console.error("Operation failed:", error);
});
Common failure scenarios:
- Partner validation failures
- Camera initialization errors
- Image capture errors
- Document processing errors
- Server submission errors
- WASM initialization or processing errors