Encrypt PDF API

Encrypt and protect PDF documents securing with a password.

API Request:

Copy parameter's URL Secret Secret
Optional

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

Show all

Copy parameter's URL Token Token
Optional

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

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

Show all

Copy parameter's URL StoreFile Store file
Optional

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

Default: False

Show all

Copy parameter's URL FileName File name
Optional

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

Show all

Copy parameter's URL Timeout Timeout
Optional

Integer Conversion timeout in seconds.

Default: 900

Range: 10 .. 1200

Show all

Copy parameter's URL Async Asynchronous
Optional

Bool Run conversion job asynchronously.

Default: False

Show all

Copy parameter's URL JobId Job ID
Optional

String Conversion job self generated UUID (RFC 4122) used for getting conversion result asynchronously.

Show all

Copy parameter's URL WebHook WebHook
Optional

String Set WebHook URL to call after asynchronous conversion is finished. Async parameter must be enabled.

Show all

Copy parameter's URL PdfUserPassword PDF User Password
Optional

String User password, required to decrypt encrypted PDF.

Show all

Copy parameter's URL PdfOwnerPassword PDF Owner Password
Optional

String Owner password, required to decrypt encrypted PDF.

Show all

Copy parameter's URL EncryptType Encryption Type
Optional

Collection Sets the encryption type.

Default: AES

Values: 40bit, 128bit, AES, AES256ISO

Show all

Copy parameter's URL EncryptMeta Encrypt Meta
Optional

Bool Encrypt metadata of PDF file.

Default: False

Show all

Copy parameter's URL UserPassword User Password
Optional

String Sets the user 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 OwnerPassword Owner Password
Optional

String Sets the output document owner password. This option will force the user of the PDF to enter a password before Acrobat Reader allows them to change the user password and security permissions.

Show all

Copy parameter's URL NoPrint Deny Printing
Optional

Bool Document printing is denied.

Default: False

Show all

Copy parameter's URL NoChange Deny Changing
Optional

Bool Changing the document is denied.

Default: False

Show all

Copy parameter's URL NoCopy Deny Copying
Optional

Bool Selection and copying of text and graphics is denied.

Default: False

Show all

Copy parameter's URL NoChangeNotes Deny Change Notes
Optional

Bool Adding or changing annotations or form fields is denied.

Default: False

Show all

Copy parameter's URL NoFormEdit Deny Form Editing
Optional

Bool Disables editing of form fields. The following property is for 128 bits and higher encryption.

Default: False

Show all

Copy parameter's URL NoExtract Deny Extract
Optional

Bool Disables extraction of text and graphics. The following property is for 128 bits and higher encryption.

Default: False

Show all

Copy parameter's URL NoAssembly Deny Assembly
Optional

Bool Disables document assembly. The following property is for 128 bits and higher encryption.

Default: False

Show all

Copy parameter's URL NoHdPrint Deny HD Print
Optional

Bool Disables high quality printing. The following property is for 128 bits and higher encryption.

Default: False

Show all

Developer mode

Snippets are autogenerated according to converter parameter choices above. Please select file in "File" or "Files" parameter before using code snippets.

Code snippet is using ConvertAPI JavaScript Client

Code snippet is using ConvertAPI Node.js Client

Code snippet is using ConvertAPI PHP Client

Code snippet is using ConvertAPI Java Client

Code snippet is using ConvertAPI C# Client

Code snippet is using ConvertAPI Ruby Client

Code snippet is using ConvertAPI Python Client

Code snippet is using ConvertAPI Go Client

Code snippet is using command line utility program

For conversions with the multiple file result please refer to the example