Kiosks

Send a PDF to a tablet

Sends one PDF to a kiosk for a drawn e-signature (v1.15.0). The document takes the signing intake (content, fileToken, url, markdown). No link is mailed; the person signs on the tablet. identity: sms sends a one-time code to signer.phone and checks it on the tablet before signing. A busy kiosk answers 409.

product: forms with formRequestId sends a Tvarka Formos request to the kiosk instead (v1.17.0). The person fills the form on the tablet, with each field in its place on the document page, reviews it and signs it there by hand. A template with a staff signature place, such as the doctor's, is signed by the staff member next, on the same tablet. title, document, signer and identity are not used then. A request already on a kiosk answers with that session. assisted: true starts in assisted mode.

post/v1/kiosk-sessions

Request

  • Base URL: https://sign-api.tvarka.pro
  • URL: https://sign-api.tvarka.pro/v1/kiosk-sessions
  • 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)

Headers

Idempotency-Keystring

Optional tenant-and-operation-scoped create key (1-128 visible ASCII characters). Identical input replays the original response; changed input or an unresolved execution returns 409. After 90 days the response expires but the key remains reserved. Do not change keys to retry a request with an uncertain outcome.

Request body

kioskIdstring uuid required
product'sign' | 'forms'
formRequestIdstring uuid

With product forms, the form request to fill and sign on the kiosk.

assistedboolean

Start in assisted mode.

titlestring
identity'attended' | 'sms'

Response

The kiosk session, waiting for the tablet.

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.