Documentation / Guides / Getting Started
Protocol specificationAPI referenceGuides
Documentation / Guides / Getting Started
GUIDE · V1

Getting Started

Enrollment, home screen, menu, language

Overview

The Scanner app is a native mobile application for iOS and Android. It is used by door staff and volunteers to scan ticket QR codes and check attendees in at events. The app works fully offline after initial setup.

First Launch

When you open the app for the first time, you see an empty home screen with the message: "No events registered yet. Scan a setup QR code to get started." and an Add Event button.

Enrolling in an Event

To start scanning tickets, you need to enroll your device for an event. The event organizer generates a setup QR code from the admin panel (Events > Scanners tab).

Enrollment Steps

  1. Tap Add Event (or the + icon on the home screen)
  2. Grant camera access when prompted
  3. Point the camera at the setup QR code provided by the organizer
  4. A confirmation modal appears with the enrollment details
  5. Tap Validate to confirm

Enrollment Confirmation

The confirmation modal displays:

Field Description
Event Name of the event
Organizer Name of the ticket issuer
Gate Specific gate identifier, or "All gates"
Valid until When this enrollment expires

After confirming, the device:

  • Receives an API key for this event
  • Downloads the issuer's public keys for signature verification
  • Syncs current ticket statuses from the server
  • Adds the event to the home screen

Enrollment Errors

Error Meaning
This setup code has expired The QR code's validity period has passed. Ask the organizer for a new one
Invalid setup code The QR is not a valid setup code
This setup code has already been used The token was already consumed by another device
This device is already registered for this event Remove the existing enrollment first from the Events screen
Network error Device is offline or server unreachable. An internet connection is required for initial enrollment

Home Screen

After enrolling in at least one event, the home screen shows your registered events as cards.

Each event card displays:

  • Event name
  • Date
  • Number of scans performed

Tap an event card to view its scan history.

At the bottom, the Scan Tickets button opens the camera scanner.

Tap the menu icon (three dots) in the top-right corner to access:

Menu Item Description
Registered Events View and manage all enrolled events
Pending Sync View check-ins waiting to sync (shows count badge if any)
About App information

Below the menu items, a language toggle lets you switch between English and French. Your language preference is saved and persists between app restarts.