PDF Info Reader#

Get detailed information about a PDF document, it’s properties and security permissions.

Note

For one-time check of PDF file information and find form fields please use PDF Edit Add Helper.

Available Methods#

/pdf/info#

Extracts basic information about an input PDF file, PDF file security permissions, and other information. If you want to extract information about fillable fields (checkboxes, radioboxes, listboxes) from PDF then please use /pdf/info/fields instead.

  • Method: POST

  • Endpoint: /v1/pdf/info

Attributes#

Note

Attributes are case-sensitive and should be inside JSON for POST request, for example:

{
    "url": "https://example.com/file1.pdf"
}

Attribute

Description

Required

url

URL to the source file. 1

yes

httpusername

HTTP auth user name if required to access source url.

no

httppassword

HTTP auth password if required to access source url.

no

password

Password of PDF file, the input must be in string format.

no

async

Set async to true for long processes to run in the background, API will then return a jobId which you can use with the Background Job Check endpoint to check the status of the process and retrieve the output while you can proceed with other tasks.

no

profiles

Use this parameter to set additional configurations for fine-tuning and extra options. Explore the Profiles section for more.

no

Query parameters#

No query parameters accepted.

Payload#

{
  "url": "https://pdfco-test-files.s3.us-west-2.amazonaws.com/pdf-info/sample.pdf",
  "async": false
}

Response 2#

{
  "info": {
      "PageCount": 1,
      "Author": "Alice V. Knox",
      "Title": "Kid's News 1",
      "Producer": "Acrobat Distiller 4.0 for Windows",
      "Subject": "Kid's News 1",
      "CreationDate": "8/15/2001 2:50:36 PM",
      "Bookmarks": "",
      "Keywords": "",
      "Creator": "Adobe PageMaker 6.52",
      "Encrypted": false,
      "PageRectangle": {
          "Location": {
              "IsEmpty": true,
              "X": 0,
              "Y": 0
          },
          "Size": "612, 792",
          "X": 0,
          "Y": 0,
          "Width": 612,
          "Height": 792,
          "Left": 0,
          "Top": 0,
          "Right": 612,
          "Bottom": 792,
          "IsEmpty": false
      },
      "ModificationDate": "9/20/2001 6:23:02 PM",
      "EncryptionAlgorithm": 0,
      "PermissionPrinting": true,
      "PermissionModifyDocument": true,
      "PermissionContentExtraction": true,
      "PermissionModifyAnnotations": true,
      "PermissionFillForms": true,
      "PermissionAccessibility": true,
      "PermissionAssemble": true,
      "PermissionHighQualityPrint": true
  },
  "error": false,
  "status": 200,
  "remainingCredits": 77732
}

CURL#

curl --location --request POST 'https://api.pdf.co/v1/pdf/info' \
--header 'x-api-key: ' \
--data-raw '{
    "url": "https://pdfco-test-files.s3.us-west-2.amazonaws.com/pdf-info/sample.pdf",
    "async": false
}'

Footnotes

1

Supports links from Google Drive, Dropbox, and PDF.co Built-In Files Storage. To upload files via the API check out the File Upload section. Note: If you experience intermittent Too Many Requests or Access Denied errors, please try to add cache: to enable built-in URL caching. (e.g cache:https://example.com/file1.pdf) For data security, you have the option to encrypt output files and decrypt input files. Learn more about user-controlled data encryption.

2

Main response codes as follows:

Code

Description

200

Success

400

Bad request. Typically happens because of bad input parameters, or because the input URLs can’t be reached, possibly due to access restrictions like needing a login or password.

401

Unauthorized

402

Not enough credits

445

Timeout error. To process large documents or files please use asynchronous mode (set the async parameter to true) and then check status using the /job/check endpoint. If a file contains many pages then specify a page range using the pages parameter. The number of pages of the document can be obtained using the /pdf/info endpoint.

Note

For more see the complete list of available response codes.