1. What is Quepass SDK?
Quepass SDK (@quepass/sdk) is a React-based JavaScript/TypeScript library designed for identity verification and biometric KYC flows in web applications. The SDK enables:
- Document-based user registration (ID Card, Passport)
- Face biometric capture and verification
- Liveness detection during identity verification
- Document OCR and identity data extraction
- Secure communication with Quepass backend services
Quepass SDK provides a biometric identity verification engine for web applications. It includes camera capture, liveness detection, document OCR, and backend integration in a single npm package, eliminating the need to build these components separately.
2. What SDK Does
| Feature | Description | |
|---|
| Registration | Register new users with document and biometrics | |
| Authentication | Login with document number and face | |
| Transaction | Verify high-security transactions with UID and biometric | |
| Search | Search users by face only (kiosk-style) | |
| Event Registration | Event registration via QR code | |
| Event Check-In | Event check-in via QR scan or biometric or kiosk-style | |
| User Profile | Get user/registrant data after verification | |
| Search By Img | Manual face capturing | |
| Kiosk Mode | Continous Data by capturing face | |
| Customer lifecycle | Shows for how long will the customer remain active | |
| Customer Status | The customer’s status (Active or Inactive) | |
| SDKsCapabilities | Information of SDKs Version. | |
| ExchangeOnboarding | Onboards customers via document scan, with optional boarding pass verification. | |
| ExpressOnboarding | Registers users using only government ID details. | |
| ExpressVerification | Check government ID exist or not. | |
3. Initialization & Configuration
Initialization
// 2. Initialize
const initResponse = await Quepass.init(
formData.email,
formData.password,
formData.channel, // channelId
formData.baseUrl
);
Configuration (after initialization)
// 3. Fetch channel configuration
const config = await Quepass.getConfigurations();
4. Journey
Journeys are flows launched via LaunchJourney():
| Journey | Constant | Purpose |
|---|
| Onboarding | register | User registration with document and biometrics |
| Authentication | authentication | User login using biometric verification |
| Transaction | transaction | Biometric verification for secure transactions |
| Search | search | Identify or search users using biometrics |
| KioskMode | kioskModeCamera | Continuous face capture for kiosk-style identification |
| EventQRRegistration | registerEventByQR | Event registration using QR code |
| EventBiometricCheckIn | checkinByBiometric | Event check-in using biometric verification |
| CheckinByQR | checkinByQR | Event check-in by scanning QR code |
| SearchByImage | searchByImage | Search users by capturing or uploading an image |
| ExpressOnboarding | expressOnboarding | Registration using only government ID details |
| ExpressVerfication | expressVerification | Verification using government ID parameters |
| ExchangeOnboarding | exchangeOnboarding | Onboard customers via document scan with optional boarding pass verification |
5. User Management
| Method | Purpose |
|---|
| getUser | Retrieve user profile information using UID and consent token |
| getRegistrant | Fetch registrant details for a specific event using UID, event ID, and token |
| getKycCertificate | Retrieve the user’s KYC certificate using UID and token |
| customerLifecycle | Updates customer status with a specified date range |
| customerStatus | Updates customer Active or Inactive status using UID |
Ensure the SDK is initialized successfully before calling any identity journeys or API methods. Initialization establishes the connection with the Quepass backend services.
