Webhook Events

A complete reference of all webhook events you can subscribe to.

Event Types

Owl Eyes sends the following webhook events:

Event TypeDescription
verification.startedUser started a verification
verification.completedVerification completed successfully
verification.failedVerification failed
verification.review_requiredManual review is required
verification.expiredVerification link expired without completion
verification.abandonedUser abandoned the verification
review.completedManual review decision was made

verification.started

Triggered when a user begins a verification flow.

verification.startedjson
Loading...

verification.completed

Triggered when a verification completes with a "verified" status.

verification.completedjson
Loading...

verification.failed

Triggered when a verification fails after all retry attempts.

verification.failedjson
Loading...

Failure Reasons

ReasonDescription
document_unreadableDocument text could not be extracted
document_expiredDocument has expired
document_suspected_fraudDocument appears to be fraudulent
face_mismatchSelfie doesn't match document photo
liveness_failedLiveness check detected spoofing
age_verification_failedUser is under the required age
max_attempts_exceededUser exceeded maximum retry attempts

verification.review_required

Triggered when a verification requires manual review.

verification.review_requiredjson
Loading...

verification.expired

Triggered when a verification link expires without being completed.

verification.expiredjson
Loading...

verification.abandoned

Triggered when a user starts but doesn't complete verification (after 30 minutes of inactivity).

verification.abandonedjson
Loading...

review.completed

Triggered when a manual review decision is made.

review.completedjson
Loading...

Handling Events

Example code for handling different event types:

handler.jsjavascript
Loading...