PDF - Check Password Protection

** AVAILABLE MAY / JUNE 2025 **

Overview

The 'PDF - Check Password Protection' action checks for the presence of both 'View' and 'Edit' passwords in the PDF document provided.

Guidance

Where the PDF document supplied is secured with a 'View Password' but a 'View Password' value has not been provided, a null value will be returned for the 'Edit Password' property because the PDF document cannot be opened to verify the presence of an 'Edit Password'.

Credit Count

This action consumes 1 credit per operation.

Note, different Encodian actions can consume different number credits. Please always check the action specific documentation and read What is an Encodian Action for a full description of how credits are consumed.

Default Options

The default 'PDF - Check Password Protection' flow action parameters are detailed below:

• File Content: A Base64 encoded representation of the PDF file to be processed

Please refer to the Obtaining the 'File Contents' Parameter article for guidance on how to obtain the 'File Content' parameter ready to provide to an Encodian flow action.

Advanced Parameters

The advanced 'PDF - Check Password Protection' flow action parameters are detailed below:

• View Password: Set the 'View' password used to view/open the PDF document so that a check can be peformed to verify the presence of an edit password.

Return Parameters

The 'PDF - Check Password Protection' flow action returns the following data. 

Action Specific Return Values

• View Password - A boolean value indicating whether the PDF document provided has a 'View Password'
• Edit Password - A boolean value indicating whether the PDF document provided has an 'Edit Password'

Standard Return Values

• OperationId - The unique ID assigned to this operation.
• HttpStatusCode - The HTTP Status code for the response.
• HttpStatusMessage - The HTTP Status message for the response.
• Errors - An array of error messages should an error occur.
• Operation Status - Indicates whether the operation has been completed, has been queued or has failed.