Skip to content
HALOWERK

Formatwerk

pdf form flatten

Loads the PDF with pdf-lib, optionally fills text fields, checkboxes, radio groups, dropdowns and list boxes from a name to value map (unknown names, invalid options and over-long values are rejected), regenerates the appearances of changed fields (Helvetica, or embedded Liberation Sans for non-Latin-1 text) and flattens every field into the page content. XFA data is removed with a warning; encrypted PDFs are rejected. Returns the PDF and each field with its final value.

POST https://format.halowerk.com/v1/pdf-form-flatten

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
pdf_base64stringYesPDF with an AcroForm (max. 20 MB).
valuesobjectNoField name → value (text, true/false for checkboxes, option for radio/dropdown, array for multi-select lists).
strictbooleanNoReject value names that do not exist in the form.
Show full input schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "pdf_base64"
  ],
  "properties": {
    "pdf_base64": {
      "type": "string",
      "maxLength": 28000000,
      "description": "PDF with an AcroForm (max. 20 MB)."
    },
    "values": {
      "type": "object",
      "maxProperties": 500,
      "additionalProperties": {
        "type": [
          "string",
          "number",
          "boolean",
          "array"
        ],
        "items": {
          "type": "string"
        }
      },
      "description": "Field name → value (text, true/false for checkboxes, option for radio/dropdown, array for multi-select lists)."
    },
    "strict": {
      "type": "boolean",
      "default": true,
      "description": "Reject value names that do not exist in the form."
    }
  }
}

Open original schema

Published input example

{
  "pdf_base64": "JVBERi0xLjcKJYGBgYEKCjkgMCBvYmoKPDwKL0JCb3ggWyAwIDAgMTYxIDIxIF0KL01hdHJpeCBbIDEgMCAwIDEgMCAwIF0KL1Jlc291cmNlcyA8PAovRm9udCA8PAovSGVsdmV0aWNhIDUgMCBSCj4+Cj4+Ci9UeXBlIC9YT2JqZWN0Ci9TdWJ0eXBlIC9Gb3JtCi9GaWx0ZXIgL0ZsYXRlRGVjb2RlCi9MZW5ndGggMTUyCj4+CnN0cmVhbQp4nDNUMABCQzCZnMtliMotBEJDBRAsSucyAIsGuQNFyrmiY4HsFIR6PVMwxjQCjQuiQKSRgUIOl6EZEgNEZ3A5cQVyGSkYAdUYKRhagqRMLREMI7CacK48Lv2QCgUnX2eg+5xCoC4DOlHfIzWnLLUkMzlRwdBUISQNbruRgqmeIUgol8vGTiEki8s1BGiRK9CAQC4AcLw0AgplbmRzdHJlYW0KZW5kb2JqCgoxMSAwIG9iago8PAovRmlsdGVyIC9GbGF0ZURlY29kZQovVHlwZSAvT2JqU3RtCi9OIDkKL0ZpcnN0IDUyCi9MZW5ndGggNDkxCj4+CnN0cmVhbQp4nNVTX4/TMAx/z6fw4/FCnK5/0TSpW9dDOh1M26QhTvfQa8NUNBrUZWh8e+ykLQwJ8cQDTZ3Wjh3bP9sKEAIIQ5hBFkIIUZhCBHFKBEmcAK1MQQppkoFCeiMF87mQ++9fNchNddRnIR/a5gxPZI2whWchV+bSWVBisRA/dVeVrU7mKLwRKFYWMq97U5r+C7ljfrDY9Ka51LqHebkuS8QEEeOQKEYMCvquiDKigHg6C1L6J0rCgUiWzBBnOZ2VnuLE2/C5040G+zV9STdmncLrhqnnJ7/sa+3vCP4WT7YQ8tE0RWU13BVvAgxipVChez6+Inh6XVnz/ybn4m9N98cMb+rO5eai95p7wld9q8/m0tfUBqxXGjqhHzKTH96/fNb1xK6v9n5n2Y8XsOxRN221NFfqOOTuRW5L5L7Lu85Y7sR06MSbQNiNkLvLi3UsC5WQy+qsXQDyrT5907atK3Lb1aZpuyPIQ9vl3bkdBeONZatPrueTW0/lni6+ThMxxiH3Y7Ed0MoXI44omyKHO3SJ9DQbUwygIth/+g1Kl98vKRza5qgtw0mIPYHKXkcw402lSHvM2/OEfeKx3/g5JRwfHPrLezZ1i3S3gCRaDdiiz0wud0714GdalhAS2BsnewfZOLn/BO0f8bkecwplbmRzdHJlYW0KZW5kb2JqCgoxMiAwIG9iago8PAovU2l6ZSAxMwovUm9vdCAyIDAgUgovSW5mbyAzIDAgUgovRmlsdGVyIC9GbGF0ZURlY29kZQovVHlwZSAvWFJlZgovTGVuZ3RoIDQ5Ci9XIFsgMSAyIDIgXQovSW5kZXggWyAwIDEzIF0KPj4Kc3RyZWFtCnicJcq5DQAgEAPBNccnkVAnNdLbIYtkogEyCwuMTDFhqmmmmyH2f1M6oLjwAJafA9UKZW5kc3RyZWFtCmVuZG9iagoKc3RhcnR4cmVmCjk1NgolJUVPRg==",
  "values": {
    "name": "Erika Mustermann"
  }
}

Result & documentation

Machine-readable documentation of this hub

Source of this page: the published HALOWERK catalog. Updated: 2026-11-17 UTC.

More endpoints in this hub

All endpoints in this hub →