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.
After a successful journey launch, the SDK returns a response containing the unique user identifier (UID), token, and additional flow-specific data. The data field varies depending on the SDK flow.
1. Response Structure
{
"code": 200,
"data": {
// Dynamic based on SDK flow
}
}
2. Dynamic data by SDK flow
Init
| Field | Type | Description |
|---|
| sessionId | string | Unique identifier for the user session |
| token | string | Authentication token for API access |
Configuration
| Field | Type | Description |
|---|
| 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 |
Onboarding
| Field | Type | Description |
|---|
| uid | string | User identity |
| token | string | Authentication token |
| unifiedNumber | string | Unified identification number (may be empty if not applicable) |
Authentication
| Field | Type | Description |
|---|
| uid | string | User identity |
| token | string | Authentication token |
| unifiedNumber | string | Unified identification number (may be empty if not applicable) |
Transaction
| Field | Type | Description |
|---|
| uid | string | User identity |
| token | string | Authentication token |
| unifiedNumber | string | Unified identification number (may be empty if not applicable) |
Search / SearchByImg
| Field | Type | Description |
|---|
| uid | string | User identity |
| token | string | Authentication token |
| unifiedNumber | string | Unified identification number (may be empty if not applicable) |
Kiosk Mode – Kiosk Face
| Field | Type | Description |
|---|
| uid | string | User identity |
| token | string | Authentication token |
| isCaptured | boolean | Indicates whether biometric/image was successfully captured |
| isFound | boolean | Indicates whether a matching user record was found |
EventQRRegistration – Register for Event
| Field | Type | Description |
|---|
| uid | string | User identity |
| token | string | Authentication token |
| payload | object | Encrypted QR/Event payload data |
| data | string | Encrypted payload (Base64 encoded) |
| signature | string | Digital signature for payload verification |
EventQRRegistration – FaceCheckin
| Field | Type | Description |
|---|
| uid | string | User identity |
| token | string | Authentication token |
| isCaptured | boolean | Indicates whether biometric/image was successfully captured |
| isFound | boolean | Indicates whether a matching user record was found |
EventBiometricCheckIn – Kiosk Face Check-in
| Field | Type | Description |
|---|
| uid | string | User identity |
| token | string | Authentication token |
| isCaptured | boolean | Indicates whether biometric/image was successfully captured |
| isFound | boolean | Indicates whether a matching user record was found |
CheckinByQR – QR Check-in
| Field | Type | Description |
|---|
| uid | string | User identity |
| token | string | Authentication token |
ExpressVerification
| Field | Type | Description |
|---|
| uid | string | User identity |
| token | string | Authentication token |
| unifiedNumber | string | Unified identification number (may be empty if not applicable) |
ExpressOnboarding
| Field | Type | Description |
|---|
| uid | string | User identity |
| token | string | Authentication token |
| unifiedNumber | string | Unified identification number (may be empty if not applicable) |
ExchangeOnboarding
| Field | Type | Description |
|---|
| uid | string | User identity |
| token | string | Authentication token |
| boardingPassDTO | object | Details of the boarding pass (flight info, seat, passenger) |
| documentDTO | object | Details of the document (type, number, expiry) |
