Webhook Events
A complete reference of all webhook events you can subscribe to.
Event Types
Owl Eyes sends the following webhook events:
| Event Type | Description |
|---|---|
verification.started | User started a verification |
verification.completed | Verification completed successfully |
verification.failed | Verification failed |
verification.review_required | Manual review is required |
verification.expired | Verification link expired without completion |
verification.abandoned | User abandoned the verification |
review.completed | Manual 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
| Reason | Description |
|---|---|
document_unreadable | Document text could not be extracted |
document_expired | Document has expired |
document_suspected_fraud | Document appears to be fraudulent |
face_mismatch | Selfie doesn't match document photo |
liveness_failed | Liveness check detected spoofing |
age_verification_failed | User is under the required age |
max_attempts_exceeded | User 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...