Search
Close this search box.

Get PDF properties

Gets the information about a PDF file.

Input Parameters

Required Parameters

File Content:
Data Type = string (byte – base 64 string)
Content of the file to OCR

Optional Parameters

Page Limit:
Data Type = integer
Maximum number of pages to be processed

Output Parameters

Allow Assembly:
Data Type = boolean
PDF Security setting that specifies if the document allows the rotation, insertion or deletion of pages.

Allow Degraded Printing:
Data Type = boolean
PDF Security setting that specifies if the document allows low-quality printing.

Allow Extract Contents:
Data Type = boolean
PDF Security setting that specifies if the document allows extraction of text and graphics.

Allow Extract For Accessibility:
Data Type = boolean
PDF Security setting that specifies if the document allows extraction of text and graphics in support of accessibility.

Allow Fill In Form:
Data Type = boolean
PDF Security setting that specifies if the document allows the filling of form fields.

Allow Modify Annotations:
Data Type = boolean
PDF Security setting that specifies if the document allows the modification of annotations

Allow Modify Contents:
Data Type = boolean
PDF Security setting that specifies if the document allows the rotation, insertion or deletion of pages.

Allow Printing:
Data Type = boolean
PDF Security setting that specifies if the document allows the high-quality printing.

Author:
Data Type = string
Who created the document.

Creation Date:
Data Type = string
This is the date and time the PDF was created.

Creator:
Data Type = string
The originating application or library.

File Size (bytes):
Data Type = string
The size of the file in bytes.

Has Hidden Text:
Data Type = boolean
This will return true if the PDF file has an OCR layer.

Is Searchable:
Data Type = boolean
This will return true if the PDF file is searchable.

Keywords:
Data Type = string
Keywords can be comma separated.

Modified Date:
Data Type = string
This property represents the date and time the PDF was last modified.

Number of Pages:
Data Type = integer
The number of pages in the PDF file.

PDF Version:
Data Type = number
The version of the PDF specification the document was built against.

Producer:
Data Type = string
The product that created the PDF. In the early days of PDF people would use a Creator application like Microsoft Word to write a document, print it to a PostScript file and then the Producer would be Acrobat Distiller, the application that converted the PostScript file to a PDF. Nowadays Creator and Producer are often the same or one field is left blank.

Subject:
Data Type = string
What is the document about.

Title:
Data Type = string
The title of the document.

Trapped:
Data Type = string
This property is a Boolean value that indicates whether the document has been trapped. Trapping is a pre-press process which introduces color areas into color separations in order to obscure potential register errors.

Xmp Metadata:
Data Type = string (XML)
The Extensible Metadata Platform (XMP) is an ISO standard, originally created by Adobe Systems Inc., for the creation, processing and interchange of standardized and custom metadata for digital documents and data sets.

Error message:
Data Type = string
Error message

Is Successful:
Data Type = boolean
Whether the operation was successful or not.

License Info:
Data Type = string
Information about your API subscription key, it contains:

LicenseType
CallsRemaining
CallsMade
RenewalDate