SDK Installation
Install the Owl Eyes SDK in your project. We support npm, yarn, pnpm, and CDN.
Package Manager
npm
Terminalbash
Loading...
yarn
Terminalbash
Loading...
pnpm
Terminalbash
Loading...
CDN
For projects without a build system, include the SDK directly via CDN:
index.htmlhtml
Loading...
When using CDN, the SDK is available globally as window.OwlEyes:
index.htmlhtml
Loading...
Framework-Specific Packages
We also provide framework-specific packages with additional conveniences:
| Framework | Package | Features |
|---|---|---|
| React | @owl-eyes/react-sdk | React hooks, context provider, components |
| Vue | @owl-eyes/vue-sdk | Vue composables, plugin, components |
| Angular | @owl-eyes/angular-sdk | Angular service, module, components |
| Node.js | @owl-eyes/node-sdk | Server-side API client (requires API access) |
Terminalbash
Loading...
TypeScript Support
All Owl Eyes packages include TypeScript definitions out of the box. No additional@types packages needed.
verification.tstypescript
Loading...
API Key
You'll need a publishable API key to initialize the SDK. Find your key in the Dashboard under Settings → API Keys.
Key Types
- pk_live_... — Publishable key (safe for client-side)
- sk_live_... — Secret key (server-side only, never expose!)
- pk_test_... — Test mode publishable key
Requirements
Browser Support
- Chrome 80+
- Firefox 75+
- Safari 13+
- Edge 80+
- Mobile browsers (Chrome for Android, Safari iOS 13+)
Required Permissions
- Camera access (for document and selfie capture)
- HTTPS connection (required for camera access)
HTTPS Required
The SDK requires HTTPS to access the camera. It will not work on HTTP (except localhost for development).