Get started in 2 minutes

Sign up for a free API key, detect PII in a document, and get back a scrubbed version. No SDK required — just curl.

01

Get your API key

Sign up with your email. You'll get a free-tier key (20 documents/month) instantly.

Terminal
$ curl -X POST https://YOUR_DOMAIN/signup \ -H "Content-Type: application/json" \ -d '{"email": "you@example.com"}'
{ "api_key": "sk_live_a1b2c3d4e5f6...", "email": "you@example.com", "tier": "free", "docs_per_month": 20, "message": "Store this key securely — it will not be shown again." }
Save your API key somewhere secure. It's shown once and can't be retrieved later.
02

Detect PII in a document

Upload a PDF or DOCX to see what PII was found — without redacting anything yet.

Terminal
$ curl -X POST https://YOUR_DOMAIN/detect \ -H "Authorization: Bearer YOUR_API_KEY" \ -F "file=@contract.pdf"
{ "entities": [ { "text": "Jonathan R. Mitchell", "type": "PERSON", "confidence": 0.94, "page": 1, "decision": "REDACT" }, { "text": "423-55-8891", "type": "US_SSN", "confidence": 0.99, "page": 1, "decision": "REDACT" } ], "entity_count": 2, "page_count": 3, "processing_ms": 847.2 }

Each entity includes its type, confidence score, page number, and whether it would be auto-redacted at the current threshold.

03

Redact a document

Same upload, but this time you get back a scrubbed file with PII permanently removed.

Terminal
$ curl -X POST https://YOUR_DOMAIN/redact \ -H "Authorization: Bearer YOUR_API_KEY" \ -F "file=@contract.pdf" \ -o redacted.pdf

The response is the redacted PDF file. Headers include X-Processing-Ms and X-Entity-Count for observability.

04

Check your usage

See how many documents you've processed this month against your plan limit.

Terminal
$ curl https://YOUR_DOMAIN/usage \ -H "Authorization: Bearer YOUR_API_KEY"
{ "doc_count": 7, "total_pages": 23, "period_year": 2026, "period_month": 3 }
05

Customize detection

Fine-tune what gets redacted with optional parameters.

ParameterDefaultDescription
redaction_threshold 0.85 Confidence cutoff for auto-redaction (0.0 - 1.0)
entity_types all Comma-separated types: PERSON, US_SSN, EMAIL_ADDRESS, etc.
Example: SSNs only, lower threshold
$ curl -X POST https://YOUR_DOMAIN/redact \ -H "Authorization: Bearer YOUR_API_KEY" \ -F "file=@document.pdf" \ -F "redaction_threshold=0.6" \ -F "entity_types=US_SSN,CREDIT_CARD" \ -o redacted.pdf
?

Rate limits & quotas

Each tier has per-minute rate limits and monthly document quotas.

TierDocs/monthRequests/minPrice
Free2010$0
Starter50060$49/mo
Pro3,000120$199/mo
EnterpriseUnlimited300$999+/mo

Exceeding your monthly quota returns HTTP 402. Exceeding your rate limit returns HTTP 429 with a Retry-After header.

API Reference

POST /signup

Create an account and receive an API key.

  • email — Your email address (required)
POST /detect

Upload a document and get back a list of detected PII entities without redacting.

  • file — PDF or DOCX file (multipart/form-data, required)
  • redaction_threshold — Confidence cutoff, default 0.85
  • entity_types — Comma-separated entity types to detect
POST /redact

Upload a document and get back a scrubbed version with PII permanently removed.

  • file — PDF or DOCX file (multipart/form-data, required)
  • redaction_threshold — Confidence cutoff, default 0.85
  • entity_types — Comma-separated entity types to redact
GET /usage

Check your document processing usage for the current billing period.

GET /health

Liveness check. Returns 200 when the API is operational.

All endpoints require Authorization: Bearer YOUR_API_KEY except /signup and /health.