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. Get User

​

Required Parameters

• uid (string) – User identity
• consentToken (string) – Consent token for authenticated operations
• piiOnly (boolean) – Indicates whether only personally identifiable information (PII) should be returned

​

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

// KioskFace.tsx — called after KioskMode journey finds a match
const piiOnly  = localStorage.getItem('piiOnly') === 'true';
const response = await Quepass.getUser(uid, token, piiOnly);

if (response?.code === 200) {
  // response.data is UserKycProfile | UserKycProfileGov
  setCustomerData(response.data);
} else {
  const msg = response?.errors?.[0]?.message ?? 'Profile not found.';
  setProfileError(msg);
}

​

2. Get Registrant

​

Required Parameters

• uid (string) – User identity
• consentToken (string) – Consent token for authenticated operations
• piiOnly (boolean) – Indicates whether only personally identifiable information (PII) should be returned
• 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

const res = await Quepass.getRegistrant(uid, eventId, token, false);
if (res.code === 200) { /* res.data — registrant profile */ }

​

3. GetKycCertificate

const res = await Quepass.getKycCertificate(uid, token);
if (res.code === 200) { /* res.data — certificate payload */ }