---
title: "Ask a person to fill and sign forms"
method: POST
path: "/v1/form-requests"
tags: ["Forms"]
---

# Ask a person to fill and sign forms

`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`)

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.

## Headers

- `Idempotency-Key` string

## Request body

- CreateFormRequest
  - `templateVersionIds` string[], 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`).
  - `respondent` object
    - `name` string
    - `phone` string: International form
    - `email` string, email
  - `visitAt` string, date-time
  - `sendAt` string, date-time
  - `sendNow` boolean
  - `expiresAt` string, date-time
  - `prefill` object: Values by semantic identifier.
  - `personalCode` string: The Lithuanian personal code of the person who signs.
  - `language` string
  - `emailSignedCopy` boolean
  - `externalId` string
  - `webhookUrl` string, uri

## Response `201`

The request.

- FormRequest
  - `formRequestId` string, uuid, required
  - `reference` string, required
  - `status` 'scheduled' | 'sent' | 'opened' | 'in_progress' | 'submitted' | 'completed' | 'expired' | 'cancelled' | 'failed', required
  - `channel` 'remote' | 'walk_in' | 'kiosk', required
  - `externalId` string, nullable
  - `templateVersionIds` string[], required
  - `respondent` object
    - `name` string, nullable
    - `phone` string, nullable
    - `email` string, nullable
  - `visitAt` string, date-time, nullable
  - `sendAt` string, date-time, nullable
  - `expiresAt` string, date-time, nullable
  - `sentAt` string, date-time, nullable
  - `openedAt` string, date-time, nullable
  - `submittedAt` string, date-time, nullable
  - `completedAt` string, date-time, nullable
  - `createdAt` string, date-time, required
  - `filler` object
    - `who` 'subject' | 'guardian'
    - `name` string, nullable
    - `relation` string, nullable
  - `events` object[], required
    - `type` string
    - `actor` string
    - `at` string, date-time
  - `values` object: Present once submitted. Values by semantic identifier.
  - `document` object
    - `url` string, uri
    - `sha256` string

## 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.
- `422`: 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)