Skip to main content
POST
Record a scan

Authorizations

Authorization
string
header
required

Mobile token, global API token, series API key, or event API key. See Authentication above for which endpoints each one reaches.

Path Parameters

event_id
integer
required

Event id.

Body

application/json
participant_id
integer

participant_event id or participant id.

scan_context_id
integer

Required only when the event has multiple scan contexts.

badge_token
string
client_scan_id
string

Idempotency key.

source
string

Set to manual to record a manual scan.

scanned_at
string<date-time>

Defaults to now.

Response

Scan recorded (or an existing scan returned when deduplicated).

success
boolean
Example:

true

deduplicated
boolean

Present and true when an existing scan was returned.

first_scan_in_context
boolean

Absent on a deduplicated response.

scan
object
participant
object

Compact participant summary returned when recording a scan.