Split PDF by Barcode


The 'Split PDF by Barcode' flow action splits a PDF document into multiple separate PDF documents by barcodes and/or QR codes detected within the document.

Default Parameters

The default 'Split PDF by Barcode' flow action parameters are detailed below:

  • Filename: The filename of the source PDF document (including the file extension)
  • File Content: A Base64 encoded representation of the source PDF document
  • Barcode Value: Optional - Specify a value for detecting a specific barcode
  • Split Configuration: Select whether to split on the first instant, last instant or all instances pertaining to the results provided from the 'Split Value'.
  • Split Action: Select a split action, whether to split on, before, after or remove the page containing the split value.

    A single 5 page PDF document containing a barcode on page 3 will return the following file and page combination:
    • Remove: 1-2, 4-5
    • SplitOn: 1-2, 3-5
    • SplitAfter: 1-3, 4-5 
    • SplitBefore: 1, 2-5

Advanced Parameters

The default 'Split PDF by Barcode' flow action parameters are detailed below:

  • Confidence - Set the confidence level for barcode detection
  • Append Barcode Value - Sets whether the barcode value should be added to the filename

Credit Count

The 'Split PDF by Barcode' flow action utilises OCR to detect barcodes within the PDF file provided. This is a resource-intensive operation, therefore every 5 pages processed will consume 1 credit. For example, processing a 10-page document consumes 2 credits. 

Return Parameters

The 'Split PDF by Barcode' flow action returns the following data. 

Action Specific Return Values

  • Documents - The collection of PDF Documents created from the PDF document supplied.

Each document within the documents collection contains the following values:

  • Documents Filename - The filename of the file
  • Documents File Content - The file content of the file

Standard Return Values

  • OperationId - The unique ID assigned to this operation.
  • HttpStatusCode - The HTTP Status code for the response.
  • HttpStatusMessage - The HTTP Status message for the response.
  • Errors - An array of error messages should an error occur.
  • Operation Status - Indicates whether the operation has been completed, has been queued or has failed.


Have more questions? Submit a request


Please sign in to leave a comment.
Powered by Zendesk