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. Function
2. Required Parameters by Journey
| Journey | Required Parameters |
|---|---|
| Onboarding | journey, isActiveLiveness, isPassiveLiveness, kioskMode, documentType |
| Authentication | journey, govVerification, eventId, isActiveLiveness, isPassiveLiveness, kioskMode, documentNumber, documentNumberType, biometricType |
| Transaction | journey, govVerification, eventId, isActiveLiveness, isPassiveLiveness, kioskMode, uid, biometricType |
| Search | journey, govVerification, eventId, isActiveLiveness, isPassiveLiveness, kioskMode, biometricType |
| EventQRRegistration | journey, uid, govVerification, ticketType, eventId, isActiveLiveness, isPassiveLiveness, kioskMode |
| EventBiometricCheckIn | journey, govVerification, eventId, callBack |
| EventQRCheckIn | journey, data, signature, eventId |
| EventBiometricCheckInKiosk | journey, govVerification, eventId, isActiveLiveness, isPassiveLiveness, kioskMode, documentType, documentNumber, callBack |
| KioskMode | journey, govVerification, eventId, isActiveLiveness, isPassiveLiveness, kioskMode, callBack |
| ExpressVerification | journey, identifierType, identifierNumber, nationality |
| ExpressOnboarding | journey, isActiveLiveness, isPassiveLiveness, kioskMode, identifierType, identifierNumber, nationality |
3. Journey Examples
1. Onboarding
Required Parameters
- journey (enum) – Type of journey to launch
- isActiveLiveness (boolean) – Enable or disable active liveness check
- isPassiveLiveness (boolean) – Enable or disable passive liveness check
- kioskMode (boolean) – Enable or disable kiosk mode
- documentType (enum) – Type of document used in the journey
Return Parameters
- uid (string) – User identity
- token (string) – Authentication token
- unifiedNumber (string) – Unified identification number (optional)
Code Example
2. Authentication
Required Parameters
- journey (enum) – Type of journey to launch
- govVerification (boolean) – Enable or disable government verification
- eventId (string) – Unique identifier for the event
- isActiveLiveness (boolean) – Enable or disable active liveness check
- isPassiveLiveness (boolean) – Enable or disable passive liveness check
- kioskMode (boolean) – Enable or disable kiosk mode
- documentNumber (string) – Document number
- documentNumberType (enum) – Type of document number
- biometricType (enum) – Type of biometric data
Return Parameters
- uid (string) – User identity
- token (string) – Authentication token
- unifiedNumber (string) – Unified identification number (optional)
Code Example
3. Transaction
Required Parameters
- journey (enum) – Type of journey to launch
- govVerification (boolean) – Enable or disable government verification
- eventId (string) – Unique identifier for the event
- isActiveLiveness (boolean) – Enable or disable active liveness check
- isPassiveLiveness (boolean) – Enable or disable passive liveness check
- kioskMode (boolean) – Enable or disable kiosk mode
- uid (string) – User identity
- biometricType (enum) – Type of biometric data
Return Parameters
- uid (string) – User identity
- token (string) – Authentication token
- unifiedNumber (string) – Unified identification number (optional)
Code Example
4. Search
Required Parameters
- journey (enum) – Type of journey to launch
- govVerification (boolean) – Enable or disable government verification
- eventId (string) – Unique identifier for the event
- isActiveLiveness (boolean) – Enable or disable active liveness check
- isPassiveLiveness (boolean) – Enable or disable passive liveness check
- kioskMode (boolean) – Enable or disable kiosk mode
- biometricType (enum) – Type of biometric data
Return Parameters
- uid (string) – User identity
- token (string) – Authentication token
- unifiedNumber (string) – Unified identification number (optional)
Code Example
5. Event Registration:
Required Parameters
- journey (enum) – Type of journey to launch
- uid (string) – User identity (can be
nil) - govVerification (boolean) – Enable or disable government verification
- ticketType (string) – Type of ticket (e.g., VIP, Standard)
- eventId (string) – Unique identifier for the event
- isActiveLiveness (boolean) – Enable or disable active liveness check
- isPassiveLiveness (boolean) – Enable or disable passive liveness check
- kioskMode (boolean) – Enable or disable kiosk mode
Return Parameters
- uid (string) – User identity
- token (string) – Authentication token
- payload (object) – Encrypted QR/Event payload data
- data (string) – Encrypted payload data (Base64 encoded)
- signature (string) – Digital signature for payload verification
Code Example
6. Embedded View (EventBiometricCheckIn)
Required Parameters
- journey (enum) – Type of journey to launch
- govVerification (boolean) – Enable or disable government verification
- eventId (string) – Unique identifier for the event
- callBack (function) – Callback executed after journey completion, returning
successstatus andQuepassIdentityKitOutputModel
Return Parameters
- 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 in the system
Code Example
7. EventBiometricCheckInKiosk
Required Parameters
- journey (string/enum) – Type of journey to launch
- govVerification (boolean) – Enable or disable government verification
- eventId (string) – Unique identifier for the event
- isActiveLiveness (boolean) – Enable or disable active liveness check
- isPassiveLiveness (boolean) – Enable or disable passive liveness check
- kioskMode (boolean) – Enable or disable kiosk mode
- documentType (enum) – Type of document used
- documentNumber (string) – Document number
- callBack (function) – Callback executed after journey completion, returning success status and response output
Return Parameters
- 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 in the system
Code Example
8. KioskMode
Required Parameters
- journey (string/enum) – Type of journey to launch
- govVerification (boolean) – Enable or disable government verification
- eventId (string) – Unique identifier for the event
- isActiveLiveness (boolean) – Enable or disable active liveness check
- isPassiveLiveness (boolean) – Enable or disable passive liveness check
- kioskMode (boolean) – Enable or disable kiosk mode
- callBack (function) – Callback executed after journey completion, returning
successstatus and response output
Return Parameters
- 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 in the system
Code Example
9. ExpressVerfication
Required Parameters
- journey (enum) – Type of journey to launch
- identifierType (string) – Type of identifier used
- identifierNumber (string) – Identifier number
- nationality (string) – Nationality of the user
Return Parameters
- uid (string) – User identity
- token (string) – Authentication token
- unifiedNumber (string) – Unified identification number (optional)
Code Example
10. ExpressOnboarding
Required Parameters
- journey (enum) – Type of journey to launch
- isActiveLiveness (boolean) – Enable or disable active liveness check
- isPassiveLiveness (boolean) – Enable or disable passive liveness check
- kioskMode (boolean) – Enable or disable kiosk mode
- identifierType (string) – Type of identifier used
- identifierNumber (string) – Identifier number
- nationality (string) – Nationality of the user
Return Parameters
- uid (string) – User identity
- token (string) – Authentication token
- unifiedNumber (string) – Unified identification number (optional)