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.

This step retrieves profile and related information using the UID and consentToken returned after a successful journey. These values are used to call SDK methods to fetch user profile data after login, registrant details after event check-in, download the KYC certificate, and retrieve SDK capability information such as the installed SDK version. Ensure that a valid UID and consentToken are provided before calling these methods.

​
1. User Data (after login)

​
Required Parameters

  • uid (string) – User identity
  • token (string) – Authentication token

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

​
Code Example

SDK.getUserDetails(uId = uID.toString(), consentToken = consentToken, onlyPii = sdkManager.piiOnly) { result ->
    Log.e("getUserDetails:", "Response: $result")
    context.lifecycleScope.launch(Dispatchers.Main) {
        when(result) {
            is ApiFunctionsResult.Loading -> Log.e("getUserDetails", "Loading...") // show loading
            is ApiFunctionsResult.Success -> {
                context.showLoader = false
                result.data?.let {
                    val userDetails = Gson().fromJson(it.toString(), Customer::class.java)
                    user(userDetails)
                } ?: showMessage(context, result.errors.safeErrorMessage())
            }
            is ApiFunctionsResult.Failure -> {
                context.showLoader = false
                Log.e("getUserDetails:", "Failed: ${result.errors?.toString()}")
                // show message to user
            }
        }
    }
}

​
2. Registrant Data (after event check-in)

​
Required Parameters

  • uid (string) – User identity
  • token (string) – Authentication token
  • eventId (string) – Unique identifier for the event

​
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

SDK.getRegistrantDetails(uId = uID.toString(), consentToken = consentToken, onlyPii = sdkManager.piiOnly) { result ->
    Log.e("getRegistrantDetails:", "Response: $result")
    context.lifecycleScope.launch(Dispatchers.Main) {
        when(result) {
            is ApiFunctionsResult.Loading -> Log.e("getRegistrantDetails", "Loading...") // show loading
            is ApiFunctionsResult.Success -> {
                context.showLoader = false
                result.data?.let {
                    val userDetails = Gson().fromJson(it.toString(), Customer::class.java)
                    user(userDetails)
                } ?: showMessage(context, result.errors.safeErrorMessage())
            }
            is ApiFunctionsResult.Failure -> {
                context.showLoader = false
                Log.e("getRegistrantDetails:", "Failed: ${result.errors?.toString()}")
                // show message to user
            }
        }
    }
}

​
3. GetKycCertificate

SDK. getKycCertificate ( 
    uId = uID.toString(), consentToken = consentToken,evenetId=””) { result -> 
    //  ALWAYS switch to Main thread for UI 
    Log.e(" getRegistrantDetails: ", " Response: $result") 
    context.lifecycleScope.launch(Dispatchers.Main) { 
 
        when (result) {   
 is ApiFunctionsResult.Loading -> { 
                Log.e(" getKycCertificate ", "Loading...") // show loading } 
            is ApiFunctionsResult.Success -> { // data  
                context.showLoader = false // hide loading 
                if (result.data != null) { 
                    val userDetails = Gson().fromJson(result.data.toString(), Customer::class.java) 
                   user(userDetails) 
                } else { 
                    val message = result.errors.safeErrorMessage() 
                    showMessage(context, message) 
                } 
            } 
              is ApiFunctionsResult.Failure -> {  context.showLoader = false // hide  
  Log.e(" getKycCertificate: ", "Failed : Response: ${result.errors?.toString()}") // show message to user }  } }}