ConvertApi Logo
Sign up

Encrypt PDF API

Encrypt and protect PDF documents securing with a password

PDF

The API for protecting PDF files with user or owner password. Protect PDF with 256-bit AES strongest and most secure level of encryption within the PDF format. Set additional PDF permissions for disabling editing or printing PDF. The files protected with this API guarantee that users' files will be under the best protection.

Advanced properties
Copy parameter's URL Secret Secret
Type: String

Authentication secret must be provided as a query parameter. If omitted, token must be provided.

Show all
Copy parameter's URL Token Token
Type: String

Authentication token must be provided as a query parameter. If omitted, secret must be provided.

Show all
Copy parameter's URL File File Required
Type: File

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

Show all
Copy parameter's URL StoreFile Store file
Type: Bool

Store converted file on our secure server and provides download URL.

Default: False Show all
Copy parameter's URL FileName File name
Type: String

Converted output file name without extension. The extension will be added automatically.

Show all
Copy parameter's URL Timeout Timeout
Type: Integer

Conversion timeout in seconds.

Default: 900 Range: 10 .. 1200 Show all
Copy parameter's URL EncryptionAlgorithm Encryption algorithm
Type: Collection

Sets the encryption algorithm.

Default: Aes128Bit Values: Standard40Bit Standard128Bit Aes128Bit Aes256Bit Show all
Copy parameter's URL EncryptMeta Encrypt Meta
Type: Bool

Encrypt metadata of PDF file.

Default: False Show all
Copy parameter's URL UserPassword User Password
Type: String

Sets the user password (also known as a document open password) in the output PDF document. Users will be asked to enter this password before Acrobat Reader allows them to view the PDF document.

Show all
Copy parameter's URL Password Open Password
Type: String

Sets the password to open protected documents.

Show all
Copy parameter's URL OwnerPassword Owner Password
Type: String

Sets owner password (also known as a permissions password). Using a owner password, you can restrict printing, editing, and copying content in the PDF. Recipients don’t need a password to open the document. They do need a password to change the restrictions the owner set.

Show all
Copy parameter's URL RespectOwnerPassword Respect owner password
Type: Bool

Enable the property if you want to respect the document's owner password and permissions. If disabled - the old owner's password and permissions will be removed by default. Setting this property requires you to enter the correct owner's password into the Password property for protected documents.

Default: False Show all
Copy parameter's URL PreservePermissions Preserve document permissions
Type: Bool

Enable the property if you want to keep the document permissions unchanged. It requires you to specify the OwnerPassword. If enabled, the document permission properties will be ignored.

Default: False Show all
Copy parameter's URL AllowEverything Allow everything
Type: Bool

Enable or disable all permissions. The specific permissions listed below overrides this property.

Default: False Show all
Copy parameter's URL AssembleDocument Assemble document
Type: Bool

Enable or disable assembly of the document - insert, rotate, or delete pages and create bookmarks or thumbnail images.

Default: False Show all
Copy parameter's URL CopyContents Copy contents
Type: Bool

Enable or disable copy or extract text and graphics from the document.

Default: False Show all
Copy parameter's URL ModifyContents Modify contents
Type: Bool

Enable or disable changing the contents of the document.

Default: False Show all
Copy parameter's URL ExtractContents Extract contents
Type: Bool

Enable or disable extract text and graphics.

Default: False Show all
Copy parameter's URL ModifyAnnotations Modify annotations
Type: Bool

Enable or disable adding or modifying text annotations and fill in interactive form fields.

Default: False Show all
Copy parameter's URL FillFormFields Fill form fields
Type: Bool

Enable or disable fill-in existing interactive form fields, including signature fields.

Default: False Show all
Copy parameter's URL PrintDocument Print document
Type: Bool

Enable or disable document printing.

Default: False Show all
Copy parameter's URL PrintFaithfulCopy Print faithful copy
Type: Bool

Enable or disable printing of the document to a representation from which a faithful digital copy of the PDF content could be generated.

Default: False Show all

Code snippet

// 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

<!-- For conversions with the multiple file result please refer to this example: https://repl.it/@ConvertAPI/HTML-Form-with-multiple-file-result -->