Encodian

Enhanced document format conversion, OCR, watermarking, data extraction, redaction + much more. For Flow, Logic Apps and REST.

Contact

Name | Encodian Support URL | https://support.encodian.com Email | support@encodian.com This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure China regions
Power Automate Standard All Power Automate regions except the following:
     -   US Government (GCC High)
Power Apps Standard All Power Apps regions except the following:
     -   US Government (GCC High)

Creating a connection

To connect your account, you will need the following information:

Name Type Description
API Key securestring

Get an API Key - https://www.encodian.com/apikey/

Throttling Limits

Name Calls Renewal Period
API calls per connection10060 seconds

Actions

Add HTML Header or Footer

Add a HTML header, footer or both to the specified PDF document - https://support.encodian.com/hc/en-gb/articles/360013808614-Add-HTML-Header-or-Footer

Add Image Watermark

Add an image watermark to the specified PDF document using the standard options - https://support.encodian.com/hc/en-gb/articles/360012484094-Add-Image-Watermark

Add Image Watermark (Advanced)

Add an image watermark to the specified PDF document using the standard options - https://support.encodian.com/hc/en-gb/articles/360012485874-Add-Image-Watermark-Advanced-

Add Page Numbers

Add page numbers to the PDF document provided - https://support.encodian.com/hc/en-gb/articles/360014464534-Add-Page-Numbers

Add Text Watermark

Add a text watermark to the specified PDF document using the standard options - https://support.encodian.com/hc/en-gb/articles/360012230494-Add-Text-Watermark

Add Text Watermark (Advanced)

Add a text watermark to the specified PDF document using the advanced options - https://support.encodian.com/hc/en-gb/articles/360012345813-Add-Text-Watermark-Advanced-

Add to Archive (ZIP)

Add the files provided to an archive (.zip) file - https://support.encodian.com/hc/en-gb/articles/360002674918-Add-to-Archive-ZIP

Compress an Image

Compress the image provided - https://support.encodian.com/hc/en-gb/articles/360027350513-Compress-an-Image

Convert HTML to PDF

Convert the HTML or Web URL provided to a PDF document - https://support.encodian.com/hc/en-gb/articles/360022205154-Convert-HTML-to-PDF

Convert HTML to Word

Convert the HTML or Web URL provided to a Microsoft Word document - https://support.encodian.com/hc/en-gb/articles/360011823213-Convert-HTML-to-Word

Convert PDF to PDFA

Convert a PDF document to PDF/A format - https://support.encodian.com/hc/en-gb/articles/360010578413-Convert-PDF-to-PDFA

Convert PDF to Word

Convert a PDF document to Microsoft Word (docx) format - https://support.encodian.com/hc/en-gb/articles/360027229294-Convert-PDF-to-Word

Convert Text to PDF

Convert the text provided to a PDF document - https://support.encodian.com/hc/en-gb/articles/360011683054-Convert-Text-to-PDF

Convert to PDF

Convert a document to PDF or PDF/A format - https://support.encodian.com/hc/en-gb/articles/360011123574-Convert-to-PDF

Convert Word to PDF Form

Convert the Word document provided (Legacy Form Controls Only) to a PDF form document. - https://support.encodian.com/hc/en-gb/articles/360012307133-Convert-Word-to-PDF-Form

Extract Text from Regions

Extract text using OCR from 70+ files types using specified regions - https://support.encodian.com/hc/en-gb/articles/360015612353-Extract-Text-from-Regions

Get PDF Document Information

Get PDF Document Information (Number of Pages, File Size + more) - https://support.encodian.com/hc/en-gb/articles/360002949358-Get-PDF-Document-Information

Get PDF Form Data

Extract PDF form data from a PDF Form - https://support.encodian.com/hc/en-gb/articles/360035107433-Get-PDF-Form-Data

Get PDF Text Layer

Get the text layer for the PDF document provided - https://support.encodian.com/hc/en-gb/articles/360015539373-Get-PDF-Text-Layer

Image Clean Up (Document)

Execute image clean up activities focussed on text based images such as Deskew, Rotate, Despeckle + more.

Image Clean Up (Photo)

Execute image clean up activities for standard photo images.

Insert HTML to PDF

Insert the HTML provided into a PDF document - https://support.encodian.com/hc/en-gb/articles/360011784354-Insert-HTML-to-PDF

Merge document array to PDF

Convert and merge an array of documents to a single PDF document - https://support.encodian.com/hc/en-gb/articles/360014632213-Merge-document-array-to-PDF

Merge documents to PDF

Convert and merge the documents provided to a single PDF document - https://support.encodian.com/hc/en-gb/articles/360011886173-Merge-documents-to-PDF

Merge Word Documents

Merge an array of Microsoft Word documents to a single Microsoft Word document (DOCX) - https://support.encodian.com/hc/en-gb/articles/360023972213-Merge-document-array-to-Word

OCR a PDF Document

Perform OCR on an existing PDF document - https://support.encodian.com/hc/en-gb/articles/360012686653-OCR-a-PDF-Document

Redact PDF

Apply the specified redactions to the PDF document provided - https://support.encodian.com/hc/en-gb/articles/360018607954-Redact-PDF-

Replace Text with Image

Find and replace text contained within a PDF or DOCX document with an image - https://support.encodian.com/hc/en-gb/articles/360027234874

Resize an Image

Resize and compress the image provided - https://support.encodian.com/hc/en-gb/articles/360018591034-Resize-an-Image

Search and Replace Text

Find and replace text contained within a PDF or DOCX document - https://support.encodian.com/hc/en-gb/articles/360020937853-Search-and-Replace-Text

Secure PDF Document

Encrypt and protect a PDF document - https://support.encodian.com/hc/en-gb/articles/360011330134-Secure-PDF-Document

Set PDF Document Privileges

Set the privledges assigned to the PDF document - https://support.encodian.com/hc/en-gb/articles/360011337094-Set-PDF-Document-Privileges

Split PDF

Split a PDF Document into multiple PDF Documents - https://support.encodian.com/hc/en-gb/articles/360002953277-Split-PDF

Unlock PDF Document

Decrypt and remove password protection from a PDF document - https://support.encodian.com/hc/en-gb/articles/360003714237-Unlock-PDF-Document

Add a HTML header, footer or both to the specified PDF document - https://support.encodian.com/hc/en-gb/articles/360013808614-Add-HTML-Header-or-Footer

Parameters

Name Key Required Type Description
Filename
FileName True string

The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'

File Content
fileContent byte

The file content of the source PDF file

HTML Header / Footer
htmlHeaderFooter True string

The HTML to embed as a header or footer within the document

Location
htmlHeaderFooterLocation True string

Set whether the HTML should be added to the header, footer of both locations.

Skip First Page
skipFirstPage boolean

Set whether to ignore the first page when the header / footers are added.

Top Margin
marginTop double

Set the top margin value (mm).

Bottom Margin
marginBottom double

Set the bottom margin value (mm).

Right Margin
marginRight double

Set the right margin value (mm).

Left Margin
marginLeft double

Set the left margin value (mm).

Apply To
applyTo string

Set which pages within the PDF document to apply the HTML header or footer.

Page Numbers
Page Numbers integer

The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'

Ignore Page Numbers
Ignore Page Numbers integer

The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'

Operation ID
operationId string

Advanced - Set the identifier of a previous Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

Final Operation
finalOperation boolean

Advanced - Set as final Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

Returns

Add Image Watermark

Add an image watermark to the specified PDF document using the standard options - https://support.encodian.com/hc/en-gb/articles/360012484094-Add-Image-Watermark

Parameters

Name Key Required Type Description
Filename
FileName True string

The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'

File Content
fileContent byte

The file content of the source PDF file

Watermark Filename
watermarkFilename True string

The filename for the watermark image file, the file extension is mandatory: 'file.jpg' and not 'file'

Watermark File Content
watermarkFileContent True byte

The content of the watermark image file

Skip First Page
skipFirstPage boolean

Set whether to skip applying the watermark to the first page.

Orientation
Orientation string

The orientation of the image to embed as a watermark within the document

Opacity
Opacity float

The opacity of the text watermark, valid values range from 0.0+ to 1.0, the default value is 1.0

Operation ID
operationId string

Advanced - Set the identifier of a previous Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

Final Operation
FinalOperation boolean

Advanced - Set as final Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

Returns

Add Image Watermark (Advanced)

Add an image watermark to the specified PDF document using the standard options - https://support.encodian.com/hc/en-gb/articles/360012485874-Add-Image-Watermark-Advanced-

Parameters

Name Key Required Type Description
Filename
FileName True string

The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'

File Content
fileContent byte

The file content of the source PDF file

Watermark Filename
watermarkFilename True string

The filename for the watermark image file, the file extension is mandatory: 'file.jpg' and not 'file'

Watermark File Content
watermarkFileContent True byte

The content of the watermark image file

Skip First Page
skipFirstPage boolean

Set whether to skip applying the watermark to the first page.

Apply To
applyTo string

Set where in the document to apply the watermark.

Page Numbers
Page Numbers integer

The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'

Ignore Page Numbers
Ignore Page Numbers integer

The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'

Watermark Opacity
opacity float

The opacity of the text watermark, valid values range from 0.0+ to 1.0, the default value is 1.0

Rotation Angle
rotationAngle float

Set the rotation angle of the image watermark in degrees.

Quality
quality integer

Set the quality of the image watermark from 1 to 100.

X Offset
imageXOffset float

Set the X offset for positioning the watermark image on the page.

Y Offset
imageYOffSet float

Set the Y offset for positioning the watermark image on the page.

Scale
scale float

Set the multiple to either reduce (less than 1.0) or increase the size of the image (greater than 1.0), for example: 1.2 is equal to 120%, and 0.7 is equal to 70%.

Add to Background
addToBackground boolean

If set to 'true' the watermark image will be added to the background of the page.

Operation ID
operationId string

Advanced - Set the identifier of a previous Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

Final Operation
FinalOperation boolean

Advanced - Set as final Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

Returns

Add Page Numbers

Add page numbers to the PDF document provided - https://support.encodian.com/hc/en-gb/articles/360014464534-Add-Page-Numbers

Parameters

Name Key Required Type Description
Filename
FileName True string

The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'

File Content
fileContent byte

The file content of the source PDF file

Start Page
StartPage integer

Set which page to start adding page number(s) from.

Start Number
StartNumber integer

Set the starting number for the page number(s) added to the document.

Page Number Format
PageNumberFormat string

Set the format of the page number(s) added to the document, where [PageNumber] is replaced by the current page number and [TotalPages] is replaced by the total number of pages.

Horizontal Alignment
HorizontalAlignment string

Set the horizontal alignment of the page number(s) added to the document, the default value is Center.

Margin - Top
MarginTop double

Set the top margin value (pt). The default value is set to 20.

Margin - Right
MarginRight double

Set the right margin value(pt). The default value is set to 20.

Margin - Bottom
MarginBottom double

Set the bottom margin value (pt). The default value is set to 20.

Margin - Left
MarginLeft double

Set the left margin value (pt). The default value is set to 20.

Add to Background
AddToBackground boolean

Set whether the page number(s) should be added to top or bottom layer of the PDF document. The default setting (false) adds the page number(s) to the top layer.

Font
Font string

Specify the name of the font, if the font cannot be found the default 'Arial' will be used.

Font Colour
FontColour string

Set the HTML colour of the font, the default colour is set to #000000.

Font Size
FontSize integer

Set the size of the font, the default size is set to 14.

Opacity
Opacity float

Set the opacity of the page number(s), valid values range from 0.0+ to 1.0, the default value is 1.0

Operation ID
operationId string

Advanced - Set the identifier of a previous Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

Final Operation
FinalOperation boolean

Advanced - Set as final Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

Returns

Add Text Watermark

Add a text watermark to the specified PDF document using the standard options - https://support.encodian.com/hc/en-gb/articles/360012230494-Add-Text-Watermark

Parameters

Name Key Required Type Description
Filename
FileName True string

The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'

File Content
fileContent byte

The file content of the source PDF file

Text
Text True string

The text to embed as a watermark within the document

Skip First Page
skipFirstPage boolean

Set whether to skip applying the watermark to the first page.

Orientation
Orientation string

The orientation of the text to embed as a watermark within the document

Font
Font string

The font applied to the text watermark, the default font is set to Arial.

Text Colour
TextColour string

The HTML colour applied to the text watermark, the default colour is set to #E81123.

Text Size
TextSize integer

The size of the font applied to the text watermark, the default size is set to 34.

Opacity
Opacity float

The opacity of the text watermark, valid values range from 0.0+ to 1.0, the default value is 1.0

Operation ID
operationId string

Advanced - Set the identifier of a previous Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

Final Operation
FinalOperation boolean

Advanced - Set as final Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

Returns

Add Text Watermark (Advanced)

Add a text watermark to the specified PDF document using the advanced options - https://support.encodian.com/hc/en-gb/articles/360012345813-Add-Text-Watermark-Advanced-

Parameters

Name Key Required Type Description
Filename
FileName True string

The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'

File Content
fileContent byte

The file content of the source PDF file

Text
Text True string

The text to embed as a watermark within the document. Add carriage return control characters (backslash r) to manually split text onto new lines.

Skip First Page
skipFirstPage boolean

Set whether to skip applying the watermark to the first page.

Apply To
ApplyTo string

Set where in the document to apply the watermark.

Page Numbers
Page Numbers integer

The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'

Ignore Page Numbers
Ignore Page Numbers integer

The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'

Font
Font string

The font applied to the text watermark, the default font is set to Arial.

Text Colour
TextColour string

The HTML colour applied to the text watermark, the default colour is set to #E81123.

Text Size
TextSize integer

The size of the font applied to the text watermark, the default size is set to 34.

Opacity
Opacity float

The opacity of the text watermark, valid values range from 0.0+ to 1.0, the default value is 1.0

Encoding Type
EncodingType string

The encoding type to apply to the text watermark.

Horizontal Alignment
HorizontalAlignment string

Set the horizontal alignment of the watermark, the default value is Center.

Vertical Alignment
VerticalAlignment string

Set the vertical alignment of the watermark, the default value is Center.

Text Alignment
TextAlignment string

Set the text alignment of the watermark, the default value is Center.

Rotation Angle
RotationAngle float

Set the rotation angle of the text watermark.

Text Wrap
TextWrap boolean

Set whether the text watermark should automatically wrap.

Text Wrap Row Width
TextWrapRowWidth double

Set the row width applied when the watermark is set to automatically wrap.

Auto Scale
AutoScale boolean

Set the whether the text should be automatically sized to fit the width of the container.

Auto Scale Text Width
AutoScaleWidth double

Set the width of the watermark container when automatic scaling is enabled.

Auto Scale Text Height
AutoScaleHeight double

Set the height of the watermark container when automatic scaling is enabled.

Text Layer
TextLayer boolean

Set whether the watermark should be added to the top or bottom layer. If 'True' the watermark is added to the bottom layer.

Y Indent
YIndent double

Set the vertical watermark indent, starting from the bottom and overriding the VerticalAlignment property.

X Indent
XIndent double

Set the horizontal watermark indent, starting from the left and overriding the HorizontalAlignment property.

Apply as an Image
watermarkApplyAsImage boolean

Set whether the text watermark should be added as text or an image.

Operation ID
operationId string

Advanced - Set the identifier of a previous Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

Final Operation
FinalOperation boolean

Advanced - Set as final Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

Returns

Add to Archive (ZIP)

Add the files provided to an archive (.zip) file - https://support.encodian.com/hc/en-gb/articles/360002674918-Add-to-Archive-ZIP

Parameters

Name Key Required Type Description
Filename
outputFilename True string

The filename of the output ZIP package

Filename
fileName string

The filename of the file

File Content
fileContent byte

The file content of the file

Encoding
encoding string

Set the encoding type.

Returns

Compress an Image

Compress the image provided - https://support.encodian.com/hc/en-gb/articles/360027350513-Compress-an-Image

Parameters

Name Key Required Type Description
File Content
fileContent True byte

The file content of the source image file

Image Type
imageType True string

Select the image file format.

Returns

Convert HTML to PDF

Convert the HTML or Web URL provided to a PDF document - https://support.encodian.com/hc/en-gb/articles/360022205154-Convert-HTML-to-PDF

Parameters

Name Key Required Type Description
PDF Filename
outputFilename True string

The filename of the output PDF document

File Content
fileContent byte

Optional - The file content of the source HTML file.

HTML Data
htmlData string

Optional - The HTML which will be converted to a PDF document

HTML Url
htmlUrl string

Optional - The web address to the web page which will be converted to a PDF document

Page Orientation
pageOrientation string

Set page oprientation (Landscape or portrait).

Page Size
pageSize string

Set the page size for the output PDF document, A4 is the default size.

Viewport
viewPort string

Set the viewport used to render the HTML.

Top Margin
MarginTop double

Set the top margin value (mm)

Bottom Margin
MarginBottom double

Set the bottom margin value (mm)

Right Margin
MarginRight double

Set the right margin value (mm)

Left Margin
MarginLeft double

Set the left margin value (mm)

Enable Bookmarks
enableBookmarks boolean

Enable or disable auto creation of PDF bookmarks.

Enable JavaScript
enableJavaScript boolean

Enable or disable javascript.

Enable Hyperlinks
enableHyperlinks boolean

Enable or disable hyperlinks.

Create PDF Form
createPdfForm boolean

Set whether the HTML content should be converted to a PDF form.

Decode HTML Data
decodeHtmlData boolean

Set whether the data provided in the HTML Data field should be decoded.

CSS Type
cssType string

Set whether the standard or print style sheets should be used for HTML conversion.

Repeat Table Header
repeatTableHeader boolean

Set whether to repeat the table header on every page break. The default value is true

Repeat Table Footer
repeatTableFooter boolean

Set whether to repeat the table footer on every page break. The default value is true

Split Images
splitImages boolean

Set whether to split images

Split Text Lines
splitTextLines boolean

Set whether to split text lines

Encoding
encoding string

Set the encoding type for the HTML.

Final Operation
FinalOperation boolean

Advanced - Set as final Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

Returns

Convert HTML to Word

Convert the HTML or Web URL provided to a Microsoft Word document - https://support.encodian.com/hc/en-gb/articles/360011823213-Convert-HTML-to-Word

Parameters

Name Key Required Type Description
Filename
outputFilename True string

The filename of the output DOCX document

File Content
fileContent byte

Optional - The file content of the source HTML file.

HTML Data
htmlData string

Optional - The HTML which will be converted to a Word document

HTML Url
htmlUrl string

Optional - The web address to the web page which will be converted to a Word document

Page Orientation
pageOrientation string

Set page oprientation (Landscape or portrait).

Page Size
pageSize string

Set the page size for the output Word document, A4 is the default size.

Decode HTML Data
decodeHtmlData boolean

Set whether the data provided in the HTML Data field should be decoded.

Encoding
encoding string

Set the encoding type for the HTML.

Top Margin
MarginTop double

Set the top margin value (pt. The default value is set to -1, whereby a minus value does not change the existing page margin value.

Bottom Margin
MarginBottom double

Set the bottom margin value (pt. The default value is set to -1, whereby a minus value does not change the existing page margin value.

Right Margin
MarginRight double

Set the right margin value (pt. The default value is set to -1, whereby a minus value does not change the existing page margin value.

Left Margin
MarginLeft double

Set the left margin value (pt. The default value is set to -1, whereby a minus value does not change the existing page margin value.

Returns

Convert PDF to PDFA

Convert a PDF document to PDF/A format - https://support.encodian.com/hc/en-gb/articles/360010578413-Convert-PDF-to-PDFA

Parameters

Name Key Required Type Description
Filename
FileName True string

The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'

File Content
fileContent byte

The file content of the source PDF file

PDF/A Compliance Level
pdfaComplianceLevel string

Set the PDF/A Compliance Level, the default value is PDF_A_2A.

Operation ID
operationId string

Advanced - Set the identifier of a previous Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

Final Operation
FinalOperation boolean

Advanced - Set as final Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

Returns

Convert PDF to Word

Convert a PDF document to Microsoft Word (docx) format - https://support.encodian.com/hc/en-gb/articles/360027229294-Convert-PDF-to-Word

Parameters

Name Key Required Type Description
Filename
outputFilename True string

The filename of the output DOCX document

File Content
fileContent byte

The file content of the source PDF file.

Conversion Mode
mode string
Recognize Bullets
recognizeBullets boolean

Returns

Convert Text to PDF

Convert the text provided to a PDF document - https://support.encodian.com/hc/en-gb/articles/360011683054-Convert-Text-to-PDF

Parameters

Name Key Required Type Description
PDF Filename
outputFilename True string

The filename of the output PDF document

File Content
fileContent byte

Optional - Please provide either The file content of the source file and source filename or text data.

Text Data
textData string

Optional - Please provide either the text data which will be converted to a PDF document or The file content of the source file and source filename.

Encoding Type
textEncodingType string

The encoding type used for text conversion.

Final Operation
FinalOperation boolean

Advanced - Set as final Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

Returns

Convert to PDF

Convert a document to PDF or PDF/A format - https://support.encodian.com/hc/en-gb/articles/360011123574-Convert-to-PDF

Parameters

Name Key Required Type Description
Filename
FileName True string

The filename of the source file, the file extension is mandatory: 'file.xlsx' and not 'file'

File Content
fileContent True byte

The file content of the source file

PDF Filename
outputFilename True string

The filename of the output PDF document

Remove Markup
removeDocumentMarkup boolean

Set MS Office document comments and tracked changes removal option

PDF/A Compliant
pdfaCompliance boolean

Set PDF/A Compliance option

PDF/A Compliance Level
pdfaComplianceLevel string

Set the PDF/A Compliance Level, the default value is PDF_A_2A.

Generate Bookmarks
GenerateBookmarks boolean

Set whether bookmarks should be automatically created for Microsoft Word documents which are converted to PDF.

Culture Name
CultureName string

This setting only applies to Microsoft Excel documents and is used to set the culture for the workbook prior to conversion.

Final Operation
FinalOperation boolean

Advanced - Set as final Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

Returns

Convert Word to PDF Form

Convert the Word document provided (Legacy Form Controls Only) to a PDF form document. - https://support.encodian.com/hc/en-gb/articles/360012307133-Convert-Word-to-PDF-Form

Parameters

Name Key Required Type Description
Filename
FileName True string

The filename of the source Microsoft Word file, the file extension is mandatory: 'file.doc' and not 'file'

File Content
fileContent True byte

The file content of the source Microsoft Word file

PDF Filename
outputFilename True string

The filename of the output PDF document

Final Operation
FinalOperation boolean

Advanced - Set as final Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

Returns

Extract Text from Regions

Extract text using OCR from 70+ files types using specified regions - https://support.encodian.com/hc/en-gb/articles/360015612353-Extract-Text-from-Regions

Parameters

Name Key Required Type Description
Filename
FileName True string

The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'

File Content
FileContent byte

The file content of the source PDF file

Name
Name True string

The name assigned to the text region

Lower Left X Coordinate
LowerLeftXCoordinate True double

The number of points from the left edge of the page to the lower left corner of the rectangle text region

Lower Left Y Coordinate
LowerLeftYCoordinate True double

The number of points from the bottom edge of the page to the lower left corner of the rectangle text region

Upper Right X Coordinate
UpperRightXCoordinate True double

The number of points from the left edge of the page to the upper right corner of the rectangle text region

Upper Right Y Coordinate
UpperRightYCoordinate True double

The number of points from the bottom edge of the page to the upper right corner of the rectangle text region

Page Number
Page Number True integer

The number of the page to extract text from

Operation ID
operationId string

Advanced - Set the identifier of a previous Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

Final Operation
FinalOperation boolean

Advanced - Set as final Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

Returns

Get PDF Document Information

Get PDF Document Information (Number of Pages, File Size + more) - https://support.encodian.com/hc/en-gb/articles/360002949358-Get-PDF-Document-Information

Parameters

Name Key Required Type Description
Filename
FileName True string

The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'

File Content
fileContent True byte

The file content of the source PDF file

Operation ID
operationId string

Advanced - Set the identifier of a previous Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

Returns

Get PDF Form Data

Extract PDF form data from a PDF Form - https://support.encodian.com/hc/en-gb/articles/360035107433-Get-PDF-Form-Data

Parameters

Name Key Required Type Description
File Content
FileContent byte

The file content of the source PDF file

Operation ID
OperationId string

Advanced - Set the identifier of a previous Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

Returns

Get PDF Text Layer

Get the text layer for the PDF document provided - https://support.encodian.com/hc/en-gb/articles/360015539373-Get-PDF-Text-Layer

Parameters

Name Key Required Type Description
Filename
FileName True string

The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'

File Content
FileContent byte

The file content of the source PDF file

Start Page
StartPage integer

Sets the page number to begin text layer extraction from.

End Page
EndPage integer

Sets the page number to end text layer extraction from. The default value is set to the last page of the PDF document provided.

Encoding Type
TextEncodingType string

The encoding type used for text extraction.

Operation ID
operationId string

Advanced - Set the identifier of a previous Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

Final Operation
FinalOperation boolean

Advanced - Set as final Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

Returns

Image Clean Up (Document)

Execute image clean up activities focussed on text based images such as Deskew, Rotate, Despeckle + more.

Parameters

Name Key Required Type Description
Filename
FileName True string

The filename of the source image file, the file extension is mandatory: 'file.png' and not 'file'

File Content
FileContent byte

The file content of the source image file

Clean Operations
cleanUpType string

Perform file clean-up operations, the default option will auto rotate, auto deskew and auto despeckle the provided file.

Rotate
AutoRotate boolean

Automatically detects orientation and rotates so that the text is upright oriented, this is enabled by default.

Rotate Confidence Level
AutoRotateConfidenceLevel integer

Sets the minimum confidence percentage (0 to 100) used to control whether the rotation is applied, the default value is 60.

Deskew
Deskew boolean

Detects the skew angle and rotates to remove that skew, this is enabled by default.

Despeckle
Despeckle boolean

Automatically detects speckles and removes them, this is enabled by default.

Adjust Brightness and Contrast
AdjustBrightnessContrast boolean

This action analyzes a document and automatically adjusts brightness and contrast based on the analysis, this is disabled by default.

Remove Border
RemoveBorder boolean

Locates border pixels and removes the pixels from the document, this is disabled by default.

Smooth Background
SmoothBackground boolean

This works only on color and grayscale documents. This operation smoothes background colors to eliminate or de-emphasize noise, this is disabled by default.

Smooth Objects
SmoothObjects boolean

This only works on bitonal documents, it looks at groups of pixels, and finds isolated bumps and pits in the edges of those objects, and fills them in, this is disabled by default.

Remove Dot Shading
RemoveDotShading boolean

This action will remove shaded regions from bitonal documents, this is disabled by default.

Image Detergent
ImageDetergent boolean

Image Detergent works by changing pixels of similar color values to a central color value, which has the result of smoothing the image wherever regions of those colors appear, this is disabled by default.

Average Filter
ApplyAverageFilter boolean

Performs a 3x3 Average filter smoothing operation on the document, placing the output in the center of the window, this is disabled by default.

Remove Hole Punch
RemoveHolePunch boolean

Detects and removes hole punch marks from a bitonal document, this is disabled by default.

Binarize
Binarize boolean

Computes all necessary parameters by analyzing the input data before actually performing the binarization. The algorithm is tuned to typical document images, consisting of dark text on brighter background. It is robust to shadows, noise and background images, this is disabled by default.

Returns

Image Clean Up (Photo)

Execute image clean up activities for standard photo images.

Parameters

Name Key Required Type Description
Filename
FileName True string

The filename of the source image file, the file extension is mandatory: 'file.png' and not 'file'

File Content
FileContent byte

The file content of the source image file

Clean Operations
cleanUpType string

Perform file clean-up operations, the default option will auto rotate, apply colour balance, auto deskew and auto despeckle the provided file.

Deskew
Deskew boolean

Detects the skew angle and rotates to remove that skew, this is enabled by default.

Despeckle
Despeckle boolean

Automatically detects speckles and removes them, this is enabled by default.

Color Balance
ColorBalance boolean

Restores and balances the color quality within an image, this is enabled by default.

Remove Border
RemoveBorder boolean

Locates border pixels and removes the pixels from the document, this is disabled by default.

Contrast
Contrast boolean

Adjusts the contrast in the current image.

Remove Redeye
RemoveRedeye boolean

Automatically reduces the red reflection of the flash seen in the eyes of people in color flash photo images.

Blur
Blur boolean

Blurs the current image by averaging each pixel with each of its neighboring pixels giving it an 'out of focus' appearance.

Diffuse
Diffuse boolean

Diffuses the current image by replacing each pixel with a randomly selected neighboring pixel.

Binarize
Binarize boolean

Computes all necessary parameters by analyzing the input data before actually performing the binarization. The algorithm is tuned to typical document images, consisting of dark text on brighter background. It is robust to shadows, noise and background images, this is disabled by default.

Rotate
AutoRotate boolean

Automatically detects orientation and rotates so that the text is upright oriented, this is enabled by default.

Rotate Confidence Level
AutoRotateConfidenceLevel integer

Sets the minimum confidence percentage (0 to 100) used to control whether the rotation is applied, the default value is 40.

Returns

Insert HTML to PDF

Insert the HTML provided into a PDF document - https://support.encodian.com/hc/en-gb/articles/360011784354-Insert-HTML-to-PDF

Parameters

Name Key Required Type Description
Filename
FileName True string

The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'

File Content
fileContent byte

The file content of the source PDF file

HTML Data
htmlData True string

The HTML which will be inserted into the PDF document

HTML Insert Location
htmlInsertLocation string

Set where within the PDF provided, the HTML data should be inserted, the default value is Prepend.

Page Number
htmlInsertLocationPage integer

Set a specific page location to insert the HTML data into.

Page Orientation
pageOrientation string

Set page oprientation (Landscape or portrait).

Page Size
pageSize string

Set the page size for the output PDF document, A4 is the default size.

Viewport
viewPort string

Set the viewport used to render the HTML.

Top Margin
MarginTop double

Set the top margin value (mm)

Bottom Margin
MarginBottom double

Set the bottom margin value (mm)

Right Margin
MarginRight double

Set the right margin value (mm)

Left Margin
MarginLeft double

Set the left margin value (mm)

Decode HTML Data
decodeHtmlData boolean

Set whether the data provided in the HTML Data field should be decoded.

Operation ID
operationId string

Advanced - Set the identifier of a previous Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

Returns

Merge document array to PDF

Convert and merge an array of documents to a single PDF document - https://support.encodian.com/hc/en-gb/articles/360014632213-Merge-document-array-to-PDF

Parameters

Name Key Required Type Description
PDF Filename
outputFilename True string

The filename of the output PDF document

Filename
fileName string

The filename of the file

File Content
fileContent byte

The file content of the file

Remove Markup
removeDocumentMarkup boolean

Set MS Office document comments and tracked changes removal option

PDF/A Compliant
pdfaCompliance boolean

Set PDF/A Compliance option

PDF/A Compliance Level
pdfaComplianceLevel string

Set the PDF/A Compliance Level, the default value is PDF_A_2A.

Final Operation
FinalOperation boolean

Advanced - Set as final Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

Returns

Merge documents to PDF

Convert and merge the documents provided to a single PDF document - https://support.encodian.com/hc/en-gb/articles/360011886173-Merge-documents-to-PDF

Parameters

Name Key Required Type Description
PDF Filename
outputFilename True string

The filename of the output PDF document

Filename
FileName True string

The filename of the 1st source file, the file extension is mandatory: 'file.xlsx' and not 'file'

File Content
fileContent True byte

The file content of the source file

Filename 2
fileName2 True string

The filename of the 2nd source file, the file extension is mandatory: 'file.xlsx' and not 'file'

File Content 2
fileContent2 True byte

The file content of the 2nd source file

Filename 3
fileName3 string

The filename of the 3rd source file, the file extension is mandatory: 'file.xlsx' and not 'file'

File Content 3
fileContent3 byte

The file content of the 3rd source file

Filename 4
fileName4 string

The filename of the 4th source file, the file extension is mandatory: 'file.xlsx' and not 'file'

File Content 4
fileContent4 byte

The file content of the 4th source file

Filename 5
fileName5 string

The filename of the 5th source file, the file extension is mandatory: 'file.xlsx' and not 'file'

File Content 5
fileContent5 byte

The file content of the 5th source file

Filename 6
fileName6 string

The filename of the 6th source file, the file extension is mandatory: 'file.xlsx' and not 'file'

File Content 6
fileContent6 byte

The file content of the 6th source file

Filename 7
fileName7 string

The filename of the 7th source file, the file extension is mandatory: 'file.xlsx' and not 'file'

File Content 7
fileContent7 byte

The file content of the 7th source file

Filename 8
fileName8 string

The filename of the 8th source file, the file extension is mandatory: 'file.xlsx' and not 'file'

File Content 8
fileContent8 byte

The file content of the 8th source file

Filename 9
fileName9 string

The filename of the 9th source file, the file extension is mandatory: 'file.xlsx' and not 'file'

File Content 9
fileContent9 byte

The file content of the 9th source file

Filename 10
fileName10 string

The filename of the 10th source file, the file extension is mandatory: 'file.xlsx' and not 'file'

File Content 10
fileContent10 byte

The file content of the 10th source file

Remove Markup
removeDocumentMarkup boolean

Set MS Office document comments and tracked changes removal option

PDF/A Compliant
pdfaCompliance boolean

Set PDF/A Compliance option

PDF/A Compliance Level
pdfaComplianceLevel string

Set the PDF/A Compliance Level, the default value is PDF_A_2A.

Final Operation
FinalOperation boolean

Advanced - Set as final Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

Returns

Merge Word Documents

Merge an array of Microsoft Word documents to a single Microsoft Word document (DOCX) - https://support.encodian.com/hc/en-gb/articles/360023972213-Merge-document-array-to-Word

Parameters

Name Key Required Type Description
Filename
outputFilename True string

The filename of the output DOCX document

Filename
fileName True string

The filename of the source file, the file extension is mandatory: 'file.docx' and not 'file'

File Content
fileContent True byte

The file content of the source file

Sort Position
sortPosition integer

Set the sort position within the document array

Format Mode
wordInputFormatMode string

Set how formatting is handled when documents are merged into the first document in the array.

Returns

OCR a PDF Document

Perform OCR on an existing PDF document - https://support.encodian.com/hc/en-gb/articles/360012686653-OCR-a-PDF-Document

Parameters

Name Key Required Type Description
Filename
FileName True string

The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'

File Content
FileContent byte

The file content of the source PDF file

Language
ocrLanguage string

Select the language used for OCR processing

OCR Type
ocrType string

Select the OCR processing type, the 'Fast' option reduces processing time with possible minor loss of OCR accuracy - https://support.encodian.com/hc/en-gb/articles/360012686653-OCR-a-PDF-Document

PDF/A Compliant
pdfaCompliance boolean

Set PDF/A Compliance option

PDF/A Compliance Level
pdfaComplianceLevel string

Set the PDF/A Compliance Level, the default value is PDF_A_2A.

Clean Operations
cleanUpType string

Perform document clean-up operations, the default option will auto rotate, auto deskew and auto despeckle the document.

Rotate
AutoRotate boolean

Automatically detects orientation and rotates it so that the text on it is upright oriented

Rotate Confidence Level
AutoRotateConfidenceLevel integer

Sets the minimum confidence percentage (0 to 100) used to control whether the rotation is applied, the default value is 60.

Deskew
Deskew boolean

Detects the skew angle and rotates to remove that skew.

Despeckle
Despeckle boolean

Automatically detects speckles and removes them.

Adjust Brightness and Contrast
AdjustBrightnessContrast boolean

This action analyzes a document and automatically adjusts brightness and contrast based on the analysis.

Remove Border
RemoveBorder boolean

Locates border pixels and removes the pixels from the document,this is disabled by default.

Smooth Background
SmoothBackground boolean

This works only on color and grayscale documents. This operation smoothes background colors to eliminate or de-emphasize noise.

Smooth Objects
SmoothObjects boolean

This only works on bitonal documents, it looks at groups of pixels, and finds isolated bumps and pits in the edges of those objects, and fills them in.

Remove Dot Shading
RemoveDotShading boolean

This action will remove shaded regions from bitonal documents.

Image Detergent
ImageDetergent boolean

Image Detergent works by changing pixels of similar color values to a central color value, which has the result of smoothing the image wherever regions of those colors appear.

Average Filter
ApplyAverageFilter boolean

Performs a 3x3 Average filter smoothing operation on the document, placing the output in the center of the window.

Remove Hole Punch
RemoveHolePunch boolean

Detects and removes hole punch marks from a bitonal document.

Binarize
Binarize boolean

Computes all necessary parameters by analyzing the input data before actually performing the binarization. The algorithm is tuned to typical document images, consisting of dark text on brighter background. It is robust to shadows, noise and background images.

Remove Blank Pages
RemoveBlankPages boolean

Set whether blank pages should be removed from the PDF document.

Advanced - Operation ID
operationId string

Advanced - Set the identifier of a previous Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

Advanced - Final Operation
FinalOperation boolean

Advanced - Set as final Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

Returns

Redact PDF

Apply the specified redactions to the PDF document provided - https://support.encodian.com/hc/en-gb/articles/360018607954-Redact-PDF-

Parameters

Name Key Required Type Description
Filename
FileName True string

The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'

File Content
fileContent byte

The file content of the source PDF file

Text
SearchText string

The text to search for and apply the specified redaction to.

Expression
SearchExpression string

Specify a regular expression to seek matching text and apply the specified redaction to.

Redaction Colour
RedactionColour string

The redaction colour to apply to the redaction, the default value is #000000 (Black)

Operation ID
operationId string

Advanced - Set the identifier of a previous Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

Final Operation
FinalOperation boolean

Advanced - Set as final Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

Returns

Replace Text with Image

Find and replace text contained within a PDF or DOCX document with an image - https://support.encodian.com/hc/en-gb/articles/360027234874

Parameters

Name Key Required Type Description
File Type
fileType string

Select the source document format.

Filename
FileName string

The filename of the source file, the file extension is mandatory: 'file.pdf' and not 'file'

File Content
FileContent byte

The file content of the source file

Search Text
SearchText True string

The text to locate and replace with the specified image

Image Filename
imageFilename True string

The filename for the image file, the file extension is mandatory: 'file.jpg' and not 'file'

Image File Content
imageFileContent True byte

The content of the image file

Skip First Page
skipFirstPage boolean

Set whether to ignore the first page when searching for the text fragment.

Apply To
applyTo string

Set which pages within the document to search for the text fragment

Page Numbers
Page Numbers integer

Select the source document format.

Ignore Page Numbers
Ignore Page Numbers integer

Select the source document format.

Operation ID
operationId string

Advanced - Set the identifier of a previous Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

Final Operation
FinalOperation boolean

Advanced - Set as final Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

Returns

Resize an Image

Resize and compress the image provided - https://support.encodian.com/hc/en-gb/articles/360018591034-Resize-an-Image

Parameters

Name Key Required Type Description
Filename
FileName True string

The filename of the source image file, the file extension is mandatory: 'file.png' and not 'file'

File Content
FileContent True byte

The file content of the source image file

Resize Type
ImageResizeType True string

Set whether the image should be resized to a ratio or specific dimensions.

Resize Percentage
ResizePercentage integer

For percentage resize actions - Set the percentage the image should be decrased or increased in size by.

Image Width
ImageWidth integer

For specific resize actions - Set the specific width of the image in pixels

Image Height
ImageHeight integer

For specific resize actions - Set the specific height of the image in pixels

Maintain Aspect Ratio
MaintainAspectRatio boolean

For specific resize actions - If true, the image height will be automatically set relevant to the image width provided.

Returns

Search and Replace Text

Find and replace text contained within a PDF or DOCX document - https://support.encodian.com/hc/en-gb/articles/360020937853-Search-and-Replace-Text

Parameters

Name Key Required Type Description
File Type
fileType string

Select the source document format.

Filename
FileName string

The filename of the source file, the file extension is mandatory: 'file.pdf' and not 'file'

File Content
FileContent byte

The file content of the source file

Search Text
SearchText True string

Optional - The text to locate and replace with the 'Replacement Text' value

Is Expression
IsExpression boolean

Set whether the 'Search Text' value should be evaluted as a regular expression, the default value is 'false'

Replacement Text
ReplacementText True string

The text to replace the 'Search Text' text with

Font
Font True string

The name of the font to use for the 'Replacement Text', the default font is 'Arial'

Font Size
FontSize True integer

The size of the font to use for the 'Replacement Text', the default size is '16'

Font Colour
FontColour True string

The HTML colour of the font to use for the 'Replacement Text', the default colour is '#000000'

Background Colour
BackgroundColour True string

The background HTML colour to use for the 'Replacement Text', the default colour is '#FFFFFF'

Underline
Underline boolean

Set whether the 'Replacement Text' should be underlined, the default value is 'false'

Word Spacing
WordSpacing float

The word spacing to apply to the 'Replacement Text'

Line Spacing
LineSpacing float

The line spacing to apply to the 'Replacement Text'

Operation ID
operationId string

Advanced - Set the identifier of a previous Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

Final Operation
FinalOperation boolean

Advanced - Set as final Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

Returns

Secure PDF Document

Encrypt and protect a PDF document - https://support.encodian.com/hc/en-gb/articles/360011330134-Secure-PDF-Document

Parameters

Name Key Required Type Description
Filename
FileName True string

The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'

File Content
fileContent byte

The file content of the source PDF file

User Password
userPassword True string

Set the user password

Admin Password
adminPassword True string

Set the administrator password

Privileges
pdfPrivileges string

Set the privileges assigned to the PDF document

Cryptographic Algorithm
cryptoAlgorithm string

Set the cryptographic algorithm

Privilege - Assembly
pdfPrivilegesAllowAssembly boolean
Privilege - Copy
pdfPrivilegesAllowCopy boolean
Privilege - Fill in Forms
pdfPrivilegesAllowFillIn boolean
Privilege - Print
pdfPrivilegesAllowPrint boolean
Privilege - Screen Readers
pdfPrivilegesAllowScreenReaders boolean
Privilege - Modify Contents
pdfPrivilegesAllowModifyContents boolean
Privilege - Modify Annotations
pdfPrivilegesAllowModifyAnnotations boolean
Operation ID
operationId string

Advanced - Set the identifier of a previous Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

Returns

Set PDF Document Privileges

Set the privledges assigned to the PDF document - https://support.encodian.com/hc/en-gb/articles/360011337094-Set-PDF-Document-Privileges

Parameters

Name Key Required Type Description
Filename
FileName True string

The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'

File Content
fileContent byte

The file content of the source PDF file

Privileges
pdfPrivileges string

Set the privileges assigned to the PDF document

Privilege - Assembly
pdfPrivilegesAllowAssembly boolean
Privilege - Copy
pdfPrivilegesAllowCopy boolean
Privilege - Fill in Forms
pdfPrivilegesAllowFillIn boolean
Privilege - Print
pdfPrivilegesAllowPrint boolean
Privilege - Screen Readers
pdfPrivilegesAllowScreenReaders boolean
Privilege - Modify Contents
pdfPrivilegesAllowModifyContents boolean
Privilege - Modify Annotations
pdfPrivilegesAllowModifyAnnotations boolean
Operation ID
operationId string

Advanced - Set the identifier of a previous Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

Final Operation
FinalOperation boolean

Advanced - Set as final Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

Returns

Split PDF

Split a PDF Document into multiple PDF Documents - https://support.encodian.com/hc/en-gb/articles/360002953277-Split-PDF

Parameters

Name Key Required Type Description
Filename
fileName True string

The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'

File Content
fileContent byte

The file content of the PDF file

Split by Type
splitByType True string

Select how to split the file

Split Configuration
splitConfiguration True string

Provide a split configuration

Operation ID
operationId string

Advanced - Set the identifier of a previous Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

Returns

Unlock PDF Document

Decrypt and remove password protection from a PDF document - https://support.encodian.com/hc/en-gb/articles/360003714237-Unlock-PDF-Document

Parameters

Name Key Required Type Description
Filename
FileName True string

The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'

File Content
fileContent byte

The file content of the source PDF file

Password
password True string

The password to use to unlock the PDF Document

Operation ID
operationId string

Advanced - Set the identifier of a previous Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

Returns

Definitions

DtoResponseBasicConversion

Name Path Type Description
HTTP Status Code
HttpStatusCode integer

The HTTP Status code for the response.

HTTP Status Message
HttpStatusMessage string

The HTTP Status message for the response.

Operation ID
OperationId string

The unique ID assigned to this operation.

Errors
Errors array of string

An array of error messages should an error occur.

Operation Status
Operation Status string

Indicates whether the operation has completed, has been queued or has failed.

Filename
Filename string

The filename of the document.

File Content
FileContent byte

The processed document.

DtoResponseConvertToPdfA

Name Path Type Description
HTTP Status Code
HttpStatusCode integer

The HTTP Status code for the response.

HTTP Status Message
HttpStatusMessage string

The HTTP Status message for the response.

Operation ID
OperationId string

The unique ID assigned to this operation.

Errors
Errors array of string

An array of error messages should an error occur.

Operation Status
Operation Status string

Indicates whether the operation has completed, has been queued or has failed.

Filename
Filename string

The filename of the document.

File Content
FileContent byte

The processed document.

DtoResponseSecurePdf

Name Path Type Description
HTTP Status Code
HttpStatusCode integer

The HTTP Status code for the response.

HTTP Status Message
HttpStatusMessage string

The HTTP Status message for the response.

Operation ID
OperationId string

The unique ID assigned to this operation.

Errors
Errors array of string

An array of error messages should an error occur.

Operation Status
Operation Status string

Indicates whether the operation has completed, has been queued or has failed.

Filename
Filename string

The filename of the document.

File Content
FileContent byte

The processed document.

DtoResponseTextToPdf

Name Path Type Description
HTTP Status Code
HttpStatusCode integer

The HTTP Status code for the response.

HTTP Status Message
HttpStatusMessage string

The HTTP Status message for the response.

Operation ID
OperationId string

The unique ID assigned to this operation.

Errors
Errors array of string

An array of error messages should an error occur.

Operation Status
Operation Status string

Indicates whether the operation has completed, has been queued or has failed.

Filename
Filename string

The filename of the document.

File Content
FileContent byte

The processed document.

DtoResponseHtmlToPdf

Name Path Type Description
HTTP Status Code
HttpStatusCode integer

The HTTP Status code for the response.

HTTP Status Message
HttpStatusMessage string

The HTTP Status message for the response.

Operation ID
OperationId string

The unique ID assigned to this operation.

Errors
Errors array of string

An array of error messages should an error occur.

Operation Status
Operation Status string

Indicates whether the operation has completed, has been queued or has failed.

Filename
Filename string

The filename of the document.

File Content
FileContent byte

The processed document.

DtoResponseHtmlToWord

Name Path Type Description
HTTP Status Code
HttpStatusCode integer

The HTTP Status code for the response.

HTTP Status Message
HttpStatusMessage string

The HTTP Status message for the response.

Operation ID
OperationId string

The unique ID assigned to this operation.

Errors
Errors array of string

An array of error messages should an error occur.

Operation Status
Operation Status string

Indicates whether the operation has completed, has been queued or has failed.

Filename
Filename string

The filename of the document.

File Content
FileContent byte

The processed document.

DtoResponseInsertHtmlToPdf

Name Path Type Description
HTTP Status Code
HttpStatusCode integer

The HTTP Status code for the response.

HTTP Status Message
HttpStatusMessage string

The HTTP Status message for the response.

Operation ID
OperationId string

The unique ID assigned to this operation.

Errors
Errors array of string

An array of error messages should an error occur.

Operation Status
Operation Status string

Indicates whether the operation has completed, has been queued or has failed.

Filename
Filename string

The filename of the document.

File Content
FileContent byte

The processed document.

DtoResponseMergeDocumentsToPdf

Name Path Type Description
HTTP Status Code
HttpStatusCode integer

The HTTP Status code for the response.

HTTP Status Message
HttpStatusMessage string

The HTTP Status message for the response.

Operation ID
OperationId string

The unique ID assigned to this operation.

Errors
Errors array of string

An array of error messages should an error occur.

Operation Status
Operation Status string

Indicates whether the operation has completed, has been queued or has failed.

Filename
Filename string

The filename of the document.

File Content
FileContent byte

The processed document.

DocumentArray

Name Path Type Description
Filename
fileName string

The filename of the file

File Content
fileContent byte

The file content of the file

DtoResponseMergeArrayOfDocumentsToPdf

Name Path Type Description
HTTP Status Code
HttpStatusCode integer

The HTTP Status code for the response.

HTTP Status Message
HttpStatusMessage string

The HTTP Status message for the response.

Operation ID
OperationId string

The unique ID assigned to this operation.

Errors
Errors array of string

An array of error messages should an error occur.

Operation Status
Operation Status string

Indicates whether the operation has completed, has been queued or has failed.

Filename
Filename string

The filename of the document.

File Content
FileContent byte

The processed document.

DtoResponseMergeArrayOfDocumentsToWord

Name Path Type Description
HTTP Status Code
HttpStatusCode integer

The HTTP Status code for the response.

HTTP Status Message
HttpStatusMessage string

The HTTP Status message for the response.

Operation ID
OperationId string

The unique ID assigned to this operation.

Errors
Errors array of string

An array of error messages should an error occur.

Operation Status
Operation Status string

Indicates whether the operation has completed, has been queued or has failed.

Filename
Filename string

The filename of the document.

File Content
FileContent byte

The processed document.

DtoResponseOcrPdf

Name Path Type Description
HTTP Status Code
HttpStatusCode integer

The HTTP Status code for the response.

HTTP Status Message
HttpStatusMessage string

The HTTP Status message for the response.

Operation ID
OperationId string

The unique ID assigned to this operation.

Errors
Errors array of string

An array of error messages should an error occur.

Operation Status
Operation Status string

Indicates whether the operation has completed, has been queued or has failed.

Filename
Filename string

The filename of the document.

File Content
FileContent byte

The processed document.

DtoResponseSplitDocument

Name Path Type Description
Documents
documents array of DocumentArray

The array of documents to be processed

HTTP Status Code
HttpStatusCode integer

The HTTP Status code for the response.

HTTP Status Message
HttpStatusMessage string

The HTTP Status message for the response.

Operation ID
OperationId string

The unique ID assigned to this operation.

Errors
Errors array of string

An array of error messages should an error occur.

Operation Status
Operation Status string

Indicates whether the operation has completed, has been queued or has failed.

DtoResponseWordToPdfForm

Name Path Type Description
HTTP Status Code
HttpStatusCode integer

The HTTP Status code for the response.

HTTP Status Message
HttpStatusMessage string

The HTTP Status message for the response.

Operation ID
OperationId string

The unique ID assigned to this operation.

Errors
Errors array of string

An array of error messages should an error occur.

Operation Status
Operation Status string

Indicates whether the operation has completed, has been queued or has failed.

Filename
Filename string

The filename of the document.

File Content
FileContent byte

The processed document.

DtoResponseAddTextWatermark

Name Path Type Description
HTTP Status Code
HttpStatusCode integer

The HTTP Status code for the response.

HTTP Status Message
HttpStatusMessage string

The HTTP Status message for the response.

Operation ID
OperationId string

The unique ID assigned to this operation.

Errors
Errors array of string

An array of error messages should an error occur.

Operation Status
Operation Status string

Indicates whether the operation has completed, has been queued or has failed.

Filename
Filename string

The filename of the document.

File Content
FileContent byte

The processed document.

DtoResponseAddImageWatermark

Name Path Type Description
HTTP Status Code
HttpStatusCode integer

The HTTP Status code for the response.

HTTP Status Message
HttpStatusMessage string

The HTTP Status message for the response.

Operation ID
OperationId string

The unique ID assigned to this operation.

Errors
Errors array of string

An array of error messages should an error occur.

Operation Status
Operation Status string

Indicates whether the operation has completed, has been queued or has failed.

Filename
Filename string

The filename of the document.

File Content
FileContent byte

The processed document.

DtoResponseAddTextWatermarkAdv

Name Path Type Description
HTTP Status Code
HttpStatusCode integer

The HTTP Status code for the response.

HTTP Status Message
HttpStatusMessage string

The HTTP Status message for the response.

Operation ID
OperationId string

The unique ID assigned to this operation.

Errors
Errors array of string

An array of error messages should an error occur.

Operation Status
Operation Status string

Indicates whether the operation has completed, has been queued or has failed.

Filename
Filename string

The filename of the document.

File Content
FileContent byte

The processed document.

DtoResponseAddImageWatermarkAdv

Name Path Type Description
HTTP Status Code
HttpStatusCode integer

The HTTP Status code for the response.

HTTP Status Message
HttpStatusMessage string

The HTTP Status message for the response.

Operation ID
OperationId string

The unique ID assigned to this operation.

Errors
Errors array of string

An array of error messages should an error occur.

Operation Status
Operation Status string

Indicates whether the operation has completed, has been queued or has failed.

Filename
Filename string

The filename of the document.

File Content
FileContent byte

The processed document.

DtoResponseImageCleanUpDoc

Name Path Type Description
HTTP Status Code
HttpStatusCode integer

The HTTP Status code for the response.

HTTP Status Message
HttpStatusMessage string

The HTTP Status message for the response.

Operation ID
OperationId string

The unique ID assigned to this operation.

Errors
Errors array of string

An array of error messages should an error occur.

Operation Status
Operation Status string

Indicates whether the operation has completed, has been queued or has failed.

Filename
Filename string

The filename of the document.

File Content
FileContent byte

The processed document.

DtoResponseImageCleanUpPhoto

Name Path Type Description
HTTP Status Code
HttpStatusCode integer

The HTTP Status code for the response.

HTTP Status Message
HttpStatusMessage string

The HTTP Status message for the response.

Operation ID
OperationId string

The unique ID assigned to this operation.

Errors
Errors array of string

An array of error messages should an error occur.

Operation Status
Operation Status string

Indicates whether the operation has completed, has been queued or has failed.

Filename
Filename string

The filename of the document.

File Content
FileContent byte

The processed document.

DtoResponseExtractTextRegion

Name Path Type Description
Simple Text Region Results
TextRegionResultsSimple string

A collection of text region results in simplified format

Text Region Results
TextRegionResults array of TextRegionResult

A collection of text region results.

HTTP Status Code
HttpStatusCode integer

The HTTP Status code for the response.

HTTP Status Message
HttpStatusMessage string

The HTTP Status message for the response.

Operation ID
OperationId string

The unique ID assigned to this operation.

Errors
Errors array of string

An array of error messages should an error occur.

Operation Status
Operation Status string

Indicates whether the operation has completed, has been queued or has failed.

Filename
Filename string

The filename of the document.

File Content
FileContent byte

The processed document.

TextRegionResult

Name Path Type Description
Name
Name string

The name assigned to the text region

Text
Text string

The text extracted via OCR from the specified region

Page Number
PageNumber integer

The number of the page the text was extracted from

DtoResponseAddHtmlHeaderFooter

Name Path Type Description
HTTP Status Code
HttpStatusCode integer

The HTTP Status code for the response.

HTTP Status Message
HttpStatusMessage string

The HTTP Status message for the response.

Operation ID
OperationId string

The unique ID assigned to this operation.

Errors
Errors array of string

An array of error messages should an error occur.

Operation Status
Operation Status string

Indicates whether the operation has completed, has been queued or has failed.

Filename
Filename string

The filename of the document.

File Content
FileContent byte

The processed document.

DtoResponseAddPageNumbers

Name Path Type Description
HTTP Status Code
HttpStatusCode integer

The HTTP Status code for the response.

HTTP Status Message
HttpStatusMessage string

The HTTP Status message for the response.

Operation ID
OperationId string

The unique ID assigned to this operation.

Errors
Errors array of string

An array of error messages should an error occur.

Operation Status
Operation Status string

Indicates whether the operation has completed, has been queued or has failed.

Filename
Filename string

The filename of the document.

File Content
FileContent byte

The processed document.

DtoResponseGetPdfTextLayer

Name Path Type Description
Text Layer
TextLayer string

The text layer extracted from the PDF document.

HTTP Status Code
HttpStatusCode integer

The HTTP Status code for the response.

HTTP Status Message
HttpStatusMessage string

The HTTP Status message for the response.

Operation ID
OperationId string

The unique ID assigned to this operation.

Errors
Errors array of string

An array of error messages should an error occur.

Operation Status
Operation Status string

Indicates whether the operation has completed, has been queued or has failed.

Filename
Filename string

The filename of the document.

File Content
FileContent byte

The processed document.

DtoResponseRedactPdf

Name Path Type Description
HTTP Status Code
HttpStatusCode integer

The HTTP Status code for the response.

HTTP Status Message
HttpStatusMessage string

The HTTP Status message for the response.

Operation ID
OperationId string

The unique ID assigned to this operation.

Errors
Errors array of string

An array of error messages should an error occur.

Operation Status
Operation Status string

Indicates whether the operation has completed, has been queued or has failed.

Filename
Filename string

The filename of the document.

File Content
FileContent byte

The processed document.

DtoResponseImageResize

Name Path Type Description
HTTP Status Code
HttpStatusCode integer

The HTTP Status code for the response.

HTTP Status Message
HttpStatusMessage string

The HTTP Status message for the response.

Operation ID
OperationId string

The unique ID assigned to this operation.

Errors
Errors array of string

An array of error messages should an error occur.

Operation Status
Operation Status string

Indicates whether the operation has completed, has been queued or has failed.

Filename
Filename string

The filename of the document.

File Content
FileContent byte

The processed document.

DtoResponseGetPdfFormData

Name Path Type Description
Form Data
Form Data string

A JSON representation of the data data extracted from the PDF form.

HTTP Status Code
HttpStatusCode integer

The HTTP Status code for the response.

HTTP Status Message
HttpStatusMessage string

The HTTP Status message for the response.

Operation ID
OperationId string

The unique ID assigned to this operation.

Errors
Errors array of string

An array of error messages should an error occur.

Operation Status
Operation Status string

Indicates whether the operation has completed, has been queued or has failed.

Filename
Filename string

The filename of the document.

File Content
FileContent byte

The processed document.

DtoResponseSearchAndReplaceText

Name Path Type Description
HTTP Status Code
HttpStatusCode integer

The HTTP Status code for the response.

HTTP Status Message
HttpStatusMessage string

The HTTP Status message for the response.

Operation ID
OperationId string

The unique ID assigned to this operation.

Errors
Errors array of string

An array of error messages should an error occur.

Operation Status
Operation Status string

Indicates whether the operation has completed, has been queued or has failed.

Filename
Filename string

The filename of the document.

File Content
FileContent byte

The processed document.

DtoResponseSearchAndReplaceTextWithImage

Name Path Type Description
HTTP Status Code
HttpStatusCode integer

The HTTP Status code for the response.

HTTP Status Message
HttpStatusMessage string

The HTTP Status message for the response.

Operation ID
OperationId string

The unique ID assigned to this operation.

Errors
Errors array of string

An array of error messages should an error occur.

Operation Status
Operation Status string

Indicates whether the operation has completed, has been queued or has failed.

Filename
Filename string

The filename of the document.

File Content
FileContent byte

The processed document.

DtoResponseConvertPdfToWord

Name Path Type Description
HTTP Status Code
HttpStatusCode integer

The HTTP Status code for the response.

HTTP Status Message
HttpStatusMessage string

The HTTP Status message for the response.

Operation ID
OperationId string

The unique ID assigned to this operation.

Errors
Errors array of string

An array of error messages should an error occur.

Operation Status
Operation Status string

Indicates whether the operation has completed, has been queued or has failed.

Filename
Filename string

The filename of the document.

File Content
FileContent byte

The processed document.

DtoResponseImageCompress

Name Path Type Description
HTTP Status Code
HttpStatusCode integer

The HTTP Status code for the response.

HTTP Status Message
HttpStatusMessage string

The HTTP Status message for the response.

Operation ID
OperationId string

The unique ID assigned to this operation.

Errors
Errors array of string

An array of error messages should an error occur.

Operation Status
Operation Status string

Indicates whether the operation has completed, has been queued or has failed.

Filename
Filename string

The filename of the document.

File Content
FileContent byte

The processed document.

DtoResponseZipArrayOfDocuments

Name Path Type Description
HTTP Status Code
HttpStatusCode integer

The HTTP Status code for the response.

HTTP Status Message
HttpStatusMessage string

The HTTP Status message for the response.

Operation ID
OperationId string

The unique ID assigned to this operation.

Errors
Errors array of string

An array of error messages should an error occur.

Operation Status
Operation Status string

Indicates whether the operation has completed, has been queued or has failed.

Filename
Filename string

The filename of the document.

File Content
FileContent byte

The processed document.

DtoResponseGetPdfDocumentInfo

Name Path Type Description
Number of Pages
NumberOfPages integer

The number of pages in the supplied PDF document

File Size (MBs)
FileSize string

The size of the supplied PDF document in MBs

Author
Author string

The author of the PDF as set in the PDF properties

Creator
Creator string

The creator of the PDF as set in the PDF properties

Producer
Producer string

The producer of the PDF as set in the PDF properties

Title
Title string

The Title of the PDF as set in the PDF properties

Subject
Subject string

The Subject of the PDF as set in the PDF properties

Created Date
CreatedDate date-time

The creation date of the PDF as set in the PDF properties

Modified Date
ModifiedDate date-time

The last modified date of the PDF as set in the PDF properties

PDF Format
PDFFormat string

The format of the PDF

Is PDFA Compliant
IsPDFACompliant boolean

Indicates whether the supplied PDF complies with the PDF/a standard

Is PDFUA Compliant
IsPDFUACompliant boolean

Indicates whether the supplied PDF complies with the PDF/ua standard

Is Encrypted
IsEncrypted boolean

Indicates whether the supplied PDF complies with the PDF/ua standard

Has Text Layer
HasTextLayer boolean

Indicates whether the supplied PDF has a text layer

HTTP Status Code
HttpStatusCode integer

The HTTP Status code for the response.

HTTP Status Message
HttpStatusMessage string

The HTTP Status message for the response.

Operation ID
OperationId string

The unique ID assigned to this operation.

Errors
Errors array of string

An array of error messages should an error occur.

Operation Status
Operation Status string

Indicates whether the operation has completed, has been queued or has failed.

Filename
Filename string

The filename of the document.

File Content
FileContent byte

The processed document.

DtoResponseUnlockPdf

Name Path Type Description
HTTP Status Code
HttpStatusCode integer

The HTTP Status code for the response.

HTTP Status Message
HttpStatusMessage string

The HTTP Status message for the response.

Operation ID
OperationId string

The unique ID assigned to this operation.

Errors
Errors array of string

An array of error messages should an error occur.

Operation Status
Operation Status string

Indicates whether the operation has completed, has been queued or has failed.

Filename
Filename string

The filename of the document.

File Content
FileContent byte

The processed document.