PassportPDF REST API Reference
API docs by RedoclyPassportPDF API (1.1.0)
Another brick in the cloud. | Download OpenAPI specification
PassportPDF API is a REST API that lets you perform complex operations on documents and images easily. You may consume the API by using one of our many open source SDKS available in a variety of languages, or any REST client by sending your requests to the appropriate endpoints.
Only HTTPS requests are accepted, and supported TLS versions range from 1.0 to 1.3.
After signing up on PassportPDF, you will be able to see and manage information about your passports. A passport contains a certain number of tokens, depending on the plan associated with it, which will be consumed as you make use of the API.
Each available operation has a base token cost, and a charge method which may vary depending on the type of service provided. You will find these information in the documentation of every operation listed on this page.
PassportPDF API does not use specific HTTP codes to indicate when a request could not be fullfiled, but instead returns a normal 200 response contaning JSON serialized detailed information about the reason of the failure.
Every response returned by an operation contains an Error in its definition, and its presence in a response indicates that something went wrong. It is therefore crucial for a client to always check that a JSON response does not contain a serialized Error object before proceeding further.
Note that no token is charged by the API whenever an error occurs.
Among the information given by the Error model, ResultCode specifies a value of the PassportPDFStatus enumeration, that defines a first level of error information. InternalErrorId defines a unique identifier for the error, which comes very handy for us to troubleshoot any issue you may encounter quickly.
Contains all the information related to an error which has occurred.
{ }Multipart upload/download is available and lets you directly stream a file to/from the API. For example, in the PDF APIs, LoadDocument/LoadDocumentMultipart and SaveDocument/SaveDocumentToFile may be used to upload/download a document using respectively binary data serialization and streaming multipart HTTP requests.
The second approach should be favored when dealing with large files, as it will be much more efficient in that context.
ConfigGetMaxAllowedContentLength
Gets the maximal length of a request content, in bytes.No token is charged for this operation.
Responses
Response Schema:
object (Error) Contains all the information related to an error which has occurred. | |
| Value | integer <int64> The response value. |
Response samples
- 200
ConfigGetSuggestedClientTimeout
Gets the suggested client API timeout, in milliseconds.No token is charged for this operation.
Responses
Response Schema:
object (Error) Contains all the information related to an error which has occurred. | |
| Value | integer <int32> The response value. |
Response samples
- 200
ConfigGetSuggestedMaxClientThreads
Gets the suggested maximum number of threads to be used simultaneously by a client application.No token is charged for this operation.
Responses
Response Schema:
object (Error) Contains all the information related to an error which has occurred. | |
| Value | integer <int32> The response value. |
Response samples
- 200
ConfigGetSupportedOCRLanguages
Gets the list of supported languages for OCR.No token is charged for this operation.
Responses
Response Schema:
object (Error) Contains all the information related to an error which has occurred. | |
| Value | Array of strings or null The response value. |
Response samples
- 200
AnalyzeDocument
Performs AI analysis on any kind of document, of any format, from any source. The response provides extraction of structured data such as key-value pairs and tables as well as complete OCR.20 tokens are charged per page.
Request Body schema: required
An AnalyzeDocumentParameters object specifying the parameters of the action.
Represents the parameters for an AnalyzeDocument action.
Responses
Response Schema:
Represents the response to a document analysis action request.
Request samples
- Payload
{ }Response samples
- 200
QueryDocument
- This is a preview action - Produces an answer to an arbitrary text question related to a document, of any format, which can be provided from any source. The response provides the answer to the question.20 tokens are charged per request.
Request Body schema: required
An QueryDocumentParameters object specifying the parameters of the action.
Represents the parameters for an QueryDocument action.
Responses
Response Schema:
Represents the response to a document query action request.
Request samples
- Payload
{ }Response samples
- 200
SmartRedaction
Performs smart redaction on any kind of document, of any format, from any source. The response provides detected marks and optionally the redacted document, as PDF format.20 tokens are charged per page.
Request Body schema: required
An SmartRedactionParameters object specifying the parameters of the action.
| Immediate | boolean Default: true Specifies whether the redaction marks must be immediately. If set to false, only detected redaction marks will be produced in the response. |
| PageRange | string or null Default: "*" Specifies the page or the page range to be processed. |
| RedactCreditCardNumbers | boolean Default: false Specifies whether the engine must redact credit card numbers. |
| RedactEmailAddresses | boolean Default: false Specifies whether the engine must redact email addresses. |
| RedactIBANs | boolean Default: false Specifies whether the engine must redact IBANs. |
| RedactIPAddresses | boolean Default: false Specifies whether the engine must redact IP addresses. |
| RedactPhoneNumbers | boolean Default: false Specifies whether the engine must redact phone numbers. |
| RedactPostalAddresses | boolean Default: false Specifies whether the engine must redact postal addresses. |
| RedactSocialSecurityNumbers | boolean Default: false Specifies whether the engine must redact social security numbers. |
| RedactURIs | boolean Default: false Specifies whether the engine must redact URIs. |
| RedactVatIDs | boolean Default: false Specifies whether the engine must redact VAT identifiers. |
| RedactVehicleIdentificationNumbers | boolean Default: false Specifies whether the engine must redact vehicle identification numbers. |
Responses
Response Schema:
Represents the response to a document analysis action request.
Request samples
- Payload
{ }Response samples
- 200
DocumentClose
Closes a previously uploaded document.No token is charged for this operation.
Request Body schema: required
A DocumentCloseParameters object specifying the parameters of the action.
Represents the parameters for a close document action.
Responses
Response Schema:
Represents the response to a close document action request.
Request samples
- Payload
{ }Response samples
- 200
DocumentGetPreview
Gets the format, the page count and a thumbnail of a previously uploaded document.1 token is charged per request.
Request Body schema: required
A GetDocumentPreviewParameters object specifying the parameters of the action.
Represents the parameters for a get document preview action.
Responses
Response Schema:
| DocumentFormat | string Default: "UNKNOWN" Enum: "UNKNOWN" "ICO" "BMP" "WBMP" "JPEG" "GIF" "PNG" "TIFF" "FAXG3" "EXIF" "EMF" "WMF" "JNG" "KOALA" "IFF" "MNG" "PCD" "PCX" "PBM" "PBMRAW" "PFM" "PGM" "PGMRAW" "PPM" "PPMRAW" "RAS" "TARGA" "PSD" "CUT" "XBM" "XPM" "DDS" "HDR" "SGI" "EXR" "J2K" "JP2" "PICT" "RAW" "WEBP" "DICOM" "JBIG" "JBIG2" "WSQ" "PDF" "SVG" "TXT" "DOCX" "RTF" "DXF" "ODT" "XLSX" "PPTX" "DOC" "XLS" "PPT" "HTML" "HEIF" "MSG" "EML" "PostScript" Specifies the format of a document. |
| PageCount | integer <int32> Specifies the page count of the document. |
| ThumbnailData | string or null <byte> Specifies the data of a thumbnail from the first page of the document, in PNG format. |
Request samples
- Payload
{ }Response samples
- 200
DocumentLoad
Loads the provided document file.1 token is charged per 10 MB of the input file size.
Request Body schema: required
A LoadDocumentFromByteArrayParameters object specifying the parameters of the action.
Represents the parameters for an image loading request.
Responses
Response Schema:
| DocumentFormat | string Default: "UNKNOWN" Enum: "UNKNOWN" "ICO" "BMP" "WBMP" "JPEG" "GIF" "PNG" "TIFF" "FAXG3" "EXIF" "EMF" "WMF" "JNG" "KOALA" "IFF" "MNG" "PCD" "PCX" "PBM" "PBMRAW" "PFM" "PGM" "PGMRAW" "PPM" "PPMRAW" "RAS" "TARGA" "PSD" "CUT" "XBM" "XPM" "DDS" "HDR" "SGI" "EXR" "J2K" "JP2" "PICT" "RAW" "WEBP" "DICOM" "JBIG" "JBIG2" "WSQ" "PDF" "SVG" "TXT" "DOCX" "RTF" "DXF" "ODT" "XLSX" "PPTX" "DOC" "XLS" "PPT" "HTML" "HEIF" "MSG" "EML" "PostScript" Specifies the format of a document. |
| FileId | string or null Specifies the file identifier of the loaded document. |
| PageCount | integer <int32> Specifies the number of pages into the loaded document. |
| ThumbnailData | string or null <byte> Specifies the data of a thumbnail from the first page of the document, in PNG format. Only applicable if the GetPreview field of the request has been set to true. |
Request samples
- Payload
{ }Response samples
- 200
DocumentLoadFromURI
Loads the provided document file from an URI.1 token is charged per 10 MB of the input file size.
Request Body schema: required
A LoadDocumentFromURIParameters object specifying the parameters of the action.
Represents the parameters for an image loading request.
Responses
Response Schema:
| DocumentFormat | string Default: "UNKNOWN" Enum: "UNKNOWN" "ICO" "BMP" "WBMP" "JPEG" "GIF" "PNG" "TIFF" "FAXG3" "EXIF" "EMF" "WMF" "JNG" "KOALA" "IFF" "MNG" "PCD" "PCX" "PBM" "PBMRAW" "PFM" "PGM" "PGMRAW" "PPM" "PPMRAW" "RAS" "TARGA" "PSD" "CUT" "XBM" "XPM" "DDS" "HDR" "SGI" "EXR" "J2K" "JP2" "PICT" "RAW" "WEBP" "DICOM" "JBIG" "JBIG2" "WSQ" "PDF" "SVG" "TXT" "DOCX" "RTF" "DXF" "ODT" "XLSX" "PPTX" "DOC" "XLS" "PPT" "HTML" "HEIF" "MSG" "EML" "PostScript" Specifies the format of a document. |
| FileId | string or null Specifies the file identifier of the loaded document. |
| PageCount | integer <int32> Specifies the number of pages into the loaded document. |
| ThumbnailData | string or null <byte> Specifies the data of a thumbnail from the first page of the document, in PNG format. Only applicable if the GetPreview field of the request has been set to true. |
Request samples
- Payload
{ }Response samples
- 200
DocumentLoadMultipart
Loads the provided document file using Multipart Upload.1 token is charged per 10 MB of the input file size.
Request Body schema: multipart/form-data
| fileData required | string <binary> |
Responses
Response Schema:
| DocumentFormat | string Default: "UNKNOWN" Enum: "UNKNOWN" "ICO" "BMP" "WBMP" "JPEG" "GIF" "PNG" "TIFF" "FAXG3" "EXIF" "EMF" "WMF" "JNG" "KOALA" "IFF" "MNG" "PCD" "PCX" "PBM" "PBMRAW" "PFM" "PGM" "PGMRAW" "PPM" "PPMRAW" "RAS" "TARGA" "PSD" "CUT" "XBM" "XPM" "DDS" "HDR" "SGI" "EXR" "J2K" "JP2" "PICT" "RAW" "WEBP" "DICOM" "JBIG" "JBIG2" "WSQ" "PDF" "SVG" "TXT" "DOCX" "RTF" "DXF" "ODT" "XLSX" "PPTX" "DOC" "XLS" "PPT" "HTML" "HEIF" "MSG" "EML" "PostScript" Specifies the format of a document. |
| FileId | string or null Specifies the file identifier of the loaded document. |
| PageCount | integer <int32> Specifies the number of pages into the loaded document. |
| ThumbnailData | string or null <byte> Specifies the data of a thumbnail from the first page of the document, in PNG format. Only applicable if the GetPreview field of the request has been set to true. |
Response samples
- 200
All the DocuVieware-related APIs. DocuViewere also includes a JavaScript client API fully documented here: https://www.docuvieware.com/guides/aspnet/JavaScript%20API%20Overview.html
DocuViewareGetControl
Gets the HTML dom of a DocuVieware control.3 tokens are charged for each document loaded through the delivered DocuVieware control, as well as 1 token per 10 MB of their total size.
Request Body schema: required
A DocuViewareGetControlParameters object specifying the parameters of the action.
Represents the parameters for a GetControl action.
Responses
Response Schema:
| Element | string or null The element content, as HTML format. |
Request samples
- Payload
{ }Response samples
- 200
DocuViewareSave
Saves the document being handled by a specific DocuVieware control, in its current state.1 token is charged per request.
Request Body schema: required
A DocuViewareSaveParameters object specifying the parameters of the action.
Represents the parameters for a Save action.
Responses
Response Schema:
| Content | string or null <byte> Specifies the data of the produced file. |
| ContentType | string or null Specifies content type of the produced data. |
Request samples
- Payload
{ }Response samples
- 200
All the image-related APIs. You can use ImageGetSupportedFileExtensions to obtain all the file extensions which can be loaded through these APIs.
ImageAdjust
Adjusts a previously uploaded image.1 token is charged per page.
Request Body schema: required
An ImageAdjustParameters object specifying the parameters for the action.
Represents the parameters for an image adjustment action.
Responses
Response Schema:
Represents the response to an image adjustment action request.
Request samples
- Payload
{ }Response samples
- 200
ImageAutoCrop
Automatically crops a previously uploaded image.2 tokens are charged per page.
Request Body schema: required
An ImageAutoCropParameters object specifying the parameters for the action.
Represents the parameters for an image auto cropping action.
Responses
Response Schema:
Represents the response to an image auto cropping action request.
Request samples
- Payload
{ }Response samples
- 200
ImageCleanupDocument
Cleanup a previously uploaded image.1 token is charged per page.
Request Body schema: required
An ImageCleanupDocumentParameters object specifying the parameters for the action.
Represents the parameters for a cleanup document action.
Responses
Response Schema:
Represents the response to a cleanup document action request.
Request samples
- Payload
{ }Response samples
- 200
ImageCloneRegions
Clones regions from a previously uploaded image into new images.1 token is charged per page.
Request Body schema: required
An ImageCloneRegionsParameters object specifying the parameters of the action.
Represents the parameters for a clone image region action.
Responses
Response Schema:
Array of objects or null (ClonedImageRegion) The images created as a result of the action. |
Request samples
- Payload
{ }Response samples
- 200
ImageClose
Closes a previously uploaded image.No token is charged for this operation.
Request Body schema: required
An ImageCloseParameters object specifying the parameters of the action.
Represents the parameters for a close image action.
Responses
Response Schema:
Represents the response to a close image action request.
Request samples
- Payload
{ }Response samples
- 200
ImageConvertColorDepth
Converts the color depth of a previously uploaded image.1 token is charged per page.
Request Body schema: required
An ImageConvertColorDepthParameters object specifying the parameters for the action.
Represents the parameters for an image color depth change action.
Responses
Response Schema:
Represents the response to an image convert color depth action request.
Request samples
- Payload
{ }Response samples
- 200
ImageCrop
Crops a previously uploaded image.2 tokens are charged per page.
Request Body schema: required
An ImageCropParameters object specifying the parameters for the action.
Represents the parameters for an image crop action.
Responses
Response Schema:
Represents the response to an image crop action request.
Request samples
- Payload
{ }Response samples
- 200
ImageDeletePage
Deletes a page range from a previously uploaded image.1 token is charged per request.
Request Body schema: required
An ImageDeletePageParameters object specifying the parameters of the action.
Represents the parameters for a delete page action.
Responses
Response Schema:
Represents the response to a delete page action request.
Request samples
- Payload
{ }Response samples
- 200
ImageDetectBlankPages
Detects the blank page(s) from a previously uploaded image and offers to remove them.1 token is charged per page.
Request Body schema: required
An ImageDetectBlankPagesParameters object specifying the parameters of the action.
Represents the parameters for a detect blank pages action.
Responses
Response Schema:
| DetectedBlankPages | Array of integers or null <int32> Specifies the number of the pages which have been detected to be blank. |
Request samples
- Payload
{ }Response samples
- 200
ImageDetectColor
Performs color detection on a previously uploaded image.2 tokens are charged per page.
Request Body schema: required
An ImageDetectColorParameters object specifying the parameters for the action.
Represents the parameters for an image color detection action.
Responses
Response Schema:
Array of objects or null (ColorDetectionResult) Specifies the result of the color detection operation performed on each page. |
Request samples
- Payload
{ }Response samples
- 200
ImageDetectPageOrientation
Detects the orientation of the page(s) of a previously uploaded image and offers to automatically rotate them.1 token is charged per page.
Request Body schema: required
An ImagedetectPageOrientationParameters object specifying the parameters of the action.
Represents the parameters for a detect page orientation action.
Responses
Response Schema:
Array of objects or null (PageOrientationInfo) Holds information about the detected page orientations. |
Request samples
- Payload
{ }Response samples
- 200
ImageFilter
Applies filters to a previously uploaded image.1 token is charged per page.
Request Body schema: required
An ImageFilterParameters object specifying the parameters for the action.
Represents the parameters for an image filtering action.
Responses
Response Schema:
Represents the response to an image filtering action request.
Request samples
- Payload
{ }Response samples
- 200
ImageGetPageThumbnail
Gets a thumbnail of each page within the provided page range from a previously uploaded image.1 token is charged per page.
Request Body schema: required
A PDFGetPageThumbnailParameters object specifying the parameters of the action.
Represents the parameters for a get page thumbnail action.
Responses
Response Schema:
Array of objects or null (PageImage) Contains all the obtained thumbnails. |
Request samples
- Payload
{ }Response samples
- 200
ImageGetSupportedFileExtensions
Gets the supported file extensions by the image loading actions.No token is charged for this operation.
Responses
Response Schema:
object (Error) Contains all the information related to an error which has occurred. | |
| Value | Array of strings or null The response value. |
Response samples
- 200
ImageLoad
Loads the provided image file. Supported image formats can be retrieved by the GetSupportedImageFileExtensions action.1 token is charged per 10 MB of the input file size.
Request Body schema: required
A LoadImageFromByteArrayParameters object specifying the parameters of the action.
Represents the parameters for an image loading request.
Responses
Response Schema:
| FileId | string or null Specifies the file identifier of the loaded image document. |
| FileSize | integer <int64> Specifies the size of the loaded image file. |
| ImageFormat | string Default: "UNKNOWN" Enum: "UNKNOWN" "ICO" "BMP" "WBMP" "JPEG" "GIF" "PNG" "TIFF" "FAXG3" "EXIF" "EMF" "WMF" "JNG" "KOALA" "IFF" "MNG" "PCD" "PCX" "PBM" "PBMRAW" "PFM" "PGM" "PGMRAW" "PPM" "PPMRAW" "RAS" "TARGA" "PSD" "CUT" "XBM" "XPM" "DDS" "HDR" "SGI" "EXR" "J2K" "JP2" "PICT" "RAW" "WEBP" "DICOM" "JBIG" "JBIG2" "WSQ" "PDF" "SVG" "TXT" "DOCX" "RTF" "DXF" "ODT" "XLSX" "PPTX" "DOC" "XLS" "PPT" "HTML" "HEIF" "MSG" "EML" "PostScript" Specifies the format of a document. |
| PageCount | integer <int32> Specifies the number of pages into the loaded image. |
| ThumbnailData | string or null <byte> Specifies the data of a thumbnail from the first page of the document, in PNG format. Only applicable if the GetPreview field of the request has been set to true. |
Request samples
- Payload
{ }Response samples
- 200
ImageLoadMultipart
Loads the provided image file using Multipart Upload. Supported image formats can be retrieved by the GetSupportedImageFileExtensions action.1 token is charged per 10 MB of the input file size.
Request Body schema: multipart/form-data
| fileData required | string <binary> |
Responses
Response Schema:
| FileId | string or null Specifies the file identifier of the loaded image document. |
| FileSize | integer <int64> Specifies the size of the loaded image file. |
| ImageFormat | string Default: "UNKNOWN" Enum: "UNKNOWN" "ICO" "BMP" "WBMP" "JPEG" "GIF" "PNG" "TIFF" "FAXG3" "EXIF" "EMF" "WMF" "JNG" "KOALA" "IFF" "MNG" "PCD" "PCX" "PBM" "PBMRAW" "PFM" "PGM" "PGMRAW" "PPM" "PPMRAW" "RAS" "TARGA" "PSD" "CUT" "XBM" "XPM" "DDS" "HDR" "SGI" "EXR" "J2K" "JP2" "PICT" "RAW" "WEBP" "DICOM" "JBIG" "JBIG2" "WSQ" "PDF" "SVG" "TXT" "DOCX" "RTF" "DXF" "ODT" "XLSX" "PPTX" "DOC" "XLS" "PPT" "HTML" "HEIF" "MSG" "EML" "PostScript" Specifies the format of a document. |
| PageCount | integer <int32> Specifies the number of pages into the loaded image. |
| ThumbnailData | string or null <byte> Specifies the data of a thumbnail from the first page of the document, in PNG format. Only applicable if the GetPreview field of the request has been set to true. |
Response samples
- 200
ImageReadBarcodes
Reads barcodes from a previously uploaded image.2 tokens are charged per page.
Request Body schema: required
An ImageReadBarcodesParameters object specifying the parameters of the action.
Represents the parameters for a read barcode action.
Responses
Response Schema:
Array of objects or null (BarcodeInfo) Specifies the information of the different barcodes which have been read. |
Request samples
- Payload
{ }Response samples
- 200
ImageReadMICR
Performs MICR (Magnetic Ink Character Recognition) recognition on any kind of document, of any format, from any source.1 token is charged per page.
Request Body schema: required
An ImageReadMICRParameters object specifying the parameters of the action.
Represents the parameters for a read MICR action.
Responses
Response Schema:
Array of objects or null (MICRResult) Holds the results of the MICR operations. |
Request samples
- Payload
{ }Response samples
- 200
ImageReadMRZ
Performs MRZ (Machine-Readable Zone) recognition on any kind of document, of any format, from any source.1 token is charged per page.
Request Body schema: required
An ImageReadMRZParameters object specifying the parameters of the action.
Represents the parameters for a read MRZ action.
Responses
Response Schema:
Array of objects or null (MRZResult) Holds the results of the MRZ recognition operations. |
Request samples
- Payload
{ }Response samples
- 200
ImageResize
Resizes a previously uploaded image.2 tokens are charged per page.
Request Body schema: required
An ImageResizeParameters object specifying the parameters for the action.
Represents the parameters for an image resize action.
Responses
Response Schema:
Represents the response to an image resize action request.
Request samples
- Payload
{ }Response samples
- 200
ImageRotate
Rotates and/or flips a previously uploaded image.1 token is charged per page.
Request Body schema: required
An ImageRotateParameters object specifying the parameters for the action.
Represents the parameters for an image rotate action.
Responses
Response Schema:
Represents the response to an image rotate action request.
Request samples
- Payload
{ }Response samples
- 200
ImageSaveAsJPEG
Saves a previously uploaded image as JPEG, and sends the file data in a JSON-serialized object.1 token is charged per page.
Request Body schema: required
An ImageSaveAsJPEGParameters object specifying the parameters of the action.
Represents the parameters for a save as JPEG action.
Responses
Response Schema:
Array of objects or null (PageImage) The image(s) saved as JPEG. |
Request samples
- Payload
{ }Response samples
- 200
ImageSaveAsJPEG2000
Saves a previously uploaded image as JPEG2000, and sends the file data in a JSON-serialized object.1 token is charged per page.
Request Body schema: required
An ImageSaveAsJPEG2000Parameters object specifying the parameters of the action.
Represents the parameters for a save as JPEG2000 action.
Responses
Response Schema:
Array of objects or null (PageImage) The image(s) saved as JPEG2000. |
Request samples
- Payload
{ }Response samples
- 200
ImageSaveAsJPEG2000File
Saves a previously uploaded image as JPEG2000, and streams the file binary data to the response (this is the most efficient download method).1 token is charged per page.
Request Body schema: required
An ImageSaveAsJPEGParameters object specifying the parameters of the action.
Represents the parameters for a save as JPEG2000 action.
Responses
Response Schema:
Request samples
- Payload
{ }Response samples
- 200
ImageSaveAsJPEGFile
Saves a previously uploaded image as JPEG, and streams the file binary data to the response (this is the most efficient download method).1 token is charged per page.
Request Body schema: required
An ImageSaveAsJPEGParameters object specifying the parameters of the action.
Represents the parameters for a save as JPEG action.
Responses
Response Schema:
Request samples
- Payload
{ }Response samples
- 200
ImageSaveAsPDF
Saves a previously uploaded image as PDF, and sends the file data in a JSON-serialized object.1 token is charged per page.
Request Body schema: required
An ImagesaveAsPDFParameters object specifying the parameters of the action.
Represents the parameters for a save as PDF action.
Responses
Response Schema:
| FileName | string or null Specifies the name of the saved document. |
| PdfData | string or null <byte> Specifies the data of the produced PDF. |
Request samples
- Payload
{ }Response samples
- 200
ImageSaveAsPDFFile
Saves a previously uploaded image as PDF, and streams the file binary data to the response (this is the most efficient download method).1 token is charged per page.
Request Body schema: required
An ImagesaveAsPDFParameters object specifying the parameters of the action.
Represents the parameters for a save as PDF action.
Responses
Response Schema:
Request samples
- Payload
{ }Response samples
- 200
ImageSaveAsPDFMRC
Saves a previously uploaded image as PDF using MRC compression, and sends the file data in a JSON-serialized object.4 tokens are charged per page.
Request Body schema: required
An ImagesaveAsPDFMRCParameters object specifying the parameters of the action.
Represents the parameters for a save as PDF MRC action.
Responses
Response Schema:
| FileName | string or null Specifies the name of the saved document. |
| PdfData | string or null <byte> Specifies the data of the produced PDF. |
Request samples
- Payload
{ }Response samples
- 200
ImageSaveAsPDFMRCFile
Saves a previously uploaded image as PDF using MRC compression, and streams the file binary data to the response (this is the most efficient download method).4 tokens are charged per page.
Request Body schema: required
An ImagesaveAsPDFMRCParameters object specifying the parameters of the action.
Represents the parameters for a save as PDF MRC action.
Responses
Response Schema:
Request samples
- Payload
{ }Response samples
- 200
ImageSaveAsPNG
Saves a previously uploaded image as PNG, and sends the file data in a JSON-serialized object.1 token is charged per page.
Request Body schema: required
An ImageSaveAsPNGParameters object specifying the parameters of the action.
Represents the parameters for a save as PNG action.
Responses
Response Schema:
Array of objects or null (PageImage) The image(s) saved as PNG. |
Request samples
- Payload
{ }Response samples
- 200
ImageSaveAsPNGFile
Saves a previously uploaded image as PNG, and streams the file binary data to the response (this is the most efficient download method).1 token is charged per page.
Request Body schema: required
An ImageSaveAsPNGParameters object specifying the parameters of the action.
Represents the parameters for a save as PNG action.
Responses
Response Schema:
Request samples
- Payload
{ }Response samples
- 200
ImageSaveAsTIFF
Saves a previously uploaded image as TIFF, and sends the file data in a JSON-serialized object.1 token is charged per page.
Request Body schema: required
An ImageSaveAsTIFFParameters object specifying the parameters of the action.
Represents the parameters for a save as TIFF action.
Responses
Response Schema:
Array of objects or null (PageImage) The image(s) saved as TIFF. |
Request samples
- Payload
{ }Response samples
- 200
ImageSaveAsTIFFFile
Saves a previously uploaded image as TIFF, and streams the file binary data to the response (this is the most efficient download method).1 token is charged per page.
Request Body schema: required
An ImageSaveAsTIFFParameters object specifying the parameters of the action.
Represents the parameters for a save as TIFF action.
Responses
Response Schema:
Request samples
- Payload
{ }Response samples
- 200
ImageSaveAsTIFFMultipage
Saves a previously uploaded image as multipage TIFF, and sends the file data in a JSON-serialized object.1 token is charged per page.
Request Body schema: required
An ImageSaveAsTIFFMultipageParameters object specifying the parameters of the action.
Represents the parameters for a save as TIFF multipage action.
Responses
Response Schema:
| FileName | string or null Specifies the name of the saved document. |
| ImageData | string or null <byte> Specifies the data of the produced multipage TIFF. |
Request samples
- Payload
{ }Response samples
- 200
ImageSaveAsTIFFMultipageFile
Saves a previously uploaded image as multipage TIFF, and streams the file binary data to the response (this is the most efficient download method).1 token is charged per page.
Request Body schema: required
An ImageSaveAsTIFFMultipageParameters object specifying the parameters of the action.
Represents the parameters for a save as TIFF multipage action.
Responses
Response Schema:
Request samples
- Payload
{ }Response samples
- 200
ImageSwapPages
Swaps two pages from a previously uploaded image.1 token is charged per request.
Request Body schema: required
An ImageSwapPagesParameters object specifying the parameters of the action.
Represents the parameters for a swap pages action.
Responses
Response Schema:
Represents the response to a swap pages action request.
Request samples
- Payload
{ }Response samples
- 200
PassportPDFApplicationManagerGetApplicationDownloadLink
No token is charged for this operation.
query Parameters
| applicationId required | string |
Responses
Response Schema:
object (Error) Contains all the information related to an error which has occurred. | |
| Value | string or null The response value. |
Response samples
- 200
PassportPDFApplicationManagerGetApplicationLatestVersion
No token is charged for this operation.
query Parameters
| applicationId required | string |
Responses
Response Schema:
object (Error) Contains all the information related to an error which has occurred. | |
| Value | string or null The response value. |
Response samples
- 200
PassportPDFApplicationManagerGetApplicationMinimumSupportedVersion
No token is charged for this operation.
query Parameters
| applicationId required | string |
Responses
Response Schema:
object (Error) Contains all the information related to an error which has occurred. | |
| Value | string or null The response value. |
Response samples
- 200
PassportPDFApplicationManagerGetMaxClientThreads
Gets the maximum number of threads to be used simultaneously by a client application.No token is charged for this operation.
query Parameters
| applicationId required | string |
Responses
Response Schema:
object (Error) Contains all the information related to an error which has occurred. | |
| Value | integer <int32> The response value. |
Response samples
- 200
Annotate
Annotates a previously uploaded document.1 token is charged per request.
Request Body schema: required
A PdfAnnotateParameters object specifying the parameters of the action.
Represents the parameters for an annotate action.
Responses
Response Schema:
Represents the response to an annotate action request.
Request samples
- Payload
{ }Response samples
- 200
AutoCrop
Automatically crops a page range from a previously uploaded PDF, based on page content.2 tokens are charged per request.
Request Body schema: required
A PdfAutoCropParameters object specifying the parameters of the action.
Represents the parameters for an auto crop action.
Responses
Response Schema:
Represents the response to an auto crop action request.
Request samples
- Payload
{ }Response samples
- 200
AutoDeskew
Performs auto deskew on a page range of a previously uploaded document.1 token is charged per page.
Request Body schema: required
A PdfAutoDeskewParameters object specifying the parameters of the action.
Represents the parameters for an auto deskew action.
Responses
Response Schema:
Represents the response to an auto deskew action request.
Request samples
- Payload
{ }Response samples
- 200
ClearPage
Clears a page range from a previously uploaded document.1 token is charged per request.
Request Body schema: required
A PdfClearPageParameters object specifying the parameters of the action.
Represents the parameters for a clear page action.
Responses
Response Schema:
Represents the response to a clear page action request.
Request samples
- Payload
{ }Response samples
- 200
ClonePage
Clones specific pages from a previously uploaded document to another previously uploaded document.2 tokens are charged per request.
Request Body schema: required
A PdfClonePageParameters object specifying the parameters of the action.
Represents the parameters for a ClonePage action.
Responses
Response Schema:
Represents the response to a ClonePage action request.
Request samples
- Payload
{ }Response samples
- 200
ClosePDF
Closes a previously uploaded document.No token is charged for this operation.
Request Body schema: required
A PdfCloseDocumentParameters object specifying the parameters of the action.
Represents the parameters for a close document action.
Responses
Response Schema:
Represents the response to a close document action request.
Request samples
- Payload
{ }Response samples
- 200
ConvertToGrayscale
Converts a page range of a previously uploaded PDF to grayscale.5 tokens are charged per request.
Request Body schema: required
A PdfConvertToGrayscaleParameters object specifying the parameters of the action.
Represents the parameters for a convert to grayscale action.
Responses
Response Schema:
Represents the response to a convert to grayscale action request.
Request samples
- Payload
{ }Response samples
- 200
ConvertToPDFA
Converts a previously uploaded document to PDF/A.10 tokens are charged per request.
Request Body schema: required
A PdfConvertToPDFAParameters object specifying the parameters of the action.
Represents the parameters for a convert to PDF/A action.
Responses
Response Schema:
Represents the response to a convert to PDF/A action request.
Request samples
- Payload
{ }Response samples
- 200
DeletePage
Deletes a page range from a previously uploaded document.1 token is charged per request.
Request Body schema: required
A PdfDeletePageParameters object specifying the parameters of the action.
Represents the parameters for a delete page action.
Responses
Response Schema:
Represents the response to a delete page action request.
Request samples
- Payload
{ }Response samples
- 200
DetectPageOrientation
Detects the orientation of the page(s) of a previously uploaded document and offers to automatically rotate them.1 token is charged per page.
Request Body schema: required
A PdfDetectPageOrientationParameters object specifying the parameters of the action.
Represents the parameters for a detect page orientation action.
Responses
Response Schema:
Array of objects or null (PageOrientationInfo) Holds information about the detected page orientations. |
Request samples
- Payload
{ }Response samples
- 200
DigiSign
Signs a previously uploaded document digitally.5 tokens are charged per request.
Request Body schema: required
A PdfDigiSignParameters object specifying the parameters of the action.
Represents the parameters for a digital signature action.
Responses
Response Schema:
Represents the response to a digital signature action request.
Request samples
- Payload
{ }Response samples
- 200
DrawImage
Draws an image on a page range of a previously uploaded document.1 token is charged per request.
Request Body schema: required
A PdfDrawImageParameters object specifying the parameters of the action.
Represents the parameters for a draw image action.
Responses
Response Schema:
Represents the response to a draw image action request.
Request samples
- Payload
{ }Response samples
- 200
ExtractPage
Extracts a page range from a previously uploaded document into one or several new documents.5 tokens are charged per request.
Request Body schema: required
A PdfExtractPageParameters object specifying the parameters of the action.
Represents the parameters for an extract page action.
Responses
Response Schema:
| FileData | Array of strings or null <byte> Specifies the data of the file(s) created as a result of the action. If immediate download is not requested, no file data will be returned. |
| FileIds | Array of strings or null Specifies the identifier(s) of the file(s) created as a result of the action. If immediate download is requested, no file identifier will be returned. |
Request samples
- Payload
{ }Response samples
- 200
ExtractText
Extracts text from the document pages.1 token is charged per request.
Request Body schema: required
A PdfExtractTextParameters object specifying the parameters of the action.
Represents the parameters for an extract text action.
Responses
Response Schema:
Array of objects or null (PageText) The text extraction results from individual pages. |
Request samples
- Payload
{ }Response samples
- 200
Flatten
Flattens the form-fields, annotations, and/or the layers of a previously uploaded document.2 tokens are charged per request.
Request Body schema: required
A PdfFlatten object specifying the parameters of the action.
Represents the parameters for a flatten action.
Responses
Response Schema:
Represents the response to a flatten action request.
Request samples
- Payload
{ }Response samples
- 200
GetInfo
Gets information about a previously uploaded document.1 token is charged per request.
Request Body schema: required
A PdfGetInfoParameters object specifying the parameters of the action.
Represents the parameters for a get info action.
Responses
Response Schema:
| Author | string or null Specifies the author name specified within the PDF, if any. |
| CanAddNotes | boolean Specifies if the user is allowed to add annotations. |
| CanAssemble | boolean Specifies if the user is allowed to assemble the document. |
| CanCopy | boolean Specifies if the user is allowed to copy or extract text and graphics from the document. |
| CanCopyAccess | boolean Specifies if the user is allowed for copying or extracting for use with accessibility features. |
| CanFillFields | boolean Specifies if the user is allowed to fill-in form fields. |
| CanModify | boolean Specifies if the user is allowed to modify the document. |
| CanPrint | boolean Specifies if the user is allowed to print the document, but possibly not at the highest quality level. |
| CanPrintFull | boolean Specifies if the user is allowed to print the document with high resolution. |
| CreationDate | string or null Specifies the date and time the document was created, as set in the document information dictionary. |
| Encryption | string Default: "PdfEncryptionNone" Enum: "PdfEncryptionNone" "PdfEncryption40BitRC4" "PdfEncryption128BitRC4" "PdfEncryption128BitAES" "PdfEncryption256BitAES" Specifies the encryption algorithm. |
| HasOwnerPassword | boolean Specifies if the PDF is protected with a owner password. |
| HasUserPassword | boolean Specifies if the PDF is protected with a user password. |
| IsLinearized | boolean Specifies whether the document is a valid linearized PDF (optimized for web viewing). |
| IsTagged | boolean Specifies whether the document conforms to Tagged PDF conventions. |
| Keywords | string or null Specifies the keywords associated with the PDF, if any. |
| Metadata | string or null Specifies the metadata contained within the PDF, if any. |
| ModificationDate | string or null Specifies the date and time the document was last modified, as set in the document information dictionary. |
| PageCount | integer <int32> Specifies the number of pages of the PDF. |
| Producer | string or null Specifies the producer name specified within the PDF, if any. |
| Subject | string or null Specifies the document subject specified within the PDF, if any. |
| Title | string or null Specifies the document title specified within the PDF, if any. |
| Version | string or null Specifies the version of the PDF. |
Request samples
- Payload
{ }Response samples
- 200
GetMetadata
Gets the metadata from a previously uploaded PDF as a string in the XMP standardized format.1 token is charged per request.
Request Body schema: required
A PdfGetMetadataParameters object specifying the parameters of the action.
Represents the parameters for a get metadata action.
Responses
Response Schema:
| Metadata | string or null The value of the document's metadata as a string in the XMP standardized format. |
Request samples
- Payload
{ }Response samples
- 200
GetPageThumbnail
Gets a thumbnail of each page within the provided page range from a previously uploaded document.1 token is charged per page.
Request Body schema: required
A PdfGetPageThumbnailParameters object specifying the parameters of the action.
Represents the parameters for a get page thumbnail action.
Responses
Response Schema:
Array of objects or null (PageImage) Contains all the obtained thumbnails. |
Request samples
- Payload
{ }Response samples
- 200
GetPDFImportSupportedFileExtensions
Gets the supported file extensions by the LoadDocumentAsPDF action.No token is charged for this operation.
Responses
Response Schema:
object (Error) Contains all the information related to an error which has occurred. | |
| Value | Array of strings or null The response value. |
Response samples
- 200
InsertImage
Inserts an image on a new page of a previously uploaded document.1 token is charged per request.
Request Body schema: required
A PdfInsertImageParameters object specifying the parameters of the action.
Represents the parameters for an insert image action.
Responses
Response Schema:
Represents the response to an insert image action request.
Request samples
- Payload
{ }Response samples
- 200
InsertNewPage
Inserts one or more new blank pages to a specific position in a previously uploaded document.1 token is charged per request.
Request Body schema: required
A PdfInsertNewPageParameters object specifying the parameters of the action.
Represents the parameters for an insert new page action.
Responses
Response Schema:
Represents the response to an insert new page action request.
Request samples
- Payload
{ }Response samples
- 200
InsertPageNumber
Inserts page number(s) on a document.1 token is charged per request.
Request Body schema: required
A PdfInsertPageNumberParameters object specifying the parameters of the action.
Represents the parameters for an insert page number action.
Responses
Response Schema:
Represents the response to an insert page number action request.
Request samples
- Payload
{ }Response samples
- 200
InsertText
Inserts text on a document.1 token is charged per request.
Request Body schema: required
A PdfInsertTextParameters object specifying the parameters of the action.
Represents the parameters for an insert text action.
Responses
Response Schema:
Represents the response to an insert text action request.
Request samples
- Payload
{ }Response samples
- 200
Linearize
Linearizes a previously uploaded document.2 tokens are charged per request.
Request Body schema: required
A PdfLinearizeParameters object specifying the parameters of the action.
Represents the parameters for a linearize action.
Responses
Response Schema:
Represents the response to a linearize action request.
Request samples
- Payload
{ }Response samples
- 200
LoadDocumentAsPDF
Imports the provided document as PDF. Supported document formats can be retrieved by the GetPDFImportSupportedFileExtensions action.1 token is charged per 10 MB of the input file size.
Request Body schema: required
A PdfLoadDocumentFromByteArrayParameters object specifying the parameters of the action.
Represents the parameters for a load document action request.
Responses
Response Schema:
| Encryption | string Default: "PdfEncryptionNone" Enum: "PdfEncryptionNone" "PdfEncryption40BitRC4" "PdfEncryption128BitRC4" "PdfEncryption128BitAES" "PdfEncryption256BitAES" Specifies the encryption algorithm. |
| FileId | string or null Specifies the file identifier of the loaded document. |
| FileSize | integer <int64> Specifies the size of the loaded file. |
| PageCount | integer <int32> Specifies the number of pages into the loaded document. |
| PasswordIsRequired | boolean Specifies if a password will be subsequently required to open the document. Password can be provided using the SetPassword action / method. |
| ThumbnailData | string or null <byte> Specifies the data of a thumbnail from the first page of the document, in PNG format. Only applicable if the GetPreview field of the request has been set to true. |
Request samples
- Payload
{ }Response samples
- 200
LoadDocumentAsPDFFromHTTP
Imports the content stored at a specific HTTP URI as PDF. Supported document formats can be retrieved by the GetPDFImportSupportedFileExtensions action.1 token is charged per 10 MB of the input file size.
Request Body schema: required
A PdfLoadDocumentFromHTTPParameters object specifying the parameters of the action.
Represents the parameters for importing a document as PDF from an URI.
Responses
Response Schema:
| Encryption | string Default: "PdfEncryptionNone" Enum: "PdfEncryptionNone" "PdfEncryption40BitRC4" "PdfEncryption128BitRC4" "PdfEncryption128BitAES" "PdfEncryption256BitAES" Specifies the encryption algorithm. |
| FileId | string or null Specifies the file identifier of the loaded document. |
| FileSize | integer <int64> Specifies the size of the loaded file. |
| PageCount | integer <int32> Specifies the number of pages into the loaded document. |
| PasswordIsRequired | boolean Specifies if a password will be subsequently required to open the document. Password can be provided using the SetPassword action / method. |
| ThumbnailData | string or null <byte> Specifies the data of a thumbnail from the first page of the document, in PNG format. Only applicable if the GetPreview field of the request has been set to true. |
Request samples
- Payload
{ }Response samples
- 200
LoadDocumentAsPDFMultipart
Imports the provided document as PDF using Multipart Upload. Supported document formats can be retrieved by the GetPDFImportSupportedFileExtensions action.1 token is charged per 10 MB of the input file size.
Request Body schema: multipart/form-data
| fileData required | string <binary> |
Responses
Response Schema:
| Encryption | string Default: "PdfEncryptionNone" Enum: "PdfEncryptionNone" "PdfEncryption40BitRC4" "PdfEncryption128BitRC4" "PdfEncryption128BitAES" "PdfEncryption256BitAES" Specifies the encryption algorithm. |
| FileId | string or null Specifies the file identifier of the loaded document. |
| FileSize | integer <int64> Specifies the size of the loaded file. |
| PageCount | integer <int32> Specifies the number of pages into the loaded document. |
| PasswordIsRequired | boolean Specifies if a password will be subsequently required to open the document. Password can be provided using the SetPassword action / method. |
| ThumbnailData | string or null <byte> Specifies the data of a thumbnail from the first page of the document, in PNG format. Only applicable if the GetPreview field of the request has been set to true. |
Response samples
- 200
Merge
Merges several previously uploaded documents into a new PDF.5 tokens are charged per request.
Request Body schema: required
A PdfMergeParameters object specifying the parameters of the action.
Represents the parameters for a merge action.
Responses
Response Schema:
| FileId | string or null Specifies the file identifier of the merged document. |
Request samples
- Payload
{ }Response samples
- 200
MergePages
Merges multiple pages, vertically, within a previously uploaded document into one single page.1 token is charged per request.
Request Body schema: required
A PdfMergePages object specifying the parameters of the action.
Represents the parameters for a merge pages action request.
Responses
Response Schema:
Represents the response to a merge pages action request.
Request samples
- Payload
{ }Response samples
- 200
MovePage
Moves a page range from a previously uploaded document.1 token is charged per request.
Request Body schema: required
A PdfMovePageParameters object specifying the parameters of the action.
Represents the parameters for a move pages action.
Responses
Response Schema:
Represents the response to a move page action request.
Request samples
- Payload
{ }Response samples
- 200
OCR
Performs optical character recognition on a page range of a previously uploaded document. The recognized text is added as invisible text on each processed page. No token is charged for blank pages.12 tokens are charged per page.
Request Body schema: required
A PdfOCRParameters object specifying the parameters of the action.
Represents the parameters for an OCR action.
Responses
Response Schema:
Represents the response to an OCR action request.
Request samples
- Payload
{ }Response samples
- 200
Protect
Protects a previously uploaded document.2 tokens are charged per request.
Request Body schema: required
A PdfProtectParameters object specifying the parameters of the action.
Represents the parameters for a protect action.
Responses
Response Schema:
Represents the response to a protect action request.
Request samples
- Payload
{ }Response samples
- 200
ReadBarcodes
Reads barcodes from a previously uploaded document.2 tokens are charged per page.
Request Body schema: required
A PdfReadBarcodesParameters object specifying the parameters of the action.
Represents the parameters for a read barcode action.
Responses
Response Schema:
Array of objects or null (BarcodeInfo) Specifies the information of the different barcodes which have been read. |
Request samples
- Payload
{ }Response samples
- 200
Redact
Redacts a previously uploaded document.5 tokens are charged per page.
Request Body schema: required
A PdfRedactParameters object specifying the regions to redact.
Represents the parameters for a Redact action.
Responses
Response Schema:
Represents the response to a Redact action request.
Request samples
- Payload
{ }Response samples
- 200
Reduce
Reduces the size of a previously uploaded document.5 tokens are charged per request.If MRC compression is enabled 4 additional tokens per MRC encoded image will be charged.
Request Body schema: required
A PdfReduceParameters object specifying the parameters of the action.
Represents the parameters for a reduce action.
Responses
Response Schema:
| ContentRemoved | boolean Specifies whether content has been removed from the PDF during the process of the reduce action. |
object (ReduceErrorInfo) Represents information about an error which caused the failure of a reduce action. | |
| NewFileSize | integer <int64> Specify the size of the new created document. |
| VersionChanged | boolean Specifies whether the version of the PDF has changed during the process of the reduce action. |
Array of objects or null (ReduceWarningInfo) Specifies the different warnings that occurred during the process of the reduce action. |
Request samples
- Payload
{ }Response samples
- 200
RemovePageFormFields
Removes the form fields from a page range of a previously uploaded document.1 token is charged per request.
Request Body schema: required
A PdfRemovePageFormFieldsParameters object specifying the parameters of the action.
Represents the parameters for a remove page form fields action.
Responses
Response Schema:
Represents the response to a remove page form fields action request.
Request samples
- Payload
{ }Response samples
- 200
RemoveText
Removes text (all text or only invisible one) from a previously uploaded PDF.2 tokens are charged per request.
Request Body schema: required
A PdfRemoveTextParameters object specifying the parameters of the action.
Represents the parameters for a remove text action.
Responses
Response Schema:
Represents the response to a remove text action request.
Request samples
- Payload
{ }Response samples
- 200
ReorderPages
Reorders pages of a previously uploaded document.1 token is charged per request.
Request Body schema: required
A PdfReorderPagesParameters object specifying the parameters of the action.
Represents the parameters for a reorder pages action.
Responses
Response Schema:
Represents the response to a swap pages action request.
Request samples
- Payload
{ }Response samples
- 200
RepairDocument
Repairs a previously uploaded PDF document.2 tokens are charged per request.
Request Body schema: required
A PdfRepairDocumentParameters object specifying the parameters of the action.
Represents the parameters for a repair document action.
Responses
Response Schema:
| FileId | string or null Specifies the file identifier of the repaired document. |
Request samples
- Payload
{ }Response samples
- 200
RotatePageStandard
Rotates (standardly) a page range from a previously uploaded document.1 token is charged per request.
Request Body schema: required
A PdfRotatePageStandardParameters object specifying the parameters of the action.
Represents the parameters for a rotate page standard action.
Responses
Response Schema:
Represents the response to a rotate page standard action request.
Request samples
- Payload
{ }Response samples
- 200
PdfSaveAsDOCXResponse
Saves a previously uploaded document as DOCX, and sends the file data in a JSON-serialized object.2 tokens are charged per page.
Request Body schema: required
A PdfSaveAsDOCXParameters object specifying the parameters of the action.
Represents the parameters for a save as DOCX action.
Responses
Response Schema:
| Data | string or null <byte> Specifies the data of the saved document. |
| FileName | string or null Specifies the name of the saved document. |
Request samples
- Payload
{ }Response samples
- 200
SaveAsDOCXFile
Saves a previously uploaded document as DOCX, and streams the file binary data to the response (this is the most efficient download method).2 tokens are charged per page.
Request Body schema: required
A PdfSaveAsDOCXParameters object specifying the parameters of the action.
Represents the parameters for a save as DOCX action.
Responses
Response Schema:
Request samples
- Payload
{ }Response samples
- 200
SaveAsJPEG
Saves a previously uploaded document as JPEG, and sends the file data in a JSON-serialized object.1 token is charged per page.
Request Body schema: required
A PdfSaveAsJPEGParameters object specifying the parameters of the action.
Represents the parameters for a save as JPEG action.
Responses
Response Schema:
Array of objects or null (PageImage) The page(s) of the PDF saved as JPEG image(s). |
Request samples
- Payload
{ }Response samples
- 200
SaveAsJPEGFile
Saves a previously uploaded document as JPEG, and streams the file binary data to the response (this is the most efficient download method).1 token is charged per page.
Request Body schema: required
A PdfSaveAsJPEGParameters object specifying the parameters of the action.
Represents the parameters for a save as JPEG action.
Responses
Response Schema:
Request samples
- Payload
{ }Response samples
- 200
SaveAsPNG
Saves a previously uploaded document as PNG, and sends the file data in a JSON-serialized object.1 token is charged per page.
Request Body schema: required
A PdfSaveAsPNGParameters object specifying the parameters of the action.
Represents the parameters for a save as PNG action.
Responses
Response Schema:
Array of objects or null (PageImage) The page(s) of the PDF saved as PNG image(s). |
Request samples
- Payload
{ }Response samples
- 200
SaveAsPNGFile
Saves a previously uploaded document as PNG, and streams the file binary data to the response (this is the most efficient download method).1 token is charged per page.
Request Body schema: required
A PdfSaveAsPNGParameters object specifying the parameters of the action.
Represents the parameters for a save as PNG action.
Responses
Response Schema:
Request samples
- Payload
{ }Response samples
- 200
PdfSaveAsPPTXResponse
Saves a previously uploaded document as PPTX, and sends the file data in a JSON-serialized object.2 tokens are charged per page.
Request Body schema: required
A PdfSaveAsPPTXParameters object specifying the parameters of the action.
Represents the parameters for a save as PPTX action.
Responses
Response Schema:
| Data | string or null <byte> Specifies the data of the saved document. |
| FileName | string or null Specifies the name of the saved document. |
Request samples
- Payload
{ }Response samples
- 200
SaveAsPPTXFile
Saves a previously uploaded document as PPTX, and streams the file binary data to the response (this is the most efficient download method).2 tokens are charged per page.
Request Body schema: required
A PdfSaveAsPPTXParameters object specifying the parameters of the action.
Represents the parameters for a save as PPTX action.
Responses
Response Schema:
Request samples
- Payload
{ }Response samples
- 200
SaveAsTIFF
Saves a previously uploaded document as TIFF, and sends the file data in a JSON-serialized object.1 token is charged per page.
Request Body schema: required
A PdfSaveAsTIFFParameters object specifying the parameters of the action.
Represents the parameters for a save as TIFF action.
Responses
Response Schema:
Array of objects or null (PageImage) The page(s) of the PDF saved as TIFF image(s). |
Request samples
- Payload
{ }Response samples
- 200
SaveAsTIFFFile
Saves a previously uploaded document as TIFF, and streams the file binary data to the response (this is the most efficient download method).1 token is charged per page.
Request Body schema: required
A PdfSaveAsTIFFParameters object specifying the parameters of the action.
Represents the parameters for a save as TIFF action.
Responses
Response Schema:
Request samples
- Payload
{ }Response samples
- 200
SaveAsTIFFMultipage
Saves a previously uploaded document as multipage TIFF, and sends the file data in a JSON-serialized object.1 token is charged per page.
Request Body schema: required
A PdfSaveAsTIFFMultipageParameters object specifying the parameters of the action.
Represents the parameters for a save as TIFF multipage action.
Responses
Response Schema:
| FileName | string or null Specifies the name of the saved document. |
| ImageData | string or null <byte> Specifies the data of the produced multipage TIFF. |
Request samples
- Payload
{ }Response samples
- 200
SaveAsTIFFMultipageFile
Saves a previously uploaded document as multipage TIFF, and streams the file binary data to the response (this is the most efficient download method).1 token is charged per page.
Request Body schema: required
A PdfSaveAsTIFFMultipageParameters object specifying the parameters of the action.
Represents the parameters for a save as TIFF multipage action.
Responses
Response Schema:
Request samples
- Payload
{ }Response samples
- 200
PdfSaveAsXLSXResponse
Saves a previously uploaded document as XLSX, and sends the file data in a JSON-serialized object.2 tokens are charged per page.
Request Body schema: required
A PdfSaveAsXLSXParameters object specifying the parameters of the action.
Represents the parameters for a save as XLSX action.
Responses
Response Schema:
| Data | string or null <byte> Specifies the data of the saved document. |
| FileName | string or null Specifies the name of the saved document. |
Request samples
- Payload
{ }Response samples
- 200
SaveAsXLSXFile
Saves a previously uploaded document as XLSX, and streams the file binary data to the response (this is the most efficient download method).2 tokens are charged per page.
Request Body schema: required
A PdfSaveAsXLSXParameters object specifying the parameters of the action.
Represents the parameters for a save as XLSX action.
Responses
Response Schema:
Request samples
- Payload
{ }Response samples
- 200
SaveDocument
Saves a previously uploaded document as PDF, and sends the file data in a JSON-serialized object.1 token is charged per request.
Request Body schema: required
A PdfSaveDocumentParameters object specifying the parameters of the action.
Represents the parameters for a save document action.
Responses
Response Schema:
| Data | string or null <byte> Specifies the data of the saved document. |
| FileName | string or null Specifies the name of the saved document. |
Request samples
- Payload
{ }Response samples
- 200
SaveDocumentToFile
Saves a previously uploaded document as PDF, and streams the file binary data to the response (this is the most efficient download method).1 token is charged per request.
Request Body schema: required
A PdfSaveDocumentParameters object specifying the parameters of the action.
Represents the parameters for a save document action.
Responses
Response Schema:
Request samples
- Payload
{ }Response samples
- 200
ScalePage
Scales a page range from a previously uploaded document.1 token is charged per request.
Request Body schema: required
A PdfScalePage object specifying the parameters of the action.
Represents the parameters for a scale page action.
Responses
Response Schema:
Represents the response to a scale page action request.
Request samples
- Payload
{ }Response samples
- 200
SetInfo
Sets information to a previously uploaded document.1 token is charged per request.
Request Body schema: required
A PdfSetInfoParameters object specifying the parameters of the action.
Represents the parameters for a set info action.
Responses
Response Schema:
Represents the response to a set info action request.
Request samples
- Payload
{ }Response samples
- 200
SetInitialView
Sets various document level initial view options to a previously uploaded document.1 token is charged per request.
Request Body schema: required
A PdfsetInitialViewParameters object specifying the parameters of the action.
Represents the parameters for a set initial view action.
Responses
Response Schema:
Represents the response to a set initial view action request.
Request samples
- Payload
{ }Response samples
- 200
SetMetadata
Sets the metadata of a previously uploaded PDF.1 token is charged per request.
Request Body schema: required
A PdfSetMetadataParameters object specifying the parameters of the action.
Represents the parameters for a set metadata action.
Responses
Response Schema:
Represents the response to a set metadata action request.
Request samples
- Payload
{ }Response samples
- 200
SetPageBox
Sets pagebox to a page range from previously uploaded document.1 token is charged per request.
Request Body schema: required
A PdfSetPageBoxParameters object specifying the parameters of the action.
Represents the parameters for a SetPageBox action.
Responses
Response Schema:
Represents the response to a SetPageBox action request.
Request samples
- Payload
{ }Response samples
- 200
SetPassword
Unprotects a previously uploaded document.1 token is charged per request.
Request Body schema: required
A PdfSetPasswordParameters object specifying the parameters of the action.
Represents the parameters for an unprotect action.
Responses
Response Schema:
Represents the response to an unprotect action request.
Request samples
- Payload
{ }Response samples
- 200
Split
Splits a previously uploaded document into new ones.5 tokens are charged per request.
Request Body schema: required
A PdfSplitParameters object specifying the parameters of the action.
Represents the parameters for a split action.
Responses
Response Schema:
| FileData | Array of strings or null <byte> Specifies the data of the file(s) created as a result of the action. If immediate download is not requested, no file data will be returned. |
| FileIds | Array of strings or null Specifies the identifier(s) of the file(s) created as a result of the action. If immediate download is requested, no file identifier will be returned. |
Request samples
- Payload
{ }Response samples
- 200
SwapPages
Swaps two pages from a previously uploaded document.1 token is charged per request.
Request Body schema: required
A PdfSwapPagesParameters object specifying the parameters of the action.
Represents the parameters for a swap pages action.
Responses
Response Schema:
Represents the response to a swap pages action request.
Request samples
- Payload
{ }Response samples
- 200
Unprotect
Unprotects a previously uploaded document.2 tokens are charged per request.
Request Body schema: required
A PdfUnprotectParameters object specifying the parameters of the action.
Represents the parameters for an unprotect action.
Responses
Response Schema:
Represents the response to an unprotect action request.
Request samples
- Payload
{ }Response samples
- 200
ValidatePDFA
Validates a previously uploaded document to a requested PDF/A standard.5 tokens are charged per request.
Request Body schema: required
A PdfValidatePDFAParameters object specifying the parameters of the action.
Represents the parameters for a validate PDF/A action.
Responses
Response Schema:
| Conformance | string Default: "Autodetect" Enum: "Autodetect" "PDFA1a" "PDFA1b" "PDFA2a" "PDFA2b" "PDFA2u" "PDFA3a" "PDFA3b" "PDFA3u" "PDFA4" "PDFA4e" "PDFA4f" Specifies the different available PDF/A conformance levels for validation. |
| DetailedXMLOutput | string or null Provides a detailed validation result in machine readable XML report. If the file does not conform to the requested standard, the XML report will summarize all the problems found during the validation process. |
| IsValid | boolean Provides a simple validation result; true if the document conforms to the requested standard, false otherwise. |
Request samples
- Payload
{ }Response samples
- 200