How to validate a PDF Document in Python

Having validation options in your app is a big step toward better stability and customer satisfaction. There is nothing more frustrating than trying to deal with a problem, only to find out that it’s caused by a broken file. So, let’s work validation into your project in less than 10 minutes; how does that sound?

We need the Cloudmersive API client to speed us on our way, so install that first:

pip install cloudmersive-convert-api-client

Now if we plug a free API key in, we can instance our API. Then use that for calling validate_document_pdf_validation, like so:

from __future__ import print_function
import time
import cloudmersive_convert_api_client
from cloudmersive_convert_api_client.rest import ApiException
from pprint import pprint
# Configure API key authorization: Apikey
configuration = cloudmersive_convert_api_client.Configuration()
configuration.api_key['Apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Apikey'] = 'Bearer'
# create an instance of the API class
api_instance = cloudmersive_convert_api_client.ValidateDocumentApi(cloudmersive_convert_api_client.ApiClient(configuration))
input_file = '/path/to/file' # file | Input file to perform the operation on.
try:
# Validate a PDF document file
api_response = api_instance.validate_document_pdf_validation(input_file)
pprint(api_response)
except ApiException as e:
print("Exception when calling ValidateDocumentApi->validate_document_pdf_validation: %s\n" % e)

And now our file will be validated and we will be returned data in this format:

{
  "DocumentIsValid": true,
  "PasswordProtected": true,
  "ErrorCount": 0,
  "WarningCount": 0,
  "ErrorsAndWarnings": [
    {
      "Description": "string",
      "Path": "string",
      "Uri": "string",
      "IsError": true
    }
  ]
}

Done!