PDF.co Web API (Application Programming Interface)

Get Your Free API Key

Supported Formats

json

Supported Formats

json

Errors

Code Description
400 bad input parameters
401 unauthorized
403 not enough credits
405 Timeout error. To process large documents or files please use asynchronous mode ( set async parameter to true) and then check the status using /job/check endpoint. If file contains many pages then specify a page range using pages parameter. The number of pages of the document can be obtained using the endpoint /pdf/info

Params

Param name Description
encrypt
optional

Enable encryption for output file.

  • Must be one of: true, false.

file
optional

Source PDF file.

url
optional

URL of the source PDF file.

  • Must be a String

profiles
optional
  • Must be a String

lang
optional

Language of PDF file (eng, fra, spa, deu).

  • Must be a String

name
optional

File name for generated output.

  • Must be a String

async
optional

Runs processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)

  • Must be one of: true, false.

password
optional

Password of PDF file

  • Must be a String

rect
optional
  • Must be a String

pages
optional

Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: “0,2-5,7-”.

  • Must be a String

Supported Formats

json

Errors

Code Description
400 bad input parameters
401 unauthorized
403 not enough credits
405 Timeout error. To process large documents or files please use asynchronous mode ( set async parameter to true) and then check the status using /job/check endpoint. If file contains many pages then specify a page range using pages parameter. The number of pages of the document can be obtained using the endpoint /pdf/info

Params

Param name Description
width
optional

Width of the signature in PDF Points (1/72 in.).

  • Must be a Integer

height
optional

Height of the signature in PDF Points (1/72 in.).

  • Must be a Integer

y
optional

Y coordinate of the signature in PDF Points (1/72 in.).

  • Must be a Integer

x
optional

X coordinate of the signature in PDF Points (1/72 in.).

  • Must be a Integer

transparent
optional
  • Must be one of: true, false.

color
optional
  • Must be a String

urlimage
optional

URL of the signature image file.

  • Must be a String

encrypt
optional

Enable encryption for output file.

  • Must be one of: true, false.

file
optional

Source PDF file.

url
optional

URL of the source PDF file.

  • Must be a String

name
optional

File name for generated output.

  • Must be a String

async
optional

Runs processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)

  • Must be one of: true, false.

text
optional
  • Must be a String

type
optional
  • Must be a String

fontname
optional
  • Must be a String

pages
optional

Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: “0,2-5,7-”.

  • Must be a String

Supported Formats

json

Errors

Code Description
400 bad input parameters
401 unauthorized
403 not enough credits
405 Timeout error. To process large documents or files please use asynchronous mode ( set async parameter to true) and then check the status using /job/check endpoint. If file contains many pages then specify a page range using pages parameter. The number of pages of the document can be obtained using the endpoint /pdf/info

Params

Param name Description
encrypt
optional

Enable encryption for output file.

  • Must be one of: true, false.

file
optional

Source PDF file.

url
optional

URL of the source PDF file.

  • Must be a String

name
optional

File name for generated output.

  • Must be a String

async
optional

Runs processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)

  • Must be one of: true, false.

images
optional

Image signatures to add.

  • Must be an Array of nested elements

images[width]
optional

Width of the signature in PDF Points (1/72 in.).

  • Must be a Integer

images[height]
optional

Height of the signature in PDF Points (1/72 in.).

  • Must be a Integer

images[y]
optional

Y coordinate of the signature in PDF Points (1/72 in.).

  • Must be a Integer

images[x]
optional

X coordinate of the signature in PDF Points (1/72 in.).

  • Must be a Integer

images[pages]
optional

Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: “0,2-5,7-”.

  • Must be a String

annotations
optional

Annotation (textual) signatures to add.

  • Must be an Array of nested elements

annotations[text]
optional

Annotation text.

  • Must be a String

annotations[size]
optional

Font size.

  • Must be a Integer

annotations[color]
optional

Font color.

  • Must be a String

annotations[fontName]
optional

Font name.

  • Must be a String

annotations[transparent]
optional

Transparent of background.

  • Must be one of: true, false.

annotations[width]
optional

Width of the signature in PDF Points (1/72 in.).

  • Must be a Integer

annotations[height]
optional

Height of the signature in PDF Points (1/72 in.).

  • Must be a Integer

annotations[y]
optional

Y coordinate of the signature in PDF Points (1/72 in.).

  • Must be a Integer

annotations[x]
optional

X coordinate of the signature in PDF Points (1/72 in.).

  • Must be a Integer

annotations[pages]
optional

Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: “0,2-5,7-”.

  • Must be a String

certificate
optional
  • Must be a Hash

certificate[title]
optional
  • Must be a String

certificate[documentReference]
optional
  • Must be a String

certificate[parties]
optional
  • Must be an Array of nested elements

certificate[parties][partyId]
optional
  • Must be a String

certificate[parties][name]
optional
  • Must be a String

certificate[parties][emails]
optional
  • Must be a String

certificate[parties][ipAddress]
optional
  • Must be a String

certificate[parties][timestamp]
optional
  • Must be a Integer

certificate[parties][role]
optional
  • Must be a String

certificate[audit]
optional
  • Must be an Array of nested elements

certificate[audit][timestamp]
optional
  • Must be a Integer

certificate[audit][message]
optional
  • Must be a String

Supported Formats

json

Errors

Code Description
400 bad input parameters
401 unauthorized
403 not enough credits
405 Timeout error. To process large documents or files please use asynchronous mode ( set async parameter to true) and then check the status using /job/check endpoint. If file contains many pages then specify a page range using pages parameter. The number of pages of the document can be obtained using the endpoint /pdf/info

Params

Param name Description
width
optional

Width of the signature in PDF Points (1/72 in.).

  • Must be a String

height
optional

Height of the signature in PDF Points (1/72 in.).

  • Must be a String

y
optional

Y coordinate of the signature in PDF Points (1/72 in.).

  • Must be a String

x
optional

X coordinate of the signature in PDF Points (1/72 in.).

  • Must be a String

transparent
optional
  • Must be one of: true, false.

color
optional
  • Must be a String

urlimage
optional

URL of the signature image file.

  • Must be a String

encrypt
optional

Enable encryption for output file.

  • Must be one of: true, false.

file
optional

Source PDF file.

url
optional

URL of the source PDF file.

  • Must be a String

name
optional

File name for generated output.

  • Must be a String

async
optional

Runs processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)

  • Must be one of: true, false.

text
optional
  • Must be a String

type
optional
  • Must be a String

fontname
optional
  • Must be a String

pages
optional

Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: “0,2-5,7-”.

  • Must be a String