Events & Callbacks

Event Overview

The Owl Eyes SDK emits events at key points during the verification process, allowing you to respond to user actions and verification status changes.

Registering Event Handlers

Register event handlers using the on method:

Callback-Style Registration

Alternatively, pass callbacks when calling start():

Event Data Reference

ready Event

started Event

stepChange Event

stepCompleted Event

completed Event

error Event

close Event

Removing Event Handlers

Use off to remove event handlers:

React Event Handling

In React, handle events through component props or the hook:

Analytics Integration

Use events to track verification funnel analytics:

Best Practices

1. Always handle errors

   Provide clear feedback to users when errors occur and offer retry options when possible.

2. Don't trust client-side completion events

   Always verify results on your backend via webhooks. Use client events only for UI updates.

3. Track abandonment

   Use the close event to understand where users drop off.

4. Clean up handlers

   Remove event handlers when components unmount to prevent memory leaks.