API reference

HidePDF Content finds emails, phones, cards, names, addresses, and country IDs in a PDF, then burns selected values out of the file so they cannot be copied or extracted. Base URL: https://hidepdfcontent.com. Machine-readable spec: /openapi.json.

Authentication

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

Direct API: send X-API-Key: YOUR_KEY or Authorization: Bearer YOUR_KEY
RapidAPI: send only X-RapidAPI-Key
Zapier: paste the same API key in the integration connection

Request a key at hello@hidepdfcontent.com. There is no customer login. Keys are issued to callers; the website itself does not require an account.

GET /v1/health

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

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

{
  "status": "ok"
}

GET /v1/example

Returns a small inspect JSON sample so testers 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.

Parameters

file (required) — multipart PDF upload, or JSON {"file":"https://…"}
countries (optional) — comma-separated codes such as IN,US
types (optional) — comma-separated hide 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 or all detected fields and returns a PDF with the text removed. This is the endpoint the Zapier action uses.

Parameters

file (required) — multipart PDF upload, or JSON {"file":"https://…"} with a public HTTP(S) URL
item_ids (optional) — comma-separated IDs from inspect. Empty means hide all detected sensitive types except amounts
types (optional) — comma-separated hide types. Include amount to hide money values
countries (optional) — comma-separated country codes such as IN,US
hide_amounts (optional, default false) — set true to also hide totals, salary, and invoice values

Example request

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

Successful responses are application/pdf. Headers include x-hidepdf-hidden, x-hidepdf-mode, x-hidepdf-text-removed, and x-hidepdf-extractable.

Errors

400 — missing file, not a PDF, empty file, or download failed
401 — missing or invalid API key on protected routes
413 — file larger than 25 MB

Zapier

The HidePDF Content Zapier action calls POST /v1/redact with a public PDF URL and an optional Hide amounts flag. Connect with an API key from hello@hidepdfcontent.com.