Skip to main content
POST
Scan an attendee
Checkpoint fields describe the upcoming checkpoint release. Deploy the matching server and updated scanners before using them on live tickets.

Redeem a checkpoint

For a regular ticket issued with checkpoint entitlements, provide a stable idempotency_key and the intended checkpoint_id. API keys act for their site owner; the owner/admin checkpoint selection does not let assigned staff override their account’s checkpoint. An optional event_id verifies the booked event, and device_id labels the audit record.
Keep the same request ID when retrying an interrupted attempt; generate a new one for a new scan or checkpoint. A committed checkpoint success returns 200 with checkpoint_result. Repeats and invalid admission return 409. A successful retry replays the original result only while the ticket and booked journey remain eligible. Ordinary ticket scans retain their 202 response. Each included checkpoint is redeemed once per ticket and booked occurrence. Scanning Entrance does not consume Activity 1, Activity 2 or Lunch. Checkpoint redemption requires internet access. Configure the entitlements and staff assignments using the illustrated Ticket checkpoints guide.

Authorizations

Authorization
string
header
required

ts-{uuid}-{secret}. Every key requires its independent secret.

Body

application/json
attendee_id
string
required
Example:

"attendee-uuid"

event_id
string

Optional expected event ID. The attendee must belong to this event.

checkpoint_id
string

Owner/admin selection. Assigned staff cannot override their checkpoint.

device_id
string

Optional scanner identifier for the redemption audit.

Maximum string length: 100
idempotency_key
string

Required stable request ID for checkpoint and membership admissions. Ordinary ticket scans use a shared five-second duplicate guard and do not provide long-term idempotency.

Pattern: ^[A-Za-z0-9_-]{16,128}$

Response

Checkpoint redemption durably committed or the same request replayed.

success
boolean
accepted
boolean
checkpoint_result
object