Create a kiosk device
Crew module
POST/kiosk-deviceskioskDevices.create
A shared device in kiosk mode. Worker PINs are stored hashed and never returned. Creates a kiosk device. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.
- Requires the capability org.time_attendance.write.
- OAuth scopes: org.
- Send an Idempotency-Key header. A replay with the same key returns the original response.
- Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.
Request body: KioskDeviceCreate
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | Yes | Device name.Constraints: length 1 to 300 |
| project_id | string (uuid) | null | No | Identifier of the project the kiosk serves. |
{
"name": "Gate A Kiosk",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}Response 201: KioskDevice
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the kiosk device. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| name | string | Yes | Device name.Constraints: length 1 to 300 |
| project_id | string (uuid) | null | Yes | Identifier of the project the kiosk serves. |
| device_key | string | null | Yes | Device key the kiosk signs in with. Returned once, in the create response; null on every read, because only its hash is kept (invariant 8).Constraints: pattern ^xkio_[0-9a-f]{64}$ |
| last_seen_at | string (date-time) | null | Yes | Last time the kiosk checked in. |
| revoked_at | string (date-time) | null | Yes | When the kiosk was revoked; it accepts no punches. |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"name": "Gate A Kiosk",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"device_key": "xkio_9f2c4e1a7b3d5f6e8a0c2e4f6a8b0d2c4e6f8a0b2c4d6e8f0a2b4c6d8e0f2a4b",
"last_seen_at": "2026-10-08T14:30:00Z",
"revoked_at": "2026-10-08T14:30:00Z"
}Code samples
curl -X POST "$XOS_BASE_URL/kiosk-devices" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"name":"Gate A Kiosk","project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'const { data } = await xos.kioskDevices.create({
"name": "Gate A Kiosk",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
});response = xos.kiosk_devices.create({"name": "Gate A Kiosk", "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"})xos kiosk-devices create --data '{"name":"Gate A Kiosk","project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'