Scan at the door

Your own scanning app, handheld readers or turnstiles, checking tickets against the same door list and rules as the EOS scanner.

The EOS scanner first

Most doors need no code at all: stewards sign in at eos.aveoevents.com on a phone and open the Door scanner, which reads ticket QR codes with the camera. Use the API when you have turnstiles, handheld readers or an app of your own. Both share one door log, so they can work side by side at the same event.

1. A key for the door

Make a key from the Door scanning starting point: read events, read guests, read check-ins and check guests in. Make one per door system so you can switch one off alone, and lock it to the venue’s IP address if it is fixed. Never put a secret key inside an app you hand out: the app talks to your server, and your server talks to EOS.

2. The event and its gates

Each event has one or more gates, set in EOS. A gate may let in everyone, or only some kinds of pass, such as a VIP door. Read them from the event and send the gate’s id with every scan. Leave it out and the first gate is used.

Request
curl "https://eos.aveoevents.com/api/v1/events/41" \
  -H "Authorization: Bearer $EOS_API_KEY"
Part of the response
{
  "gates": [
    {
      "id": "main",
      "name": "Main entrance",
      "allow": []
    },
    {
      "id": "vip",
      "name": "VIP door",
      "allow": [
        "vip",
        "guest",
        "artist",
        "press",
        "staff",
        "crew",
        "security"
      ]
    }
  ],
  "reentry": true
}

3. Scan

Send whatever the reader read: the QR’s contents, the typed code (A-7Q2KX9) or a link to the ticket all work. Use "mode": "exit" when guests leave, if the event allows re-entry.

Request
curl -X POST "https://eos.aveoevents.com/api/v1/events/41/check-ins" \
  -H "Authorization: Bearer $EOS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"code":"A-7Q2KX9","gate":"main"}'
200 response
{
  "object": "check_in",
  "event_id": 41,
  "attendee_id": "A-7Q2KX9",
  "result": "admitted",
  "ok": true,
  "message": "Admit",
  "name": "Sam Taylor",
  "ticket_type": "General admission",
  "gate": "Main entrance",
  "mode": "entry",
  "age": 27,
  "note": null,
  "addons": [
    "Cloakroom"
  ],
  "first_scan": null,
  "door_payment": null,
  "created_at": "2026-12-05T19:02:11.000Z"
}

A scan always answers 200 when it was checked, whether the guest may pass or not: ok says which. Show message to the steward as it is, with name, ticket_type, age and any note (such as “Check ID”) and addons to hand over.

Results

resultDoorMeaning
admittedLet inA valid ticket, first time through.
readmittedLet inBack in after scanning out, at an event that allows re-entry.
exitedOutScanned out (mode exit).
staffLet inA staff pass of the company, with its access in message.
payment_dueTake paymentA ticket paid at the door that the door has not been paid for. door_payment has the amount; once it is taken, scan again with paid_at_door true and the guest is let in.
duplicateStopAlready inside. first_scan says when and at which gate; message says the same for the steward.
wrong_gateStopThis ticket is not let in at this gate. message names the gates that do let it in.
not_insideStopScanned out without having been scanned in.
invalidStopNot a ticket for this event, cancelled, revoked, or outside its age limit. message says which.

Each ticket gets in once, whichever door, app or person scans it: every scanner shares one door log, so a ticket shown twice is caught at any gate.

Ages and staff passes

  • When a ticket type has an age limit, the buyer gives each guest’s date of birth at checkout. A guest outside the limit on the day is refused with invalid, and their age is in age.
  • A ticket with an age limit and no date of birth is let in with note asking the steward to check ID.
  • Your team’s staff passes scan too: result is staff and message says where they may go. Staff passes are never guests, so they are not in attendee_id or in webhooks.
  • A ticket type sold as paid at the door answers payment_due until the door takes its price: door_payment has the amount and currency, and message reads, for example, “£15.00 payment needed to enter”. Take the money, then send the same scan with "paid_at_door": true: the payment is recorded against the ticket and the guest is let in (door_payment.paid is true).

Who is inside

  • Get a guest says whether they are inside now (checked_in) and when they last got in.
  • List check-ins gives every scan, newest first, from every scanner.
  • The attendee.checked_in and attendee.checked_out webhooks tell your systems as it happens, including scans made with the EOS scanner and check-ins by hand.

At a busy door

  • Each scan is checked live, so keep scanners online. A scan takes one request: set the key’s limit to cover your busiest minute across all its scanners.
  • If a request gets no answer, scan again: a second scan of an admitted ticket answers duplicate with the first scan’s time, so nothing is counted twice.
  • Test with real tickets from a free ticket type on a test event before doors open.
Node.js
// your server, called by your door app
app.post("/door/scan", async (req, res) => {
  const r = await fetch(`https://eos.aveoevents.com/api/v1/events/${req.body.eventId}/check-ins`, {
    method: "POST",
    headers: { Authorization: `Bearer ${process.env.EOS_DOOR_KEY}`, "Content-Type": "application/json" },
    body: JSON.stringify({ code: req.body.code, gate: req.body.gate, mode: req.body.mode ?? "entry" }),
  });
  const scan = await r.json();
  if (!r.ok) return res.status(502).json({ ok: false, message: "Door list unavailable: " + scan.error.message });
  res.json({ ok: scan.ok, message: scan.message, name: scan.name, note: scan.note, addons: scan.addons });
});