Skip to main content

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:

StatusDescription
validation_startedPartner validation begins
validation_completedPartner validation successful
validation_failedPartner validation failed
camera_initializingCamera is being initialized
camera_readyCamera is ready for capture
camera_failedCamera access failed or errored. Includes error message
capture_startedImage capture begins
capture_completedImage capture successful
capture_failedImage capture failed
processing_startedDocument processing begins
processing_completedDocument processing complete
processing_failedDocument processing failed
submission_startedServer submission begins
submission_completedServer submission successful
submission_failedServer submission failed. Includes error with details
stitching_startedLong document stitching begins
stitching_completedLong document stitching complete
autocapture_doneAutomatic document capture completed (requires autoDocumentCapture: true)
lcd_detectedLCD screen detected in captured image
blur_detectedBlur detected in captured image
not_a_documentNo document detected in captured image
wrong_side_detectedWrong check side detected (e.g. back captured when front expected). Includes expectedSide and result with detection probabilities
check_manual_capture_modeSwitched to manual capture mode for checks
capture_back_sidePrompting user to capture back side of check (optional)
capture_back_side_requiredRequiring user to capture back side of check (enforced)
capture_back_side_autoAutomatically proceeding to back side capture
blueprint_selection_cancelledBlueprint selection was cancelled (AnyDocs with blueprints)

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