Kiosk

Kiosk platform

Manage time capture units without bolting device control into your main app.

Android face kiosk with PIN fallback PIN-only web kiosk option Scoped API keys and OpenAPI docs Remote update, restart, Wi-Fi, and lock controls

API docs OpenAPI YAML

Account access

Sign in

Email Password

Advanced connection

API base Session or API key

Account - -

Tenant - -

Clients/sites 0 configured

Devices 0 0 online

Guided setup

Finish setup

0 / 4 complete

Connect your app

Generate the API key your ATS, payroll system, or custom app will use.

Not done

Integration name Access template

Custom scopes

OpenAPI YAML

Add a site

Create the client, site, or location the kiosk will belong to.

Not done

Client/site name External ref optional

Set up a unit

Generate a QR that installs and binds the tablet to the selected site.

Not done

Device label Kiosk type

Advanced setup

Send a test clock event

Create a test person and send a clock in/out event through the API.

Not done

Person ID Person name PIN

No test sent yet.

Integration guide

Use tenant API keys for external software and device tokens for kiosk tablets.

Download OpenAPI YAML Health endpoint

Base URL http://localhost:8088

Auth header Authorization: Bearer ksk_live_...

Build the connection

Order of work

Create an account The customer signs up, creates a tenant, and receives an owner session plus the first root API key.
Create a site Add one client/site record. Store the returned client_id in the external system.
Create a scoped API key Use a restricted key for production integrations instead of sharing the root key.
Sync people Upsert each worker/candidate with a stable external_id, display name, optional PIN, and metadata.
Set up tablets Create setup tokens for Android face kiosks or PIN web kiosks. The response includes QR and APK links.
Exchange clock events Post events from external systems or read events produced by kiosk tablets.

Scopes

Least privilege

clients:read Read configured sites. clients:write Create or update sites. devices:read Read kiosk status. devices:write Create setup tokens and send device commands. candidates:read Read synced people. candidates:write Upsert people and PINs. clock-events:read Read kiosk clock events. clock-events:write Create clock events.

Common calls

Examples

Rules

Production use

Stable IDs: send the same external_id for the same person every time.

Idempotency: send Idempotency-Key on clock writes so retries do not create duplicate events.

Time format: send occurred_at as ISO 8601 UTC, for example 2026-09-14T09:00:00Z.

Setup tokens: setup QR responses include setup_url, qr_url, install_url, and agent_install_url.

Secret handling: raw API keys are only returned once. Store them in the external app secret store.

Common errors

What to handle

400 Missing or invalid request data. 401 Missing, expired, or invalid bearer token. 403 Token exists but does not have the required scope. 404 Tenant, site, device, setup token, or candidate was not found. 409 Duplicate tenant slug, email, or idempotency conflict.

Manage time capture units without bolting device control into your main app.

Sign in

Finish setup

Connect your app

Add a site

Set up a unit

Send a test clock event

Units

Integration guide

Build the connection

Scopes

Common calls

Rules

Common errors