---
title: "Assisted mode on or off, or cancel"
method: PATCH
path: "/v1/kiosk-sessions/{kioskSessionId}"
tags: ["Kiosks"]
---

# Assisted mode on or off, or cancel

`PATCH /v1/kiosk-sessions/{kioskSessionId}`

## Request

- Base URL: `https://sign-api.tvarka.pro`
- URL: `https://sign-api.tvarka.pro/v1/kiosk-sessions/{kioskSessionId}`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-Api-Key`
  - OAuth 2 (authorization code, authorization URL `https://sign-api.tvarka.pro/oauth/authorize`, token URL `https://sign-api.tvarka.pro/oauth/token`, scopes: `sign.read`, `sign.signings`)

`assisted: true` lets a staff member fill fields from a computer while
the tablet shows them; the signature waits until `assisted: false`.
`status: cancelled` ends the session and withdraws the document from
the tablet.

## Path parameters

- `kioskSessionId` string, uuid, required

## Request body

- object
  - `assisted` boolean
  - `status` 'cancelled'

## Response `200`

The kiosk session.

- KioskSession
  - `kioskSessionId` string, uuid
  - `kioskId` string, uuid
  - `status` 'waiting' | 'in_progress' | 'assisted' | 'ready' | 'signing' | 'completed' | 'cancelled' | 'expired' | 'failed'
  - `assisted` boolean
  - `title` string
  - `signerName` string, nullable
  - `identity` 'attended' | 'sms'
  - `createdAt` string, date-time
  - `completedAt` string, date-time, nullable
  - `revision` integer
  - `product` 'sign' | 'forms' | 'sauga'
  - `formRequestId` string, uuid, nullable: With product forms.
  - `referenceCode` string: The public check code

## Other responses

- `400`: An RFC 9457 problem document.
- `401`: An RFC 9457 problem document.
- `402`: An RFC 9457 problem document.
- `403`: An RFC 9457 problem document.
- `404`: An RFC 9457 problem document.
- `409`: An RFC 9457 problem document.
- `429`: An RFC 9457 problem document.
- `503`: An RFC 9457 problem document.

---

[API](https://skmtc.dev/tvarka/apis/tvarka-sign-api.md) · [All operations](https://skmtc.dev/tvarka/apis/tvarka-sign-api/llms.txt) · [OpenAPI document](https://skmtc.dev/tvarka/apis/tvarka-sign-api/revisions/e3fdd995c013?raw)