How to Validate a ZUGFeRD PDF with Python

This tutorial shows how to validate an existing ZUGFeRD or Factur-X hybrid invoice with Python. It uses the pdfRest Create ZUGFeRD PDF API Tool to submit the invoice PDF to its validation endpoint and print the response without modifying the document.

Why Validate a ZUGFeRD PDF with Python?

Receiving an invoice PDF is not the same as knowing that it is a usable hybrid electronic invoice. A validation step checks the ZUGFeRD or Factur-X package and its PDF/A conformance before a receiving, records, or accounts-payable workflow treats the file as an accepted result.

For example, a Python intake service can validate supplier invoices as they arrive, retain the response with the processing record, and route an unsuccessful result for follow-up before the invoice enters an automated approval path. This gives operational teams a clear decision point rather than discovering a problem later in the workflow.

Validation does not repair or replace the submitted PDF. It reports on the existing hybrid invoice, allowing the calling application to preserve the original, request a corrected version, or route the document to a separate creation or remediation process when appropriate.

What the Request Does

The multipart request contains one PDF in the file field. The endpoint analyzes that existing document and returns validation information; it does not generate a replacement invoice or modify the supplied PDF.

The Python samples use requests and requests-toolbelt. Install those packages in the application environment and keep the API key in an environment variable or other secure configuration store.

How to Validate a ZUGFeRD PDF with Python Code Example

import json
import os
import requests
from requests_toolbelt import MultipartEncoder

# Validate a hybrid ZUGFeRD / Factur-X PDF without modifying it.
# By default, we use the US-based API service. This is the primary endpoint for global use.
api_url = "https://api.pdfrest.com"

# For GDPR compliance and enhanced performance for European users, you can switch to the EU-based service by uncommenting the URL below.
# For more information visit https://pdfrest.com/pricing#how-do-eu-gdpr-api-calls-work
#api_url = "https://eu-api.pdfrest.com"

# Set this path to the completed hybrid ZUGFeRD or Factur-X PDF you want to validate.
api_key = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
zugferd_pdf = "/path/to/zugferd-invoice.pdf"

mp_encoder_zugferd = MultipartEncoder(
    fields={'file': ('zugferd-invoice.pdf', open(zugferd_pdf, 'rb'), 'application/pdf')}
)
headers = {
    'Accept': 'application/json',
    'Content-Type': mp_encoder_zugferd.content_type,
    'Api-Key': api_key
}

print("Sending POST request to validated-zugferd endpoint...")
response = requests.post(api_url + '/validated-zugferd', data=mp_encoder_zugferd, headers=headers)
print("Response status code: " + str(response.status_code))
if response.ok:
    print(json.dumps(response.json(), indent=2))
else:
    print(response.text)

Source: View the multipart sample on GitHub.

Breaking Down the Code

The request is compact, but each field has a distinct role in the hybrid-invoice workflow.

• Submit the finished hybrid invoice. Validation accepts one existing ZUGFeRD or Factur-X PDF through the file field. The code sends it as application/pdf and does not include XML, pdf_file, regenerate_pdf, or render_options.
• Build the multipart request. MultipartEncoder combines file tuples with text fields. Its content_type includes the multipart boundary, so the request headers reuse that value.
• Configure the request safely. Set the service URL, API key, and source paths before running the script. The sample uses requests and requests-toolbelt for the HTTP and multipart work.
• Call the validation endpoint. The request goes to /validated-zugferd, which is the validation endpoint within the Create ZUGFeRD PDF API Tool. It analyzes the submitted document without replacing or modifying it.
• Use the result as a workflow decision. The response.ok branch prints formatted JSON; the other branch prints the error response. Treat output identifiers or validation values as application data only from the successful branch. A receiving or accounts-payable service can continue an accepted path or send an unsuccessful result for review.

Beyond the Tutorial

In this Python tutorial, you submitted an existing hybrid invoice for validation and handled the returned result as application data. That pattern fits an intake gate, a supplier-invoice check, or a controlled audit record.

For the complete request fields, accepted values, response contract, and service limits, review the Create ZUGFeRD PDF API Tool documentation for the validation endpoint. The same endpoint can be used with multipart uploads when the files are present in the current request or with resource IDs after a separate upload step.

The repository also includes a JSON-payload Validate ZUGFeRD PDF sample for Python. That version uploads the source files first and then sends their resource IDs to /validated-zugferd, which is useful when a service already stages input files for later operations.