Scan an attendee
curl --request POST \
--url https://ticketspotapp.com/api/api/v2/scan \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"attendee_id": "attendee-uuid"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({attendee_id: 'attendee-uuid'})
};
fetch('https://ticketspotapp.com/api/api/v2/scan', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://ticketspotapp.com/api/api/v2/scan"
payload = { "attendee_id": "attendee-uuid" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"success": true,
"accepted": true,
"checkpoint_result": {
"isValid": true,
"code": "<string>",
"checkpoint_id": "<string>",
"checkpoint_name": "<string>",
"redeemed_at": "2023-11-07T05:31:56Z",
"message": "<string>",
"replayed": true
}
}{
"success": true,
"accepted": true,
"attendee": {
"id": "<string>",
"event_id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"status": "<string>",
"ticket_id": "<string>",
"checkin_scan_count": 123,
"created_at": "2023-11-07T05:31:56Z"
},
"ticket_validity": {
"isValid": true,
"reason": "<string>",
"reason_description": "<string>"
}
}{
"error": "<string>",
"code": "<string>",
"message": "<string>"
}{
"error": "<string>",
"code": "<string>",
"message": "<string>"
}{
"error": "<string>",
"code": "<string>",
"message": "<string>"
}{
"error": "<string>",
"code": "<string>",
"message": "<string>"
}{
"error": "<string>",
"code": "<string>",
"message": "<string>"
}{
"error": "<string>",
"code": "<string>",
"message": "<string>"
}{
"error": "<string>",
"code": "<string>",
"message": "<string>"
}{
"error": "<string>",
"code": "<string>",
"message": "<string>"
}{
"error": "<string>",
"code": "<string>",
"message": "<string>"
}API Reference
Scan an attendee
Validate an attendee’s admission and submit a check-in through the developer API.
POST
/
scan
Scan an attendee
curl --request POST \
--url https://ticketspotapp.com/api/api/v2/scan \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"attendee_id": "attendee-uuid"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({attendee_id: 'attendee-uuid'})
};
fetch('https://ticketspotapp.com/api/api/v2/scan', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://ticketspotapp.com/api/api/v2/scan"
payload = { "attendee_id": "attendee-uuid" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"success": true,
"accepted": true,
"checkpoint_result": {
"isValid": true,
"code": "<string>",
"checkpoint_id": "<string>",
"checkpoint_name": "<string>",
"redeemed_at": "2023-11-07T05:31:56Z",
"message": "<string>",
"replayed": true
}
}{
"success": true,
"accepted": true,
"attendee": {
"id": "<string>",
"event_id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"status": "<string>",
"ticket_id": "<string>",
"checkin_scan_count": 123,
"created_at": "2023-11-07T05:31:56Z"
},
"ticket_validity": {
"isValid": true,
"reason": "<string>",
"reason_description": "<string>"
}
}{
"error": "<string>",
"code": "<string>",
"message": "<string>"
}{
"error": "<string>",
"code": "<string>",
"message": "<string>"
}{
"error": "<string>",
"code": "<string>",
"message": "<string>"
}{
"error": "<string>",
"code": "<string>",
"message": "<string>"
}{
"error": "<string>",
"code": "<string>",
"message": "<string>"
}{
"error": "<string>",
"code": "<string>",
"message": "<string>"
}{
"error": "<string>",
"code": "<string>",
"message": "<string>"
}{
"error": "<string>",
"code": "<string>",
"message": "<string>"
}{
"error": "<string>",
"code": "<string>",
"message": "<string>"
}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 stableidempotency_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.
{
"attendee_id": "YOUR_BOOKED_TICKET_ID",
"event_id": "YOUR_BOOKED_EVENT_ID",
"checkpoint_id": "YOUR_CHECKPOINT_ID",
"idempotency_key": "YOUR_UNIQUE_SCAN_REQUEST_ID",
"device_id": "entrance-scanner-01"
}
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
Body
application/json