Redact PDF API

Automatically find and redact sensitive data in PDFs using AI

Redact PDF features

Automatically detect and black out information in PDF document. Whether you need to secure business documents or protect personal information, our tool provides reliable, efficient, and user-friendly redaction solutions. Start safeguarding your PDFs today with our trusted data masking API.

API Endpoint

ConvertAPI offers a cloud-based solution, which makes Redact PDF conversion effortless with just a single REST-API call:

        HTTP POST
    
https://v2.convertapi.com/convert/pdf/to/redact

Postman OpenAPI cURL CLI

Authenticate your API call

Converting pdf to redact via REST-API is now easier than ever. Sign up for a free account to obtain your authentication secret, append it as a query string parameter to the conversion URL, and voilà! You can find advanced authentication techniques in our docs.

        QUERY AUTHENTICATION
    
https://v2.convertapi.com/convert/pdf/to/redact?auth=secret_or_token

Redact PDF using REST-API in no time!

Once you have your authentication in place, you can convert your files using application/json, multipart/form-data and application/octet-stream content types. A simple HTTP POST request using JSON would look like this:

// Code snippet is using the ConvertAPI JavaScript Client: https://github.com/ConvertAPI/convertapi-js

// Code snippet is using the ConvertAPI Node.js Client: https://github.com/ConvertAPI/convertapi-nodejs

// Code snippet is using the ConvertAPI PHP Client: https://github.com/ConvertAPI/convertapi-php

// Code snippet is using the ConvertAPI Java Client: https://github.com/ConvertAPI/convertapi-java

// Code snippet is using the ConvertAPI C# Client: https://github.com/ConvertAPI/convertapi-dotnet

# Code snippet is using the ConvertAPI Ruby Client: https://github.com/ConvertAPI/convertapi-ruby

# Code snippet is using the ConvertAPI Python Client: https://github.com/ConvertAPI/convertapi-python

// Code snippet is using the ConvertAPI Go Client: https://github.com/ConvertAPI/convertapi-go

REM Code snippet is using the command line utility program: https://github.com/ConvertAPI/convertapi-cli

Conversion request using cURL

You can easily convert pdf to redact with a simple cURL request. Our documentation provides more advanced cURL request techniques.

File conversion using CLI

ConvertAPI CLI allows you to convert files using our command-line file conversion utility tool. Check out CLI documentation for a detailed explanation and usage examples.

REM Code snippet is using the command line utility program: https://github.com/ConvertAPI/convertapi-cli

Try the conversion online - no coding required!

You can try out advanced conversion parameters and test the conversion result online using our interactive demo tool. This tool will produce the same conversion output as if you were using the library from your solution, and it will auto-generate the code snippet for you!

Try for FREE!

Conversion parameters

Presets Collection

Select auto to automatically detect all types of Sensitive Data, disable to turn off AI-based sensitive data detection, or choose a specific document type from the available presets to focus on detecting data according to that document type's guidelines.

The RedactionData parameter can be used in combination with any selected preset, including when detection is disabled, to specify additional custom redaction options.

Values: auto disabled invoice agreement tax healthcare statement employee

MinimumConfidence Double

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

RedactionData String

A JSON array containing values to be redacted (blacked-out) from the PDF, such as exact Text (specific text), Regex (regular expression patterns), or Detect (AI-based detection from the description).

This field can be used in combination with the Presets option to manually specify additional data for redaction alongside AI-based detection.

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