Redact PDF API

File to be converted. Value can be URL or file content.

Sets the password to open protected PDF.

The Preset parameter determines the type of sensitive data the AI will detect and redact from the document. It complements the RedactionData, enabling you to refine or expand the redaction criteria. Select manual to use your customized redaction options exclusively.

Choose a preset to define the type of sensitive data the AI will detect and redact from the document:

• Auto - Automatically detects and redacts sensitive data across all categories, including PII, financial, healthcare, legal, and confidential information. Best for general redaction when the document type is unknown or contains mixed data.

• GDPR - Redacts personal data as required by GDPR, including names, emails, IP addresses, phone numbers, and national IDs.

• HIPAA - Ensures compliance with HIPAA by redacting protected health information (PHI) such as patient names, medical record numbers, diagnoses, and prescription details.

• FERPA - Redacts personally identifiable student information to comply with FERPA, including student names, school records, and educational identifiers.

• FOIA - Prevents the exposure of sensitive personal or national security data in documents released under FOIA. This includes classified content, addresses, and government IDs.

• GLBA - Complies with GLBA by redacting financial data such as bank account numbers, credit card details, loan records, and investment information.

• CCPA -Meets CCPA requirements by removing consumer personal data such as purchase history, geolocation, contact details, and online identifiers upon request.

• Manual - Disables automatic AI detection preset. Only the manually set parameters will be used to determine what should be redacted. Ideal for users who want full control over redaction without AI-based automation.

Sets the minimum confidence threshold for AI-based detection of sensitive data. Higher values reduce false positives but may miss subtle matches.

Defines how the AI engine processes the document in terms of context.

When the ContextSize parameter is set to Page, each page is processed independently, without context from other pages. This mode is useful when a document contains structured or repetitive data (such as tables with rows of values), or when a high volume of detections is expected. By limiting context to a single page, the AI avoids confusion from unrelated content and ensures accuracy per page.

When the ContextSize parameter is set to Balanced, the AI maintains context across multiple pages while still optimizing processing efficiency. This mode is recommended for large or multi-page documents where relationships between sections matter, and it also provides improved performance for large documents.

Specifies the color used to mask redacted text, accepting formats such as Hexadecimal (e.g., #FFFFFF for white or #FF5733 for orange), RGB with an optional alpha channel (e.g., 255,255,255 for white or 255,255,255), and named colors (e.g., white, red, blue).

The RedactionThickness property controls the height of the redaction stroke line relative to the original line height.

• A value of 1 means the stroke height matches the original line height.
• Values less than 1 (e.g., 0.5) reduce the stroke height.
• Values greater than 1 (e.g., 1.5 or 2) increase the stroke height.

Personally Identifiable Information (PII) - Detects and redacts common personal identifiers, including names, email addresses, phone numbers, birthdates, and home addresses.

Patient Health Information (PHI) - Detects health-related information such as patient names, medical records, insurance details, and prescription data.

Financial Data - Focuses on financial records, including credit card numbers, bank account numbers, financial transaction details, etc.

Legal and Contractual Data - Detects legal and contractual terms, including case numbers, legal clauses, signatures, and confidential agreements.

Legal and Contractual Data - Detects proprietary business information, contracts and agreements, internal communications, trade secrets, intellectual property details, and sensitive corporate data.

A JSON array defining specific values for redaction. Supports three methods:

• Text – Exact text to be redacted.
• Regex – Escaped regular expression patterns for flexible text matching.
• Detect – AI-based detection using a description of what to find.

If RedactionData is passed, it forces: Preset is set to manual, and all built-in detection options (such as PII, PHI, Financial, Legal, Confidential) are disabled. In this mode, only the values defined in RedactionData are applied.

Example JSON

[
  {
    "Text": "john@domain.com"
  },
  {
    "Detect": "Bank account number"
  },
  {
    "Regex": "\\b100\\s*(€|\\$)\\b"
  }
]

Set page range. Example 1-10 or 1,2,5.

When the StoreFile parameter is set to True, your converted file is written to ConvertAPI’s encrypted, temporary storage and made available via a time-limited secure download URL, valid for up to 3 hours. After this period, the file is permanently deleted.

When StoreFile is set to False, conversion happens entirely in-memory. The raw file bytes are streamed back in the API response without touching disk or external storage, ensuring maximum security and zero persistence so that only you can access the content.