---
title: "Cria flow (draft)"
method: POST
path: "/api/v1/flows"
tags: ["flows"]
---

# Cria flow (draft)

`POST /api/v1/flows`

## Request

- Base URL: `https://clickflow-sandbox.clicksign.com`
- URL: `https://clickflow-sandbox.clicksign.com/api/v1/flows`
- Auth: API key in header `Authorization`

Exemplos de body (`acceptance`, `form`, `verify`, `biometric_behavior`, `biometric_behavior` + `form`, `kyc`, `signature` com `file`/`template`/`runner_files`/`form_attachment`/`mixed` e `template_mappings`, `embedded_signature`): combo no *Try It!*.

Validação estrutural do `context acceptance` (`template_key`, `accept_replies`) e do `signature` `settings.deadline_at` (inteiro de 1 a 90 dias, contado de hoje em UTC, ou ISO 8601; acima de 90, zero, negativo ou quebrado a publicação recusa; omitido, a Assinatura usa o prazo padrão de 90 dias), `documents[].kind runner_files` (`key` e `filename` obrigatórios), `documents[].kind form_attachment` (`field_key` obrigatório) e `documents[].template_mappings` no orquestrador; match da resposta do usuário no runner.

Demais campos do passo `signature` são validados no executor (runner).

## Request body

- object
  - `name` string, required
  - `steps` object[]
    - `context` object, required
    - `type` 'acceptance' | 'form' | 'verify' | 'kyc' | 'signature' | 'embedded_signature' | 'consent'

## Response `201`

Created

- object
  - `account` object
    - `id` integer
    - `key` string
    - `name` string
  - `created_at` string
  - `flow_id` string
  - `name` string
  - `status` 'draft' | 'published' | 'unpublished' | 'deleted'
  - `steps` object[]
    - `context` object, required
    - `type` 'acceptance' | 'form' | 'verify' | 'kyc' | 'signature' | 'embedded_signature' | 'consent'
  - `updated_at` string
  - `user_id` string

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `503`: Service Unavailable

---

[API](https://skmtc.dev/clicksign/apis/clickflow-orchestrator-api.md) - [All operations](https://skmtc.dev/clicksign/apis/clickflow-orchestrator-api/llms.txt) - [OpenAPI document](https://skmtc.dev/clicksign/apis/clickflow-orchestrator-api/revisions/6b7d6ecbc2f2?raw)