DKBSignDocs

API reference

POSTRequires Bearer token

Create a workflow

/api/workflows/create

Launch a circuit from a finalized model. Multipart (files[] are PDFs, max 10 MB each).

model_id must belong to the caller’s company and must not be archived. client_id is optional and must also belong to the same company. License read-only grace blocks this call.

Status of a running instance: pending → in_progress → completed / cancelled.

Path parameters

This endpoint has no path parameters.

Query parameters

This endpoint has no query parameters.

Request body

FieldTypeDescription
name
Required
stringWorkflow name (max 255).
e.g. "Contract ACME"
description
stringOptional description.
e.g. "Renewal"
model_id
Required
integerFinalized workflow model in the caller’s company.
e.g. 3
client_id
integerExisting client in the same company.
e.g. 12
files
Required
arrayPDF documents (required, max 10240 KB each).
e.g. ["example"]

Responses

StatusMeaning
201See the example response.
401Missing or invalid Bearer token.

Request

curl
curl -X POST 'https://api.dkbsigns.com/api/workflows/create' \
  -H 'Authorization: Bearer $DKBSIGN_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"name":"Contract ACME","model_id":3,"files":["example"],"description":"Renewal","client_id":12}'

Response 201

json
{
  "message": "Workflow créé et lancer avec succès",
  "workflow": {
    "id": 88
  },
  "instance": {
    "id": 91
  }
}