User Data

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. User Data (after login)

​

Required Parameters

• token (string) – Consent token for authentication
• pii_Only (boolean) – Whether to fetch only PII data
• eventId (string) – Unique identifier for the event
• uid (string) – User identity

​

Return Parameters

• uid (string) – User identity
• fullName (string) – Full name of the user
• sex (string) – Gender (M/F/Other)
• nationality (string) – Nationality of the user
• dateOfBirth (string) – Date of birth (ISO format: YYYY-MM-DD)
• documents (array of object) – List of user documents:
   documentName (string) – Name of the document
   identityCardNumber (string) – ID number
   bookletNumber (string) – Booklet/passport number
   dateOfIssue (string) – Issue date (ISO format)
   dateOfExpiry (string) – Expiry date (ISO format)
   placeOfRegistration (string) – Place of registration
   issuingStateName (string) – Issuing country/state
• biometrics (object) – Biometric data:
   face_Base64 (string) – Face image in base64
   palm (object) – Palm data
   vein (object) – Vein data
   iris (object) – Iris data
   fingers (object) – Fingers data
• creationTime (string) – Record creation timestamp (ISO)
• lastUpdateTime (string) – Last update timestamp (ISO)
• dataWarnings (array of objects) – Warnings related to specific fields in the user data:
   fieldName (string) – Name of the field that triggered the warning (e.g., VerificationLevel)
   warningMessage (string) – Description of the warning (e.g., “Record not Government verified”)
   currentValue (string) – Current value of the field when the warning was generated
   createdAt (string) – Timestamp when the warning was created (ISO 8601 format)

​

Code Example

    Quepass.getUserData(    
        token: consentToken,    
        pii_Only: false,    
        eventId: eventId,    
        uid: uid    
    ) { status, response in    
        if status, let data = response.data {    
            // Use profile data    
        }    
    }    

​

2. Registrant Data (after event check-in)

​

Required Parameters

• token (string) – Consent token for authentication
• pii_Only (boolean) – Whether to fetch only PII data
• eventId (string) – Unique identifier for the event
• uid (string) – User identity

​

Return Parameters

• uid (string) – User identity
• fullName (string) – Full name of the user
• clientId (string) – Client identifier
• clientName (string) – Client name
• eventId (string) – Event identifier
• eventName (string) – Event name
• ticketType (string) – Type of ticket
• accessType (string) – Access type (e.g., Single, Multiple)
• registeredAt (string) – Registration timestamp (ISO format)
• isCheckedIn (boolean) – Whether user has checked in
• lastCheckedInAt (string) – Last check-in timestamp (ISO format)
• status (string) – Registration status (e.g., Confirmed, Pending)
• base64_image (string) – User image in base64

​

Code Example

    Quepass.getRegistrantData(    
        token: consentToken,    
        pii_Only: false,    
        eventId: eventId,    
        uid: uid    
    ) { status, response in    
        if status, let data = response.data {    
            let registrant = data["registrant"] as? [String: Any]    
        }    
    }    

​

3. GetKycCertificate

Quepass.getKycCertificate(uid: "USER_UID") { success, data in
    if success, let certificate = data {
        print("KYC Certificate:", certificate)
    } else {
        print("Failed to fetch KYC certificate")
    }
}