Forms

Ask a person to fill and sign forms

One request holds one or more published template versions, filled in one journey and signed once (v1.16.0). Give respondent.phone (the link and the code go by SMS) or respondent.email. prefill is keyed by the fields' semantic identifiers. When personalCode is given, only that person's qualified signature is accepted.

post/v1/form-requests

Request

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

templateVersionIdsstring[] required
channel'remote' | 'kiosk'

kiosk (v1.17.0) needs no phone or email and sends no link; send the request to a tablet with POST /v1/kiosk-sessions (product: forms).

visitAtstring date-time
sendAtstring date-time
sendNowboolean
expiresAtstring date-time
prefillobject

Values by semantic identifier.

personalCodestring

The Lithuanian personal code of the person who signs.

languagestring
emailSignedCopyboolean
externalIdstring
webhookUrlstring uri

Response

The request.

formRequestIdstring uuid required
referencestring required
status'scheduled' | 'sent' | 'opened' | 'in_progress' | 'submitted' | 'completed' | 'expired' | 'cancelled' | 'failed' required
channel'remote' | 'walk_in' | 'kiosk' required
externalIdstring nullable
templateVersionIdsstring[] required
visitAtstring date-time nullable
sendAtstring date-time nullable
expiresAtstring date-time nullable
sentAtstring date-time nullable
openedAtstring date-time nullable
submittedAtstring date-time nullable
completedAtstring date-time nullable
createdAtstring date-time required
valuesobject

Present once submitted. Values by semantic identifier.

Changes

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