Documentation Index
Fetch the complete documentation index at: https://docs.quepass.com/llms.txt
Use this file to discover all available pages before exploring further.
1. What is Quepass Offline SDK?
The Quepass Offline SDK (@quepass/sdk) is a JavaScript/TypeScript library for offline biometric identity verification in web applications.
It allows developers to integrate document scanning (passports, ID cards) and facial recognition directly into React-based web apps without requiring a persistent internet connection after initial setup.
- Offline document capture and processing (ID cards, passports)
- Real-time facial image capture with liveness detection
- Edge detection on documents using WebAssembly and ONNX models
- Face detection powered by MediaPipe AI models
- JWT-based license activation with offline ECDSA verification
- Customizable UI theming (light/dark/system modes)
- Cross-browser support with WebRTC camera access
- Session persistence via IndexedDB
- ML model caching for offline operation
2. What SDK Does
| Feature | Description |
|---|
| Document | Capture Passport image and return it’s base64 string. |
| Face | Capture Face image and return base64 image string. |
| Document & Face | Capture passport & face image return base64 images string. |
3. Initialization
Import: import QuepassIdentityKit
| API | Purpose |
|---|
| Quepass.init(licenseKey = licenseKey, bundleId = bundleId, baseUrl = baseUrl) | Main entry: verify license and prepare SDK state. |
4. Public Functions
| Name | Kind |
|---|
| Quepass.setTheme(config: ThemeConfig) | class method |
| Quepass.capture(params: AppParams) | class method |
| Quepass.init() | class method |
