Kiosks

Assisted mode on or off, or cancel

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.

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)

Path parameters

kioskSessionIdstring uuid required

Request body

assistedboolean
status'cancelled'

Response

The kiosk session.

kioskSessionIdstring uuid
kioskIdstring uuid
status'waiting' | 'in_progress' | 'assisted' | 'ready' | 'signing' | 'completed' | 'cancelled' | 'expired' | 'failed'
assistedboolean
titlestring
signerNamestring nullable
identity'attended' | 'sms'
createdAtstring date-time
completedAtstring date-time nullable
revisioninteger
product'sign' | 'forms' | 'sauga'
formRequestIdstring uuid nullable

With product forms.

referenceCodestring

The public check code

Changes

No recorded changes to this operation across all 1 revision of this API.