API reference
Process a workflow step
/api/workflows/transactions/step/process
Complete the current step. Prefer multipart when uploading imgStamp. actions and data may be JSON strings.
actions is an array of { "action": "<enum>" }. Allowed values: validate, sign, text, date, stamp, qr_code, initials.
data.documents[] places marks (file_id, pages[].page, elements[] with type, value, position, size). validate does not need data.
When sign is included, also send signers_data and signature_params (JSON strings). signature_level is frozen on the instance — clients cannot change it. Optional signature_appearance is a PNG data-URL.
Conditional steps require condition: yes or no.
Path parameters
This endpoint has no path parameters.
Query parameters
This endpoint has no query parameters.
Request body
Send as multipart/form-data.
| Field | Type | Description |
|---|---|---|
transaction_id Required | integer | Current step transaction id. e.g. 44 |
actions Required | array | At least one { "action": "validate|sign|text|date|stamp|qr_code|initials" }.e.g. [{"action":"validate"}] |
data | object | Placement payload (documents → pages → elements). |
condition | string | yes or no — required on conditional steps.e.g. "yes" |
imgStamp | string | Stamp image (png/jpg, max 5 MB) when the user has no stored stamp. |
signers_data | string | JSON array of signer metadata. Required when sign is in actions. |
signature_params | string | JSON array of per-document zones. Required when sign is in actions. |
signature_appearance | string | Optional PNG data-URL (data:image/png;base64,…, max 2M chars). |
Responses
| Status | Meaning |
|---|---|
| 200 | See the example response. |
| 401 | Missing or invalid Bearer token. |