HidePDF Content

API

Reference

HidePDF Content finds emails, phones, cards, names, addresses, and country IDs in a PDF, then burns the ones you keep checked out of the file. Base URL: https://hidepdfcontent.com. Machine-readable spec: /openapi.json. The idea behind the burn step is on how it works.

Authentication

The playground is same-origin and does not need a key. Direct API, RapidAPI, and Zapier calls do.

  • Direct API: X-API-Key or Authorization: Bearer
  • RapidAPI: X-RapidAPI-Key only
  • Zapier: the same key in the connection

Request a key from the contact page. There is no customer login.

GET /v1/health

Confirms the API is up. No file and no key.

curl https://hidepdfcontent.com/v1/health
{ "status": "ok" }

GET /v1/example

A small inspect JSON sample, so you can see the field list without uploading a PDF.

curl https://hidepdfcontent.com/v1/example

GET /v1/hide-types

Lists hide types and country codes. Amounts stay visible unless you send hide_amounts=true or include types=amount.

POST /v1/inspect

Finds sensitive fields and returns them for review. Scanned pages with little text use OCR. file is a multipart PDF or JSON {"file":"https://…"}. Optional countries such as IN,US, and optional types.

curl -X POST https://hidepdfcontent.com/v1/inspect \
  -H "X-API-Key: YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"file":"https://hidepdfcontent.com/dummy-india-invoice.pdf","countries":"IN,US"}'
{
  "status": "ok",
  "items_found": 1,
  "items": [
    { "id": "email-1", "type": "email", "page": 1, "optional": false }
  ]
}

POST /v1/redact

Hides selected fields, or every detected sensitive type except amounts when you send no selection, and returns a PDF whose text layer is gone. This is the call the Zapier action uses.

  • file — multipart PDF, or JSON {"file":"https://…"}
  • item_ids — comma-separated ids from inspect
  • types — include amount to hide money
  • countries — such as IN,US
  • hide_amounts — default false
curl -X POST https://hidepdfcontent.com/v1/redact \
  -H "X-API-Key: YOUR_KEY" \
  -H "Accept: application/pdf" \
  -H "Content-Type: application/json" \
  -d '{"file":"https://hidepdfcontent.com/dummy-india-invoice.pdf","hide_amounts":false}' \
  --output hidden.pdf

Success is application/pdf. Headers: x-hidepdf-hidden, x-hidepdf-mode, x-hidepdf-text-removed, x-hidepdf-extractable. If a hidden value is still extractable, the API returns an error and does not send the PDF.

Errors

  • 400 — missing file, not a PDF, empty file, or download failed
  • 401 — missing or invalid API key
  • 404 — unknown API path, as JSON
  • 413 — file larger than 25 MB

Zapier

The action calls POST /v1/redact with a public PDF URL and an optional Hide amounts flag. Connect with an API key from the contact page.