Decode barcodes from images or PDF documents quickly and accurately.
Name | Description | Required |
---|---|---|
PDF URL | Provide the URL to the source PDF document, or a filetoken:// link from PDF.co Built-In Files Storage. If you use another cloud service such as Google Drive or Dropbox ensure the link is publicly accessible. | Yes |
Barcode Type | Choose the type of barcode to read. By default, the system will look for QR Codes. | Yes |
Pages | Specify page indices as comma-separated values or ranges to process (e.g. “0, 1, 2- ” or “1, 2, 3-7 ”). The first-page index is 0 . Use ”! ” before a number for inverted page numbers (e.g. “!0 ” for the last page). If not specified, the default configuration processes all pages. The input must be in string format. | No |
File Name | File name for the generated output, the input must be in string format. | No |
Optical Marks Reader | Comma-separated list of additional marks to detect. The barcode reader engine can also find marks like Checkbox, UnderlinedField, etc. on scanned documents. | No |
Webhook URL | The callback URL or Webhook used to receive the output data. | No |
Output Links Expiration (In Minutes) | Set the expiration time for the output link in minutes. After this specified duration, any generated output file(s) will be automatically deleted from PDF.co Temporary Files Storage. The maximum duration for link expiration varies based on your current subscription plan. To store permanent input files (e.g. re-usable images, pdf templates, documents) consider using PDF.co Built-In Files Storage. | No |
HTTP Username | HTTP auth user name if required to access source URL. | No |
HTTP Password | HTTP auth password if required to access source URL. | No |
Custom Profiles | Use JSON to customize PDF processing with options like output resolution, OCR settings, text extraction methods, encryption, and image handling. Check our Custom Profile section to see all available parameters for your current endpoint. | No |
AES128
encryption. You can find the list of available parameters for customizing profiles in the PDF.co operation documentation below:
Parameter | Type | Default | Description |
---|---|---|---|
DataEncryptionAlgorithm | string | - | Controls the encryption algorithm used for data encryption. See User-Controlled Encryption for more information. The available algorithms are: AES128 , AES192 , AES256 . |
DataEncryptionKey | string | - | Controls the encryption key used for data encryption. See User-Controlled Encryption for more information. |
DataEncryptionIV | string | - | Controls the encryption IV used for data encryption. See User-Controlled Encryption for more information. |
DataDecryptionAlgorithm | string | - | Controls the decryption algorithm used for data decryption. See User-Controlled Encryption for more information. The available algorithms are: AES128 , AES192 , AES256 . |
DataDecryptionKey | string | - | Controls the decryption key used for data decryption. See User-Controlled Encryption for more information. |
DataDecryptionIV | string | - | Controls the decryption IV used for data decryption. See User-Controlled Encryption for more information. |
Name | Description |
---|---|
jobId | Unique identifier for the background job. |
pageCount | Number of pages in the PDF document. |
error | Indicates whether an error occurred (false means success) |
status | Status code of the request (200, 404, 500, etc.). For more information, see Response Codes. |
credits | Number of credits consumed by the request |
remainingCredits | Number of credits remaining in the account |
duration | Time taken for the operation in milliseconds |
url | Direct URL to the final PDF file stored in S3. |
name | Name of the output file |
outputLinkValidTill | Timestamp indicating when the output link will expire |