> ## Documentation Index
> Fetch the complete documentation index at: https://apidocs.sessionboard.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Check someone in

> Record that a person arrived — from a partner's scanner, kiosk or door app. Name the
registration one of three ways, in this order of precedence:

1. `registration_id` — the registration's ID.
2. `email` — the registrant's email, among registrations that are `confirmed`,
   `checked_in`, `pending_approval` or `waitlisted`.
3. `badge_code` — the code scanned from the attendee's QR: the `sb-checkin:<id>` code
   in the confirmation email, or the code on a printed or in-app badge.

A `confirmed`, `pending_approval` or `waitlisted` registration becomes `checked_in`,
with `checked_in_at` set to `checked_in_at` from the request or now.

**Idempotent.** Checking in someone already checked in changes nothing and answers
`200` with `already_checked_in: true`; the original `checked_in_at` stays.

A registration in any other status (`canceled`, `declined`, `transferred`,
`incomplete`, `no_show`) is not checked in and answers `409 CONFLICT` with
`details.reason: wrong_status` and the registration's status in `details.status`.

Recorded in the event's History as an API change. Requires `write:registrations`.




## OpenAPI

````yaml /api-reference/openapi.yaml post /v1/event/{eventId}/check-ins
openapi: 3.1.0
info:
  title: Sessionboard Public API
  version: '1.0'
  description: >-
    REST API for managing sessions, speakers, contacts, sponsors, exhibitors,
    and event data on the Sessionboard platform.
  contact:
    name: Sessionboard Support
    email: support@sessionboard.com
  termsOfService: https://www.sessionboard.com/legal/terms-of-service
servers:
  - url: https://public-api.sessionboard.com
    description: US Region
  - url: https://public-api-eu.sessionboard.com
    description: EU Region
security:
  - ApiKey: []
  - BearerToken: []
tags:
  - name: Events
    description: Manage events on the platform.
  - name: Sessions
    description: Search and retrieve sessions within an event.
  - name: Session Writes
    description: >-
      Create, update, delete, and restore sessions. Requires the
      `write:sessions` scope.
  - name: Contact Writes
    description: >-
      Create, update, delete, and restore contacts. Requires the
      `write:contacts` scope.
  - name: Exhibitor Writes
    description: >-
      Create, update, delete, and restore exhibitors. Requires the
      `write:exhibitors` scope.
  - name: Sponsor Writes
    description: >-
      Create, update, delete, and restore sponsors. Requires the
      `write:sponsors` scope.
  - name: Field Writes
    description: >-
      Create, update, and delete custom fields. Requires the `write:fields`
      scope.
  - name: Speakers
    description: Search and retrieve speakers within an event.
  - name: Participants
    description: |
      Search and retrieve every contact holding a session role on an event —
      speakers, chairpersons, moderators and custom roles — with the roles
      each one holds, and list the event's participant roles.
  - name: Contacts
    description: Search and retrieve contacts at the organization or event level.
  - name: Sponsors
    description: Search and retrieve sponsors within an event.
  - name: Exhibitors
    description: Search and retrieve exhibitors within an event.
  - name: Event Settings
    description: >-
      Retrieve event configuration such as fields, tags, tracks, rooms, formats,
      levels, languages, and session statuses.
  - name: GDPR
    description: Manage GDPR data access and erasure requests.
  - name: Insights
    description: >-
      Query event data using SbQL, generate queries with AI, and manage
      dashboards.
  - name: Ask
    description: >-
      Ask a natural-language question about one event and get a cited answer.
      Requires the `read:ask` scope, granted explicitly.
  - name: Metadata Writes
    description: >-
      Create, update, and delete session metadata (rooms, tracks, tags, formats,
      levels, languages, statuses). Requires the `write:metadata` scope.
  - name: Agenda Planning
    description: >-
      Manage agenda drafts, draft sessions, scheduling rules, and evaluation
      personas. Requires the `write:events` scope.
  - name: Dashboards & Widgets
    description: >-
      Create, read, update, and delete dashboards and widgets at the event or
      organization level. Requires `write:events` scope for writes.
  - name: Reports & Queries
    description: >-
      Create, read, update, delete, and run saved SbQL queries/reports at the
      event or organization level. Requires `write:events` scope for writes.
  - name: Transcriptions
    description: >-
      Transcript text on sessions — fragments, summaries, insights, and
      translations. Requires `read:transcriptions` / `write:transcriptions`
      scopes.
  - name: Session Recordings
    description: >-
      Session audio files for recording archives (live capture or imported
      audio). Requires `read:transcriptions` / `write:transcriptions` scopes.
  - name: Media
    description: >-
      Upload video or audio files for automatic transcription. Requires
      `read:media` / `write:media` scopes.
  - name: Session Files
    description: >
      Documents attached to sessions (PDFs, PowerPoint, Word, images, and
      similar).

      Simple upload: `POST .../files/upload` (multipart, max 50 MB).

      Direct-to-storage: create → PUT → complete (max 500 MB).

      Requires `read:sessions` / `write:sessions` scopes.

      See the [Uploading session files](/guides/uploading-session-files) guide.
  - name: OAuth
    description: >-
      OAuth 2.1 endpoints for AI client authorization (Claude, ChatGPT). Mounted
      at `/oauth/` (not `/v1/`).
  - name: Log Export
    description: >
      Pull your organization's API request, security and audit logs into a SIEM

      such as Splunk, Microsoft Sentinel or Elastic. Requires a dedicated API
      token

      with the `read:audit_logs` scope, which can call nothing else.

      See the [Exporting logs to a SIEM](/guides/exporting-logs-to-a-siem)
      guide.
  - name: Awards
    description: >-
      Read and manage Awards programs and their categories, rounds, promo codes,
      submissions and reviews. Organization-level: paths start at
      `/v1/organization/{orgId}/awards`. Requires `read:awards` / `write:awards`
      scopes.
  - name: Registration
    description: >
      Registration inside Sessionboard: registration forms, ticket types,
      registrations,

      orders, attendees and check-ins for one event. Requires the preview scopes

      `read:registrations` / `write:registrations`, which a token or OAuth
      client gets only

      when they are named explicitly (not by default, and not listed in
      `scopes_supported`).

      The event must have Registration turned on (Early Access); otherwise every
      endpoint

      answers `403 FORBIDDEN`.

      See the [Registration and Expo](/guides/registration-and-expo) guide.
  - name: Expo
    description: >
      Expo floor-map booths and sponsorship inventory for one event. Requires
      the preview

      scopes `read:expo` / `write:expo`, which a token or OAuth client gets only
      when they are

      named explicitly (not by default, and not listed in `scopes_supported`).
      The event must

      have Expo turned on (Early Access); otherwise every endpoint answers `403
      FORBIDDEN`.

      See the [Registration and Expo](/guides/registration-and-expo) guide.
paths:
  /v1/event/{eventId}/check-ins:
    post:
      tags:
        - Registration
      summary: Check someone in
      description: >
        Record that a person arrived — from a partner's scanner, kiosk or door
        app. Name the

        registration one of three ways, in this order of precedence:


        1. `registration_id` — the registration's ID.

        2. `email` — the registrant's email, among registrations that are
        `confirmed`,
           `checked_in`, `pending_approval` or `waitlisted`.
        3. `badge_code` — the code scanned from the attendee's QR: the
        `sb-checkin:<id>` code
           in the confirmation email, or the code on a printed or in-app badge.

        A `confirmed`, `pending_approval` or `waitlisted` registration becomes
        `checked_in`,

        with `checked_in_at` set to `checked_in_at` from the request or now.


        **Idempotent.** Checking in someone already checked in changes nothing
        and answers

        `200` with `already_checked_in: true`; the original `checked_in_at`
        stays.


        A registration in any other status (`canceled`, `declined`,
        `transferred`,

        `incomplete`, `no_show`) is not checked in and answers `409 CONFLICT`
        with

        `details.reason: wrong_status` and the registration's status in
        `details.status`.


        Recorded in the event's History as an API change. Requires
        `write:registrations`.
      operationId: create-check-in
      parameters:
        - $ref: '#/components/parameters/EventId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckInRequest'
            examples:
              by_badge:
                summary: Scanned badge
                value:
                  badge_code: sb-checkin:5d4c3b2a-1f0e-4d9c-8b7a-6f5e4d3c2b1a
              by_email:
                summary: Looked up by email, with the scan time
                value:
                  email: priya.raman@example.org
                  checked_in_at: '2026-11-10T13:02:55Z'
      responses:
        '200':
          description: 'Already checked in — nothing changed (`already_checked_in: true`).'
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/CheckIn'
        '201':
          description: Checked in.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/CheckIn'
              example:
                data:
                  id: 5d4c3b2a-1f0e-4d9c-8b7a-6f5e4d3c2b1a
                  status: checked_in
                  first_name: Priya
                  last_name: Raman
                  email: priya.raman@example.org
                  company: Northwind Health
                  job_title: Clinical Director
                  ticket_type_id: 0b9d6a3c-2e1f-4a5b-9c8d-7e6f5a4b3c2d
                  registrant_type_id: null
                  account_id: null
                  checked_in_at: '2026-11-10T13:02:55.000Z'
                  updated_at: '2026-11-10T13:02:55.412Z'
                  already_checked_in: false
        '401':
          $ref: '#/components/responses/RegistrationUnauthorized'
        '403':
          $ref: '#/components/responses/RegistrationForbidden'
        '404':
          description: >
            `NOT_FOUND` — no registration on this event matches the
            `registration_id`,

            `email` or `badge_code`, or none of them was sent.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegistrationApiError'
              example:
                error: NOT_FOUND
                message: No registration matches that registration, badge or email
        '409':
          description: >
            `CONFLICT` — the registration's status does not allow check-in

            (`details.reason: wrong_status`; `details.status` names the status).
            Nothing changes.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegistrationApiError'
              example:
                error: CONFLICT
                message: This registration is canceled and cannot be checked in
                details:
                  reason: wrong_status
                  status: canceled
        '429':
          $ref: '#/components/responses/RegistrationTooManyRequests'
components:
  parameters:
    EventId:
      name: eventId
      in: path
      required: true
      schema:
        type: integer
      description: Event ID
  schemas:
    CheckInRequest:
      type: object
      description: Send one of `registration_id`, `email` or `badge_code`.
      properties:
        registration_id:
          type: string
          format: uuid
          description: >-
            Takes precedence over `email` and `badge_code`. A value that is not
            a UUID is ignored.
        email:
          type: string
          description: Used when there is no `registration_id`. Case-insensitive.
        badge_code:
          type: string
          description: >-
            The scanned code — `sb-checkin:<registration id>` from the
            confirmation email, or a printed or in-app badge code. Used when
            neither of the others is sent.
        checked_in_at:
          type: string
          format: date-time
          description: >-
            When the person arrived, for scans uploaded later. Defaults to now;
            ignored if it is not a date.
    CheckIn:
      allOf:
        - $ref: '#/components/schemas/Attendee'
        - type: object
          properties:
            already_checked_in:
              type: boolean
              description: >-
                `true` when the person was already checked in and nothing
                changed.
    RegistrationApiError:
      type: object
      description: Error body of the Registration and Expo endpoints.
      required:
        - error
        - message
      properties:
        error:
          type: string
          enum:
            - VALIDATION_ERROR
            - NOT_FOUND
            - FORBIDDEN
            - CONFLICT
            - SCOPE_REQUIRED
            - EVENT_NOT_ALLOWED
            - EVENT_ARCHIVED
            - INTERNAL_ERROR
        message:
          type: string
        details:
          type: object
          description: Present when there is a machine-readable reason.
          properties:
            reason:
              type: string
              description: >
                Why the request was refused, for example `duplicate`,
                `sold_out`, `too_many`,

                `ticket_unavailable`, `not_on_sale`,
                `registrant_type_unavailable`,

                `answers_invalid`, `discount_invalid`, `wrong_status`,
                `account_required` or

                `booth_not_found`.
            status:
              type: string
              description: >-
                For `wrong_status` on Check someone in, the registration's
                current status.
            errors:
              type: object
              additionalProperties: true
              description: >-
                More detail for some reasons — the email for `duplicate`, the
                `ticket_type_id` for `sold_out`, the problems per answer for
                `answers_invalid`.
    Attendee:
      type: object
      description: >-
        Short registration shape used by List attendees, List check-ins and
        Check someone in.
      properties:
        id:
          type: string
          format: uuid
          description: The registration ID.
        status:
          type: string
        first_name:
          type:
            - string
            - 'null'
        last_name:
          type:
            - string
            - 'null'
        email:
          type: string
        company:
          type:
            - string
            - 'null'
        job_title:
          type:
            - string
            - 'null'
        ticket_type_id:
          type:
            - string
            - 'null'
          format: uuid
        registrant_type_id:
          type:
            - string
            - 'null'
          format: uuid
        account_id:
          type:
            - string
            - 'null'
          format: uuid
        checked_in_at:
          type:
            - string
            - 'null'
          format: date-time
        updated_at:
          type: string
          format: date-time
  responses:
    RegistrationUnauthorized:
      description: >-
        Missing, invalid or expired token, or the event does not belong to your
        organization.
    RegistrationForbidden:
      description: >
        - `SCOPE_REQUIRED` — the token lacks the scope (`read:registrations` for
        reads, `write:registrations` for writes). A write scope does not grant
        reads, and legacy tokens with no scopes cannot write.

        - `EVENT_NOT_ALLOWED` — the event is outside the token's event
        allow-list.

        - `EVENT_ARCHIVED` — the event is archived.

        - `FORBIDDEN` — Registration is not turned on for this event.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RegistrationApiError'
          examples:
            feature_off:
              summary: Registration is off for the event
              value:
                error: FORBIDDEN
                message: Registration is not enabled for this event
            scope_required:
              summary: Token lacks the write scope
              value:
                error: SCOPE_REQUIRED
                message: This operation requires the 'write:registrations' scope.
    RegistrationTooManyRequests:
      description: |
        The token's request limit (100 requests per 15 minutes per bucket — see
        [Rate Limiting](/rate-limiting)). Wait `Retry-After` seconds.
      headers:
        Retry-After:
          description: Seconds to wait before retrying.
          schema:
            type: integer
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: x-access-token
      description: >-
        Organization API token. Generate from Organization Settings → API
        Tokens.
    BearerToken:
      type: http
      scheme: bearer
      description: >-
        OAuth 2.1 access token. Obtained via the OAuth PKCE flow at
        `/oauth/token`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.