Guides / PDF

Redact PDF (guaranteed removal)

POST /v1/pdf/redact  ·  1¢ / page

Black out terms irreversibly: pages are rasterised, matches covered, rebuilt as an image PDF – the text is GUARANTEED gone. No text layer afterwards (run ocr if needed). Billed per page.

Parameters

NameTypeDescription
termsstring · requiredJSON array of terms to remove, e.g. ["name","IBAN..."] (max 100).
filefile · requiredPDF to redact (max 300 pages).
dpiinteger · optionalRaster resolution 72–300, default 150.
paddingnumber · optionalExtra margin around each match in points, default 2.

Example request

curl -X POST https://api.bigapi.dev/v1/pdf/redact -H 'Authorization: Bearer $KEY' -F 'file=@contract.pdf' -F 'terms=["Max Mustermann","DE8937..."]' -o redacted.pdf

Example response

HTTP/1.1 200 OK
Content-Type: application/pdf
X-BigAPI-Redactions: 7
X-BigAPI-Pages: 12

(image-based PDF, matches blacked out, no text layer)

Related guides