PDF Security
The FileVerbs PDF API provides tools to enhance the security of your PDF documents through encryption and decryption options. Below are the available security actions and their respective API request formats.
Available PDF Security Actions
Encrypt PDF
Encrypt a PDF document by setting a password. The following settings can be applied:
- password (required): The password that will be used to encrypt the PDF document.
Request Example (JSON):
{
"action": "PdfEncrypt",
"parameters": {
"fileIds": ["66b357061b7f9c2032d6d70f"],
"options": {
"protectSettings": {
"password": "mysecurepassword"
}
}
}
}
Decrypt PDF
Remove encryption from a PDF document. The following settings can be applied:
- password (required): The password that was used to encrypt the PDF document.
Request Example (JSON):
{
"action": "PdfDecrypt",
"parameters": {
"fileIds": ["66b357061b7f9c2032d6d70f"],
"options": {
"protectSettings": {
"password": "mysecurepassword"
}
}
}
}
Redact PDF Content
Redact (hide/remove) sensitive text or keywords in a PDF document. Useful for compliance and privacy use cases.
- keywords (required): A list of keywords or sensitive terms to redact from the PDF.
Request Example (JSON):
{
"action": "PdfRedact",
"parameters": {
"fileIds": ["66b357061b7f9c2032d6d70f"],
"options": {
"redactSettings": {
"keywords": ["confidential", "password", "John Doe"]
}
}
}
}