qoppapdf

Welcome to qoppapdf, Qoppa Software's REST API for processing PDF documents.
Use qoppapdf to get information about documents and their contents or convert to html/svg, convert to images,
optimize, linearize, OCR, secure, and sign PDF documents.Get started by creating directories and uploading existing PDFs.
You can also upload images, Word documents, and text documents that will be automatically converted to PDFs.

Data Types

JSON

This action will apply or "burn in" all redaction annotations that are in
this document. The page content that is contained within the redaction
annotation's bounds will be redacted.

CopyActionModel

This action is used to create a copy of a document.

DigitalIDModel

A digital ID used to sign a signature field in the PDF document.

DocumentActionModel

Document actions contain information that is used to copy and modify documents.
DocumentActionModel is abstract and should not be used. Instead, use one of it's subclasses: FlattenAnnotationsActionModel, FlattenFieldsActionModel,
OptimizeActionModel, CopyActionModel, and LinearizeActionModel.

DocumentModel

A PDF document.

DocumentOverviewModel

Information about a document.

FieldModel

A field in the PDF document.

FieldsModel

All fields in the PDF document.

FileModel

A File (folder or normal file).

FlattenAnnotationsActionModel

This action is used to flatten all annotations in the document.

FlattenFieldsActionModel

This action is used to flatten all fields in the document.

FolderModel

A folder.

ImageHandlerModel

An image handler in the optimize settings that controls the output images.

ImageStampActionModel

This action contains information to place an image stamp on one or more pages.

InsertAttachedPagesActionModel

This action is used to insert or append a PDF or image file as a page/pages. An image (jpeg, tiff, gif, png) or pdf file must also be sent as part of the request.

InsertPagesActionModel

Insert page actions are used to insert pages into the document.
InsertPagesActionModel is abstract and should not be used. Instead, use one of it's subclasses: InsertAttachedPagesActionModel and InsertUploadedPagesActionModel.

InsertUploadedPagesActionModel

This action is used to insert or append a PDF that is already uploaded.

LinearizeActionModel

This action is used to linearize a document.

LinkModel

A link to a resource.

NewPageActionModel

This action is used to insert a new blank page.

OCRActionModel

This action is used to perform OCR on one or more pages.

OptimizeActionModel

This action is used to optimize the document with the specified profile.

OptimizeProfileModel

A profile for optimizing. It includes a profile name and the associated Optimize Settings.

OptimizeProfilesModel

All available optimization profiles.

PDFAConvertActionModel

This action is used to convert the document to PDF/A.

PDFPermissionsModel

All permissions in the PDF Document including password permissions, DocMDP permissions, and usage rights.

PageActionModel

Page actions contain information that is used to modify pages.
PageActionModel is abstract and should not be used. Instead, use one of it's subclasses: OCRActionModel, ImageStampActionModel, TextStampActionModel, InsertAttachedPagesActionModel, InsertUploadedPagesActionModel, and NewPageActionModel.

PageModel

A page in the PDF document.

PagesModel

All pages in the PDF Document.

PasswordPermissionsModel

Permissions for operating on the PDF document.

PermissionsModel

Permissions for operating on the PDF document.

PreflightInformationModel

Information about the preflight process.

PreflightResultRecordModel

This object holds information about an issue found in the document. The information
includes a header or short name, a detail string and the page number where the issue
happened.

PreflightResultsModel

All preflight result records.

RectangleModel

A component's boundaries within a page in a PDF document.

SignatureFieldModel

A signature field in the PDF document.

SignatureFieldsModel

All signature fields in the PDF document.

StampActionModel

Stamp actions contain information used to add a stamp to a page in the document. They can be used to create watermarks, headers, and footers.
StampActionModel is abstract and should not be used. Instead, use one of its subclasses: ImageStampActionModel and TextStampActionModel.

TextStampActionModel

This action contains information to place a text stamp on one or more pages.

An image handler in the optimize settings that controls the output images.

Link

A link to a resource.

OptimizeProfile

A profile for optimizing. It includes a profile name and the associated Optimize Settings.

OptimizeProfiles

All available optimization profiles.

PDFPermissions

All permissions in the PDF Document including password permissions, DocMDP permissions, and usage rights.

Page

A page in the PDF document.

Pages

All pages in the PDF Document.

PasswordPermissions

Permissions for operating on the PDF document.

Permissions

Permissions for operating on the PDF document.

PreflightInformation

Information about the preflight process.

PreflightResultRecord

This object holds information about an issue found in the document. The information
includes a header or short name, a detail string and the page number where the issue
happened.

PreflightResults

All preflight result records.

Rectangle

A component's boundaries within a page in a PDF document.

SignatureField

A signature field in the PDF document.

SignatureFields

All signature fields in the PDF document.

WebApplicationException

A web application exception.

Widget

A widget in the PDF Document.

ApplyRedactionsAction

This action will apply or "burn in" all redaction annotations that are in
this document. The page content that is contained within the redaction
annotation's bounds will be redacted.

CopyAction

This action is used to create a copy of a document.

documentActionModel

Document actions contain information that is used to copy and modify documents.
DocumentActionModel is abstract and should not be used. Instead, use one of it's subclasses: FlattenAnnotationsActionModel, FlattenFieldsActionModel,
OptimizeActionModel, CopyActionModel, and LinearizeActionModel.

FlattenAnnotationsAction

This action is used to flatten all annotations in the document.

FlattenFieldsAction

This action is used to flatten all fields in the document.

ImageStampAction

This action contains information to place an image stamp on one or more pages.

InsertAttachedPagesAction

This action is used to insert or append a PDF or image file as a page/pages. An image (jpeg, tiff, gif, png) or pdf file must also be sent as part of the request.

insertPagesActionModel

Insert page actions are used to insert pages into the document.
InsertPagesActionModel is abstract and should not be used. Instead, use one of it's subclasses: InsertAttachedPagesActionModel and InsertUploadedPagesActionModel.

InsertUploadedPagesAction

This action is used to insert or append a PDF that is already uploaded.

LinearizeAction

This action is used to linearize a document.

NewPageAction

This action is used to insert a new blank page.

OCRAction

This action is used to perform OCR on one or more pages.

OptimizeAction

This action is used to optimize the document with the specified profile.

PDFAConvertAction

This action is used to convert the document to PDF/A.

pageActionModel

Page actions contain information that is used to modify pages.
PageActionModel is abstract and should not be used. Instead, use one of it's subclasses: OCRActionModel, ImageStampActionModel, TextStampActionModel, InsertAttachedPagesActionModel, InsertUploadedPagesActionModel, and NewPageActionModel.

stampActionModel

Stamp actions contain information used to add a stamp to a page in the document. They can be used to create watermarks, headers, and footers.
StampActionModel is abstract and should not be used. Instead, use one of its subclasses: ImageStampActionModel and TextStampActionModel.

TextStampAction

This action contains information to place a text stamp on one or more pages.