Redact PDF API - Remove Sensitive Data, Secure PDF, Advanced Redaction

Try Now with API Lab

Start right from your browser - upload files, choose parameters, generate code, and send API Calls directly from API Lab!

Request

POST

Headers

Api-Key

Don't have a key? Create an account to get one.

Response-Type

Poll for the status of a request by ID. Request IDs can be found in the JSON response of POST requests sent to any pdfRest endpoint.

Required Parameters

file

PDF file to be uploaded for an image to be added.

Alphanumeric ID (UUID) of existing PDF file on server for an image to be added.

redactions

Takes a JSON array of redactions to apply. See Documentation for further details

Optional Parameters

output

Name of the generated output file, without extension.

Code

curl -X POST "https://api.pdfrest.com/pdf-with-redacted-text-preview" \
  -H "Accept: application/json" \
  -H "Content-Type: multipart/form-data" \
  -H "Api-Key: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" \

Response

The response for your API Call will display here.

Once you've sent your POST request and received a valid response, you can download your output file using the output URL.

Pro

What are Pro Tools?

Pro Tools are powerful API Tools that require a Pro or Enterprise plan for unrestricted access. All plans may be used to test Pro Tools, but output will be watermarked or otherwise limited below the Pro plan level.

Build Your Solution

You have document processing problems, we have Solutions. Explore the many ways pdfRest can align your documents with your business objectives.

Browse all solutions

Integrate pdfRest with Microsoft Power Automate

Integrate PDF API Tools with Salesforce Apex Code

Control your Backend with pdfRest API Toolkit Self-Hosted

Ensure Patient Privacy in Healthcare Research with PDF Redaction

Protect Data Privacy in Financial Services with PDF Redaction

Why is pdfRest the best API to redact PDF text?

pdfRest offers the best solution for redacting PDF documents, because it combines trusted Adobe technology, flexible automation options, and advanced data sanitization for compliance.

Trusted PDF Redaction Technology for Reliable Results

When it comes to redacting sensitive information, quality is paramount. Poorly executed redaction can lead to catastrophic data leaks, compromising privacy and security. pdfRest's Redact PDF API is powered by Adobe technology, ensuring reliable and thorough removal of all traces of the content you're trying to redact.

By leveraging trusted redaction technology, pdfRest guarantees that sensitive information is securely and permanently removed, preventing unauthorized access and data breaches.
The API's robust performance provides peace of mind, knowing that your document redaction processes are handled with precision and care, meeting the highest industry standards for data protection and compliance.
With pdfRest, organizations can confidently manage their redaction workflows, knowing that they are using a solution backed by industry-leading technology that prioritizes security and accuracy.

Incorporating pdfRest into your document management practices ensures that your redaction efforts are not only effective but also aligned with best practices for maintaining the confidentiality and integrity of sensitive information.

Redact PDF Files with Flexible and Automated Solutions

pdfRest offers flexible and automated solutions for finding and redacting content in PDFs, catering to a wide range of use cases and requirements. The API supports various types of redactions, allowing users to customize their approach:

Literal: Search for and redact exact string matches.
Regex: Use regular expressions to identify and redact pattern matches.
Preset: Use predefined regex patterns to automatically redact common data such as email addresses, phone numbers, credit cards, and more.

The API also supports a two-stage redaction process:

Preview Stage: Use /pdf-with-redacted-text-preview to generate a redaction preview with red rectangles around the parts to be redacted, based on the requested JSON object.
Application Stage: Send the previews to /pdf-with-redacted-text-applied to apply and finalize the redactions.

This two-stage process is ideal for supporting a manual review step where required to ensure perfect results. Alternatively, the steps can be combined to fully automate the redaction process end-to-end.

Advanced PDF Data Sanitization for Compliance

Ensuring compliance with data protection regulations is crucial for businesses handling sensitive information. pdfRest excels in advanced data sanitization, providing a robust solution for organizations aiming to meet stringent compliance requirements.

The API allows for the secure removal and sanitization of sensitive information from documents before sharing or archiving, ensuring compliance with regulations such as GDPR and HIPAA.
Automating the redaction and sanitization process enhances workflow efficiency, reducing manual intervention and minimizing the risk of human error in handling sensitive data.
With pdfRest, organizations can confidently manage their document redaction processes, knowing that their data sanitization efforts are aligned with industry standards and best practices for data protection.

By leveraging pdfRest's advanced sanitization capabilities, businesses can ensure that their document management practices not only protect sensitive information but also adhere to the highest levels of regulatory compliance.

Start from Code Examples

See more code examples in our GitHub repository

Need more help?

Start with a Tutorial for step-by-step guidance

How to Redact PDF Text in .NET with C#

How to Redact PDF Text with cURL

How to Redact PDF Text with Java

How to Redact PDF Text with Javascript in NodeJS

How to Redact PDF Text with PHP

How to Redact PDF Text with Python

6 items

Customize Your Solution

Learn about the parameters for this tool to create your custom solution.

File

The file parameter allows you to select a local file to be uploaded to pdfRest’s processing server.

See Documentation

The id parameter allows you to submit a resource ID generated by one of our API Tools. Each of our API Tools assigns a unique resource ID to your output file(s), allowing you to chain requests together without having to download intermediate files between requests.

For example, you can submit the output ID you receive from our Merge PDFs tool to redact the result before you download it.

See Documentation

Output

The output parameter lets you set a filename (without extension) for your redacted PDF.

See Documentation

Redactions

The redactions parameter is a required JSON array for the /pdf-with-redacted-text-preview endpoint that specifies the redactions to be applied to a PDF document. Each redaction entry in the array defines the type of redaction and the value to search for and redact. This parameter provides flexibility in identifying and removing sensitive information from documents.

Example:

[
    {
        "type": "literal",
        "value": "John Doe"        
    },
    {
         "type": "regex",
         "value": "(\\$|USD)\\s*\\d{1,3}(,\\d{3})*(\\.\\d{2})?"        
    },
    {
          "type": "preset",
          "value": "credit_card"
     },
     {  
           "type": "preset",
           "value": "email"
     } 
]

Types of Redactions:

Literal: The value is the exact string to search for and redact. This type is useful for removing specific names, words, or phrases.
Regex: The value is a regular expression used to search for pattern matches and redact them. This type is ideal for identifying and removing patterns such as sequences of numbers or specific text formats.
Preset: The value can be set to one of the following predefined types to automatically redact common patterns using a predefined regex:
- email - Email addresses
- phone_number - Phone numbers
- date - Dates
- us_ssn - US Social Security numbers
- url - URLs
- credit_card - Credit card numbers
- credit_debit_pin - Credit/Debit PIN numbers
- bank_routing_number - Bank routing numbers
- international_bank_account_number - International bank account numbers
- swift_bic_number - SWIFT/BIC numbers
- ipv4 - IPv4 addresses
- ipv6 - IPv6 addresses

This parameter allows users to customize their redaction strategy, ensuring that all sensitive information is effectively identified and removed from the document.

See Documentation

RGB Color

rgb_color takes three comma-separated integers from 0 to 255 which indicate the RGB values to color the redaction blocks when they are applied using the /pdf-with-redacted-text-applied endpoint.

This parameter is optional and defaults to black when not specified.

See Documentation