SOAP Web Service API

The webPDF server provides its functions in the form of SOAP 1.2 web services. The exact technical definition of the web services and the methods can be found under "Web Service WSDL Description“.


The webPDF server provides the following web services:


"Converter" - File conversion to PDF format


"Signature" - Digitally sign PDF documents


"Pdfa" - Convert PDF documents to PDF/A format and validate existing PDF/A documents


"Toolbox" - Process PDF documents (e.g., split them, change their security settings, export them as image files, print them)


"URLConverter" - Convert HTML contents which are invoked via URL into PDF documents


"OCR" - Optical character recognition of documents which exist as graphics and conversion to resolved PDF documents


"Barcode" - Used to recognize barcodes in documents in PNG, JPEG, or PDF format and generate barcodes of various formats in PDF documents


The individual web services have SOAP methods (operations) which, together with the parameters (objects), can control the execution of the web services. In the objects, the execution and the behaviour of the web services can be influenced using the respective options and their parameters and values.


The communication of the SOAP web services is based on the exchange of XML data (via Internet protocols, such as HTTP) between the webPDF server and the client. Most programming languages and environments create proxy classes (“client stubs”) to use the web services, which simplifies their use. This takes place by calling the WSDL from the webPDF server in the respective environment.


The SOAP web service and its methods are provided via the proxy classes that were created. You will find a general description of the methods of the web services and their parameters below.