PDF forms
POST /v1/pdf/forms/fields
Section titled “POST /v1/pdf/forms/fields”Lists a PDF’s form fields with their kinds, pages and values.
Needs credentials, if any are configured.
Request
Section titled “Request”multipart/form-data
| Field | Type | Required | Description |
|---|---|---|---|
files |
files | Yes | Two PDFs: the base, then the overlay laid over it page by page. |
outputFilename |
string | No |
Responses
Section titled “Responses”| Status | Meaning | Body |
|---|---|---|
| 200 | The form fields | array of FieldSchema |
| 400 | The request is wrong | ErrorBody |
| 501 | Not supported in this version | ErrorBody |
POST /v1/pdf/forms/fill
Section titled “POST /v1/pdf/forms/fill”Fills a PDF form from data, applying tags in annotations, optionally flattening the result.
Needs credentials, if any are configured.
Request
Section titled “Request”multipart/form-data
| Field | Type | Required | Description |
|---|---|---|---|
files |
file | Yes | The PDF with form fields, and optionally tags in annotations. |
ctx |
JSON | No | |
data |
JSON | No | JSON object, sent as text or as a file; a field named customer.name takes that path. |
flatten |
boolean | No | Fix the values into the page content. |
outputFilename |
string | No | |
stripAnnotations |
boolean | No | Remove the annotations that carried tags. Default true. |
Responses
Section titled “Responses”| Status | Meaning | Body |
|---|---|---|
| 200 | The filled PDF | File |
| 204 | Accepted; the result goes to the webhook | |
| 400 | The request is wrong | ErrorBody |
| 422 | The template failed to render | ErrorBody |
| 501 | Not supported in this version | ErrorBody |
POST /v1/pdf/overlay
Section titled “POST /v1/pdf/overlay”Lays the second PDF over the first, page by page.
Needs credentials, if any are configured.
Request
Section titled “Request”multipart/form-data
| Field | Type | Required | Description |
|---|---|---|---|
files |
files | Yes | Two PDFs: the base, then the overlay laid over it page by page. |
outputFilename |
string | No |
Responses
Section titled “Responses”| Status | Meaning | Body |
|---|---|---|
| 200 | The combined PDF | File |
| 204 | Accepted; the result goes to the webhook | |
| 400 | The request is wrong | ErrorBody |
| 501 | Not supported in this version | ErrorBody |