Integrating External Check-In Systems
If you're using an external check-in system or building your own check-in solution, it's important to understand how Luma's QR codes work.
QR Code URL Structure
All Luma check-in QR codes follow this format:
https://luma.com/check-in/[event-id]?pk=[key]
Two Types of Keys
Luma uses two different key types in QR codes, each serving a specific purpose:
Guest Keys
- Found on tickets sent to guests via email
- Format: String starting with
g-
prefix (e.g.,g-abc123
) - When scanned, displays all the guest's tickets
- Allows checking in all tickets or selecting specific ones
- What guests will show on their phones
- Useful for events where guests might have multiple ticket types
Ticket Keys
- Found in CSV exports from the Guests tab
- Format: Shorter alphanumeric string (e.g.,
xyz789
) - Checks in a single specific ticket
- Each ticket has its own unique QR code in the export
- Best for tracking individual ticket usage
For External Check-In Systems
When building or configuring an external check-in system:
- Both key types are valid - Luma's check-in endpoint accepts both guest keys and ticket keys
- For single-ticket guests - Both keys achieve the same result
- For multi-ticket guests - Guest keys show all tickets and allow flexible check-in options, while ticket keys check in only the specific ticket
Common Integration Scenarios
Importing from CSV Export
The CSV export provides ticket keys (individual ticket QR codes). If your external system relies on matching exact QR codes that guests show on their phones, you'll need to account for the difference between ticket keys (in CSV) and guest keys (on guest tickets starting with g-
).
Pre-printed Badges Use the ticket keys from CSV exports for badges. These will check in the specific ticket associated with that QR code.
Mobile Scanning Apps Ensure your app can handle both URL formats. The check-in endpoint response will be the same for both valid key types.
API Access
The Luma API provides endpoints for looking up guests using either key type:
Get Guest by Key (https://public-api.luma.com/v1/event/get-guest
)
To use this endpoint:
- Extract the
pk
parameter from the QR code URL (e.g., fromhttps://luma.com/check-in/evt-123?pk=g-abc123
, extractg-abc123
) - Make a GET request to:
https://public-api.luma.com/v1/event/get-guest?id={pk_value}
- The API automatically detects whether it's a guest key (starting with
g-
) or ticket key and returns the guest information - This works for both key types - no need to differentiate them in your code
Example request:
GET https://public-api.luma.com/v1/event/get-guest?id=g-abc123
This endpoint is perfect for real-time guest lookup in external check-in systems and provides full guest details including registration status, tickets, and check-in information.
Troubleshooting
If QR codes aren't matching between your system and guest tickets:
- Verify you're comparing the correct key types
- Remember that CSV exports contain ticket keys (shorter alphanumeric), while guest emails contain guest keys (starting with
g-
) - Both types will work for check-in through Luma's system
- Consider whether your use case requires specific key types
For additional support with external integrations, contact our support team with details about your check-in system.