API Endpoints
Complete reference of all Owl Eyes API endpoints for managing verifications.
Base URL
Base URLtext
Loading...
For sandbox/testing, use:
Sandbox URLtext
Loading...
Verification Links
Create a Verification Link
Creates a new verification link that can be shared with users.
Endpointhttp
Loading...
Requestbash
Loading...
| Parameter | Type | Required | Description |
|---|---|---|---|
flowType | string | Yes | "standard" or "enhanced" |
referenceId | string | No | Your internal user/order ID |
expiresIn | integer | No | Seconds until expiry (default: 86400) |
redirectUrl | string | No | URL to redirect after completion |
metadata | object | No | Custom key-value pairs |
Responsejson
Loading...
Get a Verification Link
Endpointhttp
Loading...
Requestbash
Loading...
List Verification Links
Endpointhttp
Loading...
Requestbash
Loading...
| Parameter | Type | Description |
|---|---|---|
limit | integer | Number of results (default: 10, max: 100) |
startingAfter | string | Cursor for pagination |
status | string | Filter by status |
referenceId | string | Filter by reference ID |
Delete a Verification Link
Endpointhttp
Loading...
Requestbash
Loading...
Verifications
Get a Verification
Retrieves details about a completed verification.
Endpointhttp
Loading...
Requestbash
Loading...
Responsejson
Loading...
List Verifications
Endpointhttp
Loading...
Requestbash
Loading...
Sessions
Create a Session
Creates a short-lived session token for SDK initialization.
Endpointhttp
Loading...
Requestbash
Loading...
Responsejson
Loading...
Use Case
Use sessions when you want to initialize the SDK on your server and pass a token to the client. This is more secure than using your publishable key directly.Webhooks
Create a Webhook
Endpointhttp
Loading...
Requestbash
Loading...
List Webhooks
Endpointhttp
Loading...
Update a Webhook
Endpointhttp
Loading...
Delete a Webhook
Endpointhttp
Loading...
Analytics
Get Verification Analytics
Endpointhttp
Loading...
Requestbash
Loading...
Responsejson
Loading...
SDK Implementation Examples
Node.js SDK
node-sdk.jsjavascript
Loading...
Python SDK
python-sdk.pypython
Loading...