Skip to main content

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

Quepass.launchJourney(    
        journey: String,    
        govVerification: Bool? = nil,    
        eventId: String? = nil,    
        uid: String? = nil,    
        ticketType: String? = nil,    
        data: String? = nil,    
        signature: String? = nil,    
        isActiveLiveness: Bool = false,    
        isPassiveLiveness: Bool = false,    
        kioskMode: Bool = false,    
        documentType: DocumentType? = nil,    
        documentNumber: String? = nil,    
        documentNumberType: DocumentSearchType? = nil,    
        documentNumberTypeString: String? = nil,    
        biometricType: BiometricType? = nil,    
        callBack: @escaping (Bool, CognetIdentityKitOutputModel) -> Void    
    ) -> UIViewController?    

2. Required Parameters by Journey

JourneyRequired Parameters
Onboardingjourney, isActiveLiveness, isPassiveLiveness, kioskMode, documentType
Authenticationjourney, govVerification, eventId, isActiveLiveness, isPassiveLiveness, kioskMode, documentNumber, documentNumberType, biometricType
Transactionjourney, govVerification, eventId, isActiveLiveness, isPassiveLiveness, kioskMode, uid, biometricType
Searchjourney, govVerification, eventId, isActiveLiveness, isPassiveLiveness, kioskMode, biometricType
EventQRRegistrationjourney, uid, govVerification, ticketType, eventId, isActiveLiveness, isPassiveLiveness, kioskMode
EventBiometricCheckInjourney, govVerification, eventId, callBack
EventQRCheckInjourney, data, signature, eventId
EventBiometricCheckInKioskjourney, govVerification, eventId, isActiveLiveness, isPassiveLiveness, kioskMode, documentType, documentNumber, callBack
KioskModejourney, govVerification, eventId, isActiveLiveness, isPassiveLiveness, kioskMode, callBack
ExpressVerificationjourney, identifierType, identifierNumber, nationality
ExpressOnboardingjourney, 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

    Quepass.lounchJourney(    
        journey: CognetJourney.onboarding,    
        isActiveLiveness: true,    
        isPassiveLiveness: true,    
        kioskMode: false,    
        documentType: .idCard    
    ) { status, output in    
        if status, let data = output.data {    
            let uid = data["uid"] as? String    
            let token = data["token"] as? String    
        } else {    
            let error = output.errors?.first?.message ?? "Registration failed"    
        }    
    }    

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

    Quepass.lounchJourney(    
        journey: CognetJourney.authentication,    
        govVerification: true,    
        eventId: "",    
        isActiveLiveness: true,    
        isPassiveLiveness: true,    
        kioskMode: false,    
        documentNumber: "DOC123",    
        documentNumberType: .idCard,    
        biometricType: .face    
    ) { status, output in    
        if status, let data = output.data {    
            let uid = data["uid"] as? String    
            let token = data["token"] as? String    
        }    
    }

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

    Quepass.lounchJourney(    
        journey: CognetJourney.transaction,    
        govVerification: true,    
        eventId: "",    
        isActiveLiveness: true,    
        isPassiveLiveness: true,    
        kioskMode: false,    
        uid: "user-uid",    
        biometricType: .face    
    ) { status, output in    
        if status { /* Transaction verified */ }    
    }    

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

    Quepass.lounchJourney(    
        journey: CognetJourney.search,    
        govVerification: true,    
        eventId: "",    
        isActiveLiveness: true,    
        isPassiveLiveness: true,    
        kioskMode: false,    
        biometricType: .face    
    ) { status, output in    
        if status, let data = output.data {    
            let uid = data["uid"] as? String    
        }    
    }    

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

    Quepass.lounchJourney(    
        journey: CognetJourney.eventQRRegistration,    
        uid: nil,    
        govVerification: true,    
        ticketType: "VIP",    
        eventId: "event-123",    
        isActiveLiveness: true,    
        isPassiveLiveness: true,    
        kioskMode: false    
    ) { success, output in    
        if success, let data = output.data {    
            let payload = data["payload"] as? [String: Any]    
            let qrData = payload?["data"] as? String    
            let signature = payload?["signature"] as? String    
        }    
    }    

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 success status and QuepassIdentityKitOutputModel

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

    if let vc = Quepass.lounchJourney(    
        journey: QuepassJourney.kioskMode,    
        govVerification: true,    
        eventId: "event-123",    
        callBack: { success, output in    
            if success, let data = output.data {    
                let uid = data["uid"] as? String    
            }    
        }    
    ) {    
        present(vc, animated: true)    
    }    
         
 
Response: QuepassIdentityKitOutputModel
         
    public struct QuepassIdentityKitOutputModel {    
        public var code: Int           // 200, 400, etc.    
        public var data: [String: Any]? // Response payload    
        public var errors: [APIErrorModel]?    
    }    
         
    public struct APIErrorModel {    
        public let code: Int    
        public let message: String    
        public let details: String    
    }    
         

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

guard let controller = Quepass.launchJourney(
            journey: "EventBiometricCheckInKiosk",
            govVerification: SettingsManager.shared.settings.GovIntegration,
            eventId: eventId,
            isActiveLiveness: isActiveLiveness, isPassiveLiveness: isPassiveLiveness, kioskMode: kioskMode, documentType: documentNumberType, documentNumber: documentNumber,
            callBack: { success, output in
                print(output, "output")
                context.coordinator.handleCallback(success: success, output: output)
            }
        ) else {
            print("Failed to create embedded Event Check-In view.")
            return UIViewController()
        }

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 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

guard let controller = Quepass.launchJourney(
            journey: "KioskMode",
            govVerification: SettingsManager.shared.settings.GovIntegration,
            eventId: eventId,
            isActiveLiveness: isActiveLiveness,
            isPassiveLiveness: isPassiveLiveness,
            kioskMode: kioskMode,
            callBack: { success, output in
                print(output, "output")
                context.coordinator.handleCallback(success: success, output: output)
            }
        ) else {
            print("Failed to create embedded Event Check-In view.")
            return UIViewController()
        }

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

Quepass.launchJourney(
            journey: expressVerification,
            identifierType: identifierType,
            identifierNumber: String,
            nationality: String
        ) { status, response in
            print(response)
        }

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)

Code Example

Quepass.launchJourney(
            journey: QuepassJourney.ExpressOnboarding,
            isActiveLiveness: SettingsManager.shared.settings.activeLiveness, isPassiveLiveness: SettingsManager.shared.settings.passiveLiveness, kioskMode: SettingsManager.shared.settings.kioskMode, identifierType: identifierType,
            identifierNumber: identifierNumber,
            nationality: nationalityParam
        ) { status, response in
            if !status {
                errorMessage = response.errors?.first?.message ?? "Fastrack registration failed"
                showErrorAlert = true
            } else {
                if let dataDict = response.data,
                   let jsonData = try? JSONSerialization.data(withJSONObject: dataDict, options: [.prettyPrinted]),
                   let jsonString = String(data: jsonData, encoding: .utf8) {
                    result = jsonString
                } else {
                    result = "Registration completed"
                }
 
            }
        }