How to Redact Regions in PDF Files
Redacting sensitive information in PDF documents is crucial for ensuring privacy and compliance with data protection regulations. The [POST] Redact Region API from IronSecure Doc offers an efficient way to hide sensitive text and information in specific regions of a PDF document using true redaction. This API ensures that the redacted data is completely removed and cannot be recovered, making it ideal for handling confidential information in legal, financial, or personal documents.
How to Redact Regions in PDF Files
- Pull and start the IronSecureDoc Docker Image
- Try out the API using Swagger
- Set up the arguments
- Call the API from any preferred language
- Download the resulting PDF document
Pull and Start IronSecureDoc
If you don't have IronSecureDoc running yet, please follow the links below to get it set up:
| Host Locally | Deploy to Cloud |
|---|---|
The [POST] Redact Region API
The [POST] Redact Region API endpoint allows you to hide sensitive information within specific regions of a PDF document using true redaction. This feature is crucial for applications that manage confidential documents, such as legal contracts, medical records, or financial statements. By leveraging this API, you can ensure that sensitive text within defined areas of a PDF is permanently removed, offering both security and compliance.
Please note
Trying It Out in Swagger
Swagger is a powerful tool that enables developers to interact with RESTful APIs through a user-friendly web interface. Whether you're using languages like Python, Java, or others, Swagger offers a convenient way to test and implement this API.
Steps to Redact Region with Swagger
- Access the Swagger UI:
If your API server is running locally, you can access Swagger by navigating to http://localhost:8080/swagger/index.html in your web browser.
- Locate the [POST] Redact Region API:
Within the Swagger UI, find the [POST] /v1/document-services/pdfs/redact-region endpoint.
- Specify Redaction Coordinates:
In this example, we will remove a table from the PDF on page index 1 (i.e., Page #2). Use the following coordinates to define the redaction region:
- Page index (specific_pages): 1
- X Coordinate (region_to_redact_x): 60
- Y Coordinate (region_to_redact_y): 270
- Width (region_to_redact_w): 470
- Height (region_to_redact_h): 200
- Set Optional Parameters:
Optionally, you can add a user or owner password, specify specific pages, or decide whether to draw a black box over the redacted area and save the document with PDF/A or PDF/UA compliance.
- Upload a Sample PDF:
In the request body, upload a sample PDF file where you want to apply the redaction. Ensure that the file is added as pdf_file.
- Execute the Request:
Click "Execute" to run the request. The response will include the redacted PDF, with the table removed from page index 1 as specified.
This Swagger UI interaction allows you to easily test the redaction process, providing immediate feedback on how the coordinates affect the PDF content.
- Check the Output PDF:
The redacted region will be on page 2.
Understanding Input Parameters
Before using this API, it's essential to understand the input parameters required and optional for redacting a region in your PDF. These parameters help define the specific area to redact.
Key Parameters
- pdf_file: The PDF document you want to redact.
- region_to_redact_x: X coordinate of the region to redact (starting from the bottom-left of the page).
- region_to_redact_y: Y coordinate of the region to redact (starting from the bottom-left of the page).
- region_to_redact_w: Width of the region to redact.
- region_to_redact_h: Height of the region to redact.
Optional Parameters
- user_password: If the PDF is password-protected, provide the user password.
- owner_password: Provide the owner password if modifications are restricted.
- specific_pages: Specify which pages to redact. If not provided, the redaction applies to all pages.
- save_as_pdfa: Save the PDF wit h PDF/A-3 compliance.
- save_as_pdfua: Save the PDF with PDF/UA compliance.
API Integration: Python Example
Once you're familiar with the parameters, you can call this API using your preferred programming language. Below is an example of how to integrate this API using Python.
import requests
url = 'http://localhost:8080/v1/document-services/pdfs/redact-region'
headers = {
'accept': '*/*',
'author': 'IronSoftware',
'title': 'REDACT REGION DEMO 2024',
'subject': 'DEMO EXAMPLE'
}
# Open the file
files = {
'pdf_file': ('sample_file.pdf', open('sample_file.pdf', 'rb'), 'application/pdf')
}
# Prepare the argument
data = {
'region_to_redact_x': '60',
'region_to_redact_y': '270',
'region_to_redact_w': '470',
'region_to_redact_h': '200',
'specific_pages':[1]
}
# Call the API
response = requests.post(url, headers=headers, files=files, data=data)
# Save the redacted PDF
with open('redacted_output.pdf', 'wb') as f:
f.write(response.content)
print('PDF redacted successfully.')pyThis Code performs the following steps:
- Load the PDF: The PDF file to be redacted is loaded from the local file system.
- Set Redaction Parameters: Specify the coordinates (X, Y), width, height, and specific page to redact.
- Call the API: The [POST] Redact Region API is called, passing in the necessary parameters.
- Save the Result: The redacted PDF is saved as a new file.
The given region is redacted as shown below.
