Attendee Check-In API

An Attendee's presence at an Event can be recorded using the application's check-in feature.  Check-ins may be performed at the event level, or for specific sessions or activities, using the administrative portal, the mobile scanning progressive web application, or the API.

The following instructions apply specifically to implementing check-ins through the API for either "Event" check-in or "Session" check-in.

Event Check-In Endpoint

The event check-in endpoint can be used to check an attendee into the event.

POST https://secure.erbium.com/api/attendee/{attendee ID}/check-in

{attendee ID} is a placeholder for the attendee ID, which is `a-` followed by a sequence of letters and digits.

Request

The request payload is a JSON object with a single key, timestamp, which can have one of the following values:

• true, which sets the attendee’s check-in timestamp to the current date and time.
• A string containing the ISO 8601 timestamp in the UTC time zone of the specific date and time when the user checked in, e.g. "2023-07-24T22:18:00Z".
• null, which clears the attendee’s check-in date and time, e.g. to undo an erroneous check-in.

Response

The event check-in endpoint does not return a response body.

Success is indicated by the 204 HTTP status code.

Errors are indicated by the HTTP status code 400, where the body is a JSON object with the error indicated under the "error" key. The following error codes may be reported:

• "attendee-not-found" - An attendee with the given ID was not found in this event.
• "attendee-not-registered" - The attendee has not yet completed registration.
• "attendee-cancelled" - The attendee has been cancelled by an administrator.
• "already-checked-in" - The attendee has already been checked into the event.

Session Check-In Endpoint

The session check-in endpoint can be used to check an attendee into an agenda activity or selection widget answer for which Enable Scanning is selected.

POST https://secure.erbium.com/api/attendee/{attendee ID}/check-in/{session ID}

{attendee ID} is a placeholder for the attendee ID, which is `a-` followed by a sequence of letters and digits.

{session ID} is a placeholder for the session ID, which is `sb-` followed by a sequence of letters and digits.

The session ID can be determined from the event metadata API (`GET https://secure.erbium.com/api/event/{event ID}/metadata`) from the path `time-slots/activities` (under an agenda widget) or the path `answers` (under a selection widget).

IMPORTANT NOTE:  When an Attendee is checked into a Session, they will automatically be checked into the Event if they have not already been checked in.

Request

The request payload is a JSON object with a single key, timestamp, which can have one of the following values:

• true, which sets the attendee’s check-in timestamp to the current date and time.
• A string containing the ISO 8601 timestamp in the UTC time zone of the specific date and time when the user checked in, e.g. "2023-07-24T22:18:00Z".

Response

The session check-in endpoint does not return a response body.

Success is indicated by the 204 HTTP status code.

Errors are indicated by the HTTP status code 400, where the body is a JSON object with the error indicated under the `"error"` key. The following error codes may be reported:

• "attendee-not-found" - An attendee with the given ID was not found in this event.
• "attendee-not-registered" - The attendee has not yet completed registration.
• "attendee-cancelled" - The attendee has been cancelled by an administrator.
• "already-checked-in" - The attendee has already been checked into the event.
• "walk-ins-not-accepted" - The attendee has not selected this session.
• "session-full" - The session has reached configured capacity.