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.
Journey Integration flow
Get Configuration from the server.
Get User / Registered User details.
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) | |
| Search By Img | Manual face capturing | |
| Kiosk Mode | Continous Data by capturing face | |
| Event Registration | Event registration via QR code | |
| Event Check-In | Event check-in via QR scan or biometric or kiosk-style | |
| Express Verification | Check government ID exist or not. | |
| Express Onboarding | Registers users using only government ID details. | |
| Exchange Onboarding | Onboards customers via document scan, with optional boarding pass verification. | |
| User Profile | Get user/registrant data after verification | |
| 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. | |
Initialization & Configuration
1. Initialization
Required Parameters
- email (string) – Operator email address registered with Quepass
- password (string) – Operator password
- channelId (string) – Channel identifier issued by the Quepass team
- baseUrl (string) – Root URL of the Quepass backend (no trailing slash)
Return Parameters
sessionId (string) – Unique identifier for the user sessiontoken (string) – Authentication token for API access
Code Example
// Initialize
const initResponse = await Quepass.init(
formData.email,
formData.password,
formData.channel, // channelId
formData.baseUrl
);
2. Configuration
Required Parameters
Return Parameters
- s_SessionTimeout (number|string) – session timeout duration
- onboardingFlow (object|array) – configuration for onboarding flow
- verificationFlow (object|array) – configuration for verification flow
- govIntegration (boolean) – government integration enabled or not
- allowedJourneys (array of strings) – list of allowed journeys
Code Example
// Fetch channel configuration
const config = await Quepass.getConfigurations();
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 |
| SearchByImage | searchByImage | Search users by capturing or uploading an image |
| KioskMode | kioskModeCamera | Continuous face capture for kiosk-style identification |
| EventQRRegistration | registerEventByQR | Event registration using QR code |
| EventBiometricCheckIn | checkinByBiometric | Event check-in using biometric verification |
| EventBiometricCheckInKiosk | checkinByBiometric | Event check-in using biometric verification and kiosk-style identification |
| CheckinByQR | checkinByQR | Event check-in by scanning QR code |
| 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 |
User Profile
| 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.
