Docs
GlobalShield
GlobalShield
PII detection and redaction API for images and PDFs. Detect, mask, or remove sensitive personal information with 20+ language OCR support.
Overview
GlobalShield scans images and PDF documents for personally identifiable information (PII) and redacts it automatically. Supports 20+ languages via built-in OCR.
Base URL: https://api.apivult.com/v1/compliance/pii
Authentication
Include your API key in every request header: X-API-Key: YOUR_API_KEY
Endpoints
| Method | Endpoint | Description |
|---|---|---|
| POST | /v1/compliance/pii/detect | Detect PII entities in a document without redacting |
| POST | /v1/compliance/pii/redact | Detect and redact PII, return cleaned document |
| POST | /v1/compliance/pii/batch | Process multiple files in one request |
Supported PII Types
name · email · phone · address · id_number · passport · credit_card · date_of_birth · ssn · bank_account
Supported File Formats
image/jpeg · image/png · image/webp · application/pdf
Quick Start
curl -X POST "https://api.apivult.com/v1/compliance/pii/detect" \
-H "X-API-Key: YOUR_API_KEY" \
-F "[email protected]" \
-F "language=en"Response:
{
"entities": [
{ "type": "name", "text": "John Doe", "page": 1, "confidence": 0.98 },
{ "type": "email", "text": "[email protected]", "page": 1, "confidence": 0.99 }
],
"total_found": 2,
"pages_scanned": 1
}Rate Limits
| Plan | Requests/Month |
|---|---|
| Free | 500 |
| Basic | 2,000 |
| Pro | 20,000 |