Skip to content
Lumen Insight Docs

Log Entry/Exit

POST /api/kiosk/enter-exit

Section titled “ /api/kiosk/enter-exit”

This endpoint logs a visitors entry or exit.

Query Parameters

Section titled “Query Parameters”

siteId ID of the subsite the user is entering. Default is “main”.

Request Body

Section titled “Request Body”
{
    "first_name": string,
    "last_name": string,
    "uuid": string,
    "card_type": "CAC" | "MANUAL" | "ID",
}

first_name First name of the visitor.

last_name Last name of the visitor.

OR

uuid UUID of the plastic access card.


card_type Type of entry method used by the visitor.

Response Body

Section titled “Response Body”
{
    "first_name": string,
    "last_name": string,
    "direction": "enter" | "exit",
    "project": string,
    "is_registered": boolean,
    "has_email": boolean,
    "is_new": boolean,
    "asked_card": boolean,
    "prev_used_any_card": boolean | undefined,
    "appointment": {
        "endTimestamp": timestamp,
        "id": string,
    }
}

first_name First name of the visitor.

last_name Last name of the visitor.

direction Direction the visitor was going (based on previous state.)
This is useful to customize the message and flow for the visitor.

project Name of the project the visitor had previously selected during their last visit.
Default to “Other” if the visitor has not selected a project. Note “Other” is also a valid project selection.

is_registered Whether the visitor is registered or not.

has_email Whether the visitor has given us their email yet.

is_new Whether this is the first time we have seen this visitor.

asked_card Whether we offered a plastic access card to the visitor.

prev_used_any_card Whether the visitor has used a CAC or plastic access card in the past.
This is useful to determine if they may be interested in a plastic card.

appointment Appointment data if the visitor has an approved appointment around the current time.
This is useful to customize the message and flow for the visitor, or restrict entry.