Encodian (Preview)

Encodian (Preview)

Enhanced document management and PDF creation capabilities for Office 365, Flow, Logic Apps + more

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
Flow Standard All Flow regions
PowerApps Standard All PowerApps regions

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Creating a connection

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

API Key
securestring
The API Key for this api

Actions

Add a HTML header, footer or both to the specified PDF document.

Required Parameters

HTML Header / Footer
string
The HTML to embed as a header or footer within the document
Filename
string
The filename of the source file, the file extension is mandatory: example.docx or example.png

Optional Parameters

File Content
byte
Optional - The content of the source PDF document
Operation ID
string
Optional - The identifier of a source operation
Location
string
Set whether the HTML should be added to the header, footer of both locations.
Apply To
string
Set which pages within the PDF document to apply the HTML header or footer.
Page Numbers
integer
Ignore Page Numbers
integer
Margin - Bottom
double
Set the bottom margin value (pt), which determines the height of the footers container. The default value is set to -1, whereby a minus value does not change the existing page margin value.
Final Operation
boolean
Set whether this is the final operation for this document

Returns

Add Image Watermark

Add an image watermark to the specified PDF document using the standard options.

Required Parameters

Watermark File Content
byte
The content of the watermark file
Watermark Filename
string
The filename for the watermark file
Filename
string
The filename of the source file, the file extension is mandatory: example.docx or example.png

Optional Parameters

File Content
byte
Optional - The content of the source file
Operation ID
string
Optional - The identifier of a source operation
Orientation
string
The orientation of the image to embed as a watermark within the document
Opacity
float
The opacity of the text watermark, valid values range from 0.0+ to 1.0, the default value is 1.0
Final Operation
boolean
Set whether this is the final operation for this document

Returns

Add Image Watermark (Advanced)

Add an image watermark to the specified PDF document using the standard options.

Required Parameters

Watermark File Content
byte
The content of the watermark file
Watermark Filename
string
The filename for the watermark file
Filename
string
The filename of the source file, the file extension is mandatory: example.docx or example.png

Optional Parameters

File Content
byte
Optional - The content of the source file
Operation ID
string
Optional - The identifier of a source operation
Watermark Opacity
float
The opacity of the text watermark, valid values range from 0.0+ to 1.0, the default value is 1.0
Apply To
string
Set where in the document to apply the watermark.
Page Numbers
integer
Rotation Angle
float
Set the rotation angle of the image watermark in degrees.
Quality
integer
Set the quality of the image watermark from 1 to 100.
X Offset
float
Set the X offset for positioning the watermark image on the page.
Y Offset
float
Set the Y offset for positioning the watermark image on the page.
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
boolean
If set to 'true' the watermark image will be added to the background of the page.
Final Operation
boolean
Set whether this is the final operation for this document

Returns

Add Page Numbers

Add page numbers to the PDF document provided.

Required Parameters

Filename
string
The filename of the source file, the file extension is mandatory: example.docx or example.png

Optional Parameters

File Content
byte
Optional - The content of the source PDF file
Operation ID
string
Optional - The identifier of a source operation
Start Page
integer
Set which page to start adding page number(s) from.
Start Number
integer
Set the starting number for the page number(s) added to the document.
Page Number Format
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
string
Set the horizontal alignment of the page number(s) added to the document, the default value is Center.
Margin - Top
double
Set the top margin value (pt). The default value is set to 20.
Margin - Right
double
Set the right margin value(pt). The default value is set to 20.
Margin - Bottom
double
Set the bottom margin value (pt). The default value is set to 20.
Margin - Left
double
Set the left margin value (pt). The default value is set to 20.
Add to Background
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
string
Specify the name of the font, if the font cannot be found the default 'Arial' will be used.
Font Colour
string
Set the HTML colour of the font, the default colour is set to #000000.
Font Size
integer
Set the size of the font, the default size is set to 14.
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
Final Operation
boolean
Set whether this is the final operation for this document

Returns

Add Text Watermark

Add a text watermark to the specified PDF document using the standard options.

Required Parameters

Text
string
The text to embed as a watermark within the document
Filename
string
The filename of the source file, the file extension is mandatory: example.docx or example.png

Optional Parameters

File Content
byte
Optional - The content of the source file
Operation ID
string
Optional - The identifier of a source operation
Orientation
string
The orientation of the text to embed as a watermark within the document
Font
string
The font applied to the text watermark, the default font is set to Helvetica.
Text Colour
string
The HTML colour applied to the text watermark, the default colour is set to #E81123.
Text Size
integer
The size of the font applied to the text watermark, the default size is set to 34.
Opacity
float
The opacity of the text watermark, valid values range from 0.0+ to 1.0, the default value is 1.0
Final Operation
boolean
Set whether this is the final operation for this document

Returns

Add Text Watermark (Advanced)

Add a text watermark to the specified PDF document using the advanced options.

Required Parameters

Text
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.
Filename
string
The filename of the source file, the file extension is mandatory: example.docx or example.png

Optional Parameters

File Content
byte
Optional - The content of the source file
Operation ID
string
Optional - The identifier of a source operation
Font
string
The font applied to the text watermark, the default font is set to Helvetica.
Text Colour
string
The HTML colour applied to the text watermark, the default colour is set to #E81123.
Text Size
integer
The size of the font applied to the text watermark, the default size is set to 34.
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
string
The encoding type to apply to the text watermark.
Horizontal Alignment
string
Set the horizontal alignment of the watermark, the default value is Center.
Vertical Alignment
string
Set the vertical alignment of the watermark, the default value is Center.
Text Alignment
string
Set the text alignment of the watermark, the default value is Center.
Apply To
string
Set where in the document to apply the watermark.
Page Numbers
integer
Rotation Angle
float
Set the rotation angle of the text watermark.
Text Wrap
boolean
Set whether the text watermark should automatically wrap.
Text Wrap Row Width
double
Set the row width applied when the watermark is set to automatically wrap.
Auto Scale
boolean
Set the whether the text should be automatically sized to fit the width of the container.
Auto Scale Text Width
double
Set the width of the watermark container when automatic scaling is enabled.
Auto Scale Text Height
double
Set the height of the watermark container when automatic scaling is enabled.
Text Layer
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
double
Set the vertical watermark indent, starting from the bottom and overriding the VerticalAlignment property.
X Indent
double
Set the horizontal watermark indent, starting from the left and overriding the HorizontalAlignment property.
Apply as an Image
boolean
Set whether the text watermark should be added as text or an image.
Final Operation
boolean
Set whether this is the final operation for this document

Returns

Convert HTML to PDF

Convert the HTML or Web URL provided to a PDF document.

Required Parameters

PDF Filename
string
The filename of the output document
Filename
string
The filename of the source file, the file extension is mandatory: example.docx or example.png

Optional Parameters

File Content
byte
Optional - The content of the source file, please also supply the filename.
HTML Data
string
Optional - The HTML which will be converted to a PDF document
HTML Url
string
Optional - The web address to the web page which will be converted to a PDF document
Decode HTML Data
boolean
Set whether the data provided in the HTML Data field should be decoded.
Final Operation
boolean
Set whether this is the final operation for this document

Returns

Convert PDF to PDFA

Convert a PDF document to PDF/A format.

Required Parameters

Filename
string
The filename of the source file, the file extension is mandatory: example.docx or example.png

Optional Parameters

File Content
byte
Optional - Content of the source file
Operation ID
string
Optional - The identifier of a source operation
PDF/A Compliance Level
string
Set the PDF/A Compliance Level, the default value is PDF_A_2A.
Final Operation
boolean
Set whether this is the final operation for this document

Returns

Convert Text to PDF

Convert the text provided to a PDF document.

Required Parameters

PDF Filename
string
The filename of the output document

Optional Parameters

File Content
byte
Optional - Please provide either the content of the source file and source filename or text data.
Text Data
string
Optional - Please provide either the text data which will be converted to a PDF document or the content of the source file and source filename.
Encoding Type
string
The encoding type used for text conversion.
Final Operation
boolean
Set whether this is the final operation for this document

Returns

Convert Word to PDF Form

Convert the Word document provided (Legacy Form Controls Only) to a PDF form document.

Required Parameters

PDF Filename
string
The filename of the output document
File Content
byte
The content of the source file
Filename
string
The filename of the source file, the file extension is mandatory: example.docx or example.png

Optional Parameters

Final Operation
boolean
Set whether this is the final operation for this document

Returns

Convert to PDF

Convert a document to PDF or PDF/A format.

Required Parameters

File Content
byte
The content of the source file
PDF Filename
string
The filename of the output document
Filename
string
The filename of the source file, the file extension is mandatory: example.docx or example.png

Optional Parameters

Remove Markup
boolean
Set MS Office document comments and tracked changes removal option
PDF/A Compliant
boolean
Set PDF/A Compliance option
PDF/A Compliance Level
string
Set the PDF/A Compliance Level, the default value is PDF_A_2A.
Generate Bookmarks
boolean
Set whether bookmarks should be automatically created for Microsoft Word documents which are converted to PDF.
Culture Name
string
This setting only applies to Microsoft Excel documents and is used to set the culture for the workbook prior to conversion.
Final Operation
boolean
Set whether this is the final operation for this document

Returns

Extract Text from Regions

Extract text using OCR from 70+ files types using specified regions.

Required Parameters

Name
string
The name assigned to the text region
Filename
string
The filename of the source file, the file extension is mandatory: example.docx or example.png

Optional Parameters

Lower Left X Coordinate
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
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
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
double
The number of points from the bottom edge of the page to the upper right corner of the rectangle text region
Page Number
integer
The number of the page to extract text from
File Content
byte
Optional - The content of the source file
Operation ID
string
Optional - The identifier of a source operation
Final Operation
boolean
Set whether this is the final operation for this document

Returns

Get PDF Text Layer

Get the text layer for the PDF document provided.

Required Parameters

Filename
string
The filename of the source file, the file extension is mandatory: example.docx or example.png

Optional Parameters

File Content
byte
Optional - The content of the source file
Operation ID
string
Optional - The identifier of a source operation
Start Page
integer
Sets the page number to begin text layer extraction from.
End Page
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
string
The encoding type used for text extraction.
Final Operation
boolean
Set whether this is the final operation for this document

Returns

Image Clean Up (Document)

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

Required Parameters

Filename
string
The filename of the source file, the file extension is mandatory: example.docx or example.png

Optional Parameters

File Content
byte
The content of the source file
Clean Operations
string
Perform file clean-up operations, the default option will auto rotate, auto deskew and auto despeckle the provided file.
Rotate
boolean
Automatically detects orientation and rotates so that the text is upright oriented, this is enabled by default.
Rotate Confidence Level
integer
Sets the minimum confidence percentage (0 to 100) used to control whether the rotation is applied, the default value is 60.
Deskew
boolean
Detects the skew angle and rotates to remove that skew, this is enabled by default.
Despeckle
boolean
Automatically detects speckles and removes them, this is enabled by default.
Adjust Brightness and Contrast
boolean
This action analyzes a document and automatically adjusts brightness and contrast based on the analysis, this is disabled by default.
Remove Border
boolean
Locates border pixels and removes the pixels from the document, this is disabled by default.
Smooth Background
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
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
boolean
This action will remove shaded regions from bitonal documents, this is disabled by default.
Image Detergent
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
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
boolean
Detects and removes hole punch marks from a bitonal document, this is disabled by default.
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.

Required Parameters

Filename
string
The filename of the source file, the file extension is mandatory: example.docx or example.png

Optional Parameters

File Content
byte
The content of the source file
Clean Operations
string
Perform file clean-up operations, the default option will auto rotate, apply colour balance, auto deskew and auto despeckle the provided file.
Deskew
boolean
Detects the skew angle and rotates to remove that skew, this is enabled by default.
Despeckle
boolean
Automatically detects speckles and removes them, this is enabled by default.
Color Balance
boolean
Restores and balances the color quality within an image, this is enabled by default.
Remove Border
boolean
Locates border pixels and removes the pixels from the document, this is disabled by default.
Contrast
boolean
Adjusts the contrast in the current image.
Remove Redeye
boolean
Automatically reduces the red reflection of the flash seen in the eyes of people in color flash photo images.
Blur
boolean
Blurs the current image by averaging each pixel with each of its neighboring pixels giving it an 'out of focus' appearance.
Diffuse
boolean
Diffuses the current image by replacing each pixel with a randomly selected neighboring pixel.
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
boolean
Automatically detects orientation and rotates so that the text is upright oriented, this is enabled by default.
Rotate Confidence Level
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.

Required Parameters

HTML Data
string
The HTML which will be inserted into the PDF document
Filename
string
The filename of the source file, the file extension is mandatory: example.docx or example.png

Optional Parameters

File Content
byte
Optional - The content of the source PDF file
Operation ID
string
Optional - The identifier of a source operation
Decode HTML Data
boolean
Set whether the data provided in the HTML Data field should be decoded.
HTML Insert Location
string
Set where within the PDF provided, the HTML data should be inserted, the default value is Append.
Final Operation
boolean
Set whether this is the final operation for this document

Returns

Merge document array to PDF

Convert and merge an array of documents to a single PDF document.

Required Parameters

PDF Filename
string
The filename of the output document

Optional Parameters

Filename
string
The filename of file
File Content
byte
The content of the file
Remove Markup
boolean
Set MS Office document comments and tracked changes removal option
PDF/A Compliant
boolean
Set PDF/A Compliance option
PDF/A Compliance Level
string
Set the PDF/A Compliance Level, the default value is PDF_A_2A.
Final Operation
boolean
Set whether this is the final operation for this document

Returns

Merge documents to PDF

Convert and merge the documents provided to a single PDF document.

Required Parameters

PDF Filename
string
The filename of the output document
File Content
byte
The content of the source file
Filename 2
string
The filename of the 2nd source file
File Content 2
byte
The content of the 2nd source file
Filename
string
The filename of the source file, the file extension is mandatory: example.docx or example.png

Optional Parameters

Filename 3
string
The filename of the 3rd source file
File Content 3
byte
The content of the 3rd source file
Filename 4
string
The filename of the 4th source file
File Content 4
byte
The content of the 4th source file
Filename 5
string
The filename of the 5th source file
File Content 5
byte
The content of the 5th source file
Filename 6
string
The filename of the 6th source file
File Content 6
byte
The content of the 6th source file
Filename 7
string
The filename of the 7th source file
File Content 7
byte
The content of the 7th source file
Filename 8
string
The filename of the 8th source file
File Content 8
byte
The content of the 8th source file
Filename 9
string
The filename of the 9th source file
File Content 9
byte
The content of the 9th source file
Filename 10
string
The filename of the 10th source file
File Content 10
byte
The content of the 10th source file
Remove Markup
boolean
Set MS Office document comments and tracked changes removal option
PDF/A Compliant
boolean
Set PDF/A Compliance option
PDF/A Compliance Level
string
Set the PDF/A Compliance Level, the default value is PDF_A_2A.
Final Operation
boolean
Set whether this is the final operation for this document

Returns

OCR a PDF Document

Perform OCR on an existing PDF document.

Required Parameters

Filename
string
The filename of the source file, the file extension is mandatory: example.docx or example.png

Optional Parameters

File Content
byte
Optional - Content of the source file
Operation ID
string
Optional - The identifier of a source operation
Clean Operations
string
Perform document clean-up operations, the default option will auto rotate, auto deskew and auto despeckle the document.
Remove Blank Pages
boolean
Set whether blank pages should be removed from the PDF document.
PDF/A Compliant
boolean
Set PDF/A Compliance option
PDF/A Compliance Level
string
Set the PDF/A Compliance Level, the default value is PDF_A_2A.
Rotate
boolean
Automatically detects orientation and rotates it so that the text on it is upright oriented, this is enabled by default.
Rotate Confidence Level
integer
Sets the minimum confidence percentage (0 to 100) used to control whether the rotation is applied, the default value is 60.
Deskew
boolean
Detects the skew angle and rotates to remove that skew, this is enabled by default.
Despeckle
boolean
Automatically detects speckles and removes them, this is enabled by default.
Adjust Brightness and Contrast
boolean
This action analyzes a document and automatically adjusts brightness and contrast based on the analysis, this is enabled by default.
Remove Border
boolean
Locates border pixels and removes the pixels from the document,this is disabled by default.
Smooth Background
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
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
boolean
This action will remove shaded regions from bitonal documents, this is disabled by default.
Image Detergent
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
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
boolean
Detects and removes hole punch marks from a bitonal document, this is disabled by default.
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.
Final Operation
boolean
Set whether this is the final operation for this document

Returns

Secure PDF Document

Encrypt and protect a PDF document

Required Parameters

User Password
string
Set the user password
Admin Password
string
Set the administrator password
Filename
string
The filename of the source file, the file extension is mandatory: example.docx or example.png

Optional Parameters

File Content
byte
Optional - The content of the source file
Operation ID
string
Optional - The identifier of a source operation
Privileges
string
Set the privileges assigned to the PDF document
Cryptographic Algorithm
string
Set the cryptographic algorithm
Privilege - Assembly
boolean
Privilege - Copy
boolean
Privilege - Fill in Forms
boolean
Privilege - Print
boolean
Privilege - Screen Readers
boolean
Privilege - Modify Contents
boolean
Privilege - Modify Annotations
boolean

Returns

Set PDF Document Privileges

Set the privledges assigned to the PDF document.

Required Parameters

Filename
string
The filename of the source file, the file extension is mandatory: example.docx or example.png

Optional Parameters

File Content
byte
Optional - The content of the source file
Operation ID
string
Optional - The identifier of a source operation
Privileges
string
Set the privileges assigned to the PDF document
Privilege - Assembly
boolean
Privilege - Copy
boolean
Privilege - Fill in Forms
boolean
Privilege - Print
boolean
Privilege - Screen Readers
boolean
Privilege - Modify Contents
boolean
Privilege - Modify Annotations
boolean
Final Operation
boolean
Set whether this is the final operation for this document

Returns

Definitions

DtoResponseBasicConversion

Errors
array of string
An array of error messages should an error occur.
File Content
byte
The processed document.
Filename
string
The filename of the document.
HTTP Status Code
integer
The HTTP Status code for the response.
HTTP Status Message
string
The HTTP Status message for the response.
Operation ID
string
The unique ID assigned to this operation.
Operation Status
string
Indicates whether the operation has completed, has been queued or has failed.

DtoResponseConvertToPdfA

Errors
array of string
An array of error messages should an error occur.
File Content
byte
The processed document.
Filename
string
The filename of the document.
HTTP Status Code
integer
The HTTP Status code for the response.
HTTP Status Message
string
The HTTP Status message for the response.
Operation ID
string
The unique ID assigned to this operation.
Operation Status
string
Indicates whether the operation has completed, has been queued or has failed.

DtoResponseSecurePdf

Errors
array of string
An array of error messages should an error occur.
File Content
byte
The processed document.
Filename
string
The filename of the document.
HTTP Status Code
integer
The HTTP Status code for the response.
HTTP Status Message
string
The HTTP Status message for the response.
Operation ID
string
The unique ID assigned to this operation.
Operation Status
string
Indicates whether the operation has completed, has been queued or has failed.

DtoResponseTextToPdf

Errors
array of string
An array of error messages should an error occur.
File Content
byte
The processed document.
Filename
string
The filename of the document.
HTTP Status Code
integer
The HTTP Status code for the response.
HTTP Status Message
string
The HTTP Status message for the response.
Operation ID
string
The unique ID assigned to this operation.
Operation Status
string
Indicates whether the operation has completed, has been queued or has failed.

DtoResponseHtmlToPdf

Errors
array of string
An array of error messages should an error occur.
File Content
byte
The processed document.
Filename
string
The filename of the document.
HTTP Status Code
integer
The HTTP Status code for the response.
HTTP Status Message
string
The HTTP Status message for the response.
Operation ID
string
The unique ID assigned to this operation.
Operation Status
string
Indicates whether the operation has completed, has been queued or has failed.

DtoResponseInsertHtmlToPdf

Errors
array of string
An array of error messages should an error occur.
File Content
byte
The processed document.
Filename
string
The filename of the document.
HTTP Status Code
integer
The HTTP Status code for the response.
HTTP Status Message
string
The HTTP Status message for the response.
Operation ID
string
The unique ID assigned to this operation.
Operation Status
string
Indicates whether the operation has completed, has been queued or has failed.

DtoResponseMergeDocumentsToPdf

Errors
array of string
An array of error messages should an error occur.
File Content
byte
The processed document.
Filename
string
The filename of the document.
HTTP Status Code
integer
The HTTP Status code for the response.
HTTP Status Message
string
The HTTP Status message for the response.
Operation ID
string
The unique ID assigned to this operation.
Operation Status
string
Indicates whether the operation has completed, has been queued or has failed.

DtoResponseMergeArrayOfDocumentsToPdf

Errors
array of string
An array of error messages should an error occur.
File Content
byte
The processed document.
Filename
string
The filename of the document.
HTTP Status Code
integer
The HTTP Status code for the response.
HTTP Status Message
string
The HTTP Status message for the response.
Operation ID
string
The unique ID assigned to this operation.
Operation Status
string
Indicates whether the operation has completed, has been queued or has failed.

DtoResponseOcrPdf

Errors
array of string
An array of error messages should an error occur.
File Content
byte
The processed document.
Filename
string
The filename of the document.
HTTP Status Code
integer
The HTTP Status code for the response.
HTTP Status Message
string
The HTTP Status message for the response.
Operation ID
string
The unique ID assigned to this operation.
Operation Status
string
Indicates whether the operation has completed, has been queued or has failed.
Text Layer Added
boolean
Indicates whether OCR was performed on the document provided

DtoResponseWordToPdfForm

Errors
array of string
An array of error messages should an error occur.
File Content
byte
The processed document.
Filename
string
The filename of the document.
HTTP Status Code
integer
The HTTP Status code for the response.
HTTP Status Message
string
The HTTP Status message for the response.
Operation ID
string
The unique ID assigned to this operation.
Operation Status
string
Indicates whether the operation has completed, has been queued or has failed.

DtoResponseAddTextWatermark

Errors
array of string
An array of error messages should an error occur.
File Content
byte
The processed document.
Filename
string
The filename of the document.
HTTP Status Code
integer
The HTTP Status code for the response.
HTTP Status Message
string
The HTTP Status message for the response.
Operation ID
string
The unique ID assigned to this operation.
Operation Status
string
Indicates whether the operation has completed, has been queued or has failed.

DtoResponseAddImageWatermark

Errors
array of string
An array of error messages should an error occur.
File Content
byte
The processed document.
Filename
string
The filename of the document.
HTTP Status Code
integer
The HTTP Status code for the response.
HTTP Status Message
string
The HTTP Status message for the response.
Operation ID
string
The unique ID assigned to this operation.
Operation Status
string
Indicates whether the operation has completed, has been queued or has failed.

DtoResponseAddTextWatermarkAdv

Errors
array of string
An array of error messages should an error occur.
File Content
byte
The processed document.
Filename
string
The filename of the document.
HTTP Status Code
integer
The HTTP Status code for the response.
HTTP Status Message
string
The HTTP Status message for the response.
Operation ID
string
The unique ID assigned to this operation.
Operation Status
string
Indicates whether the operation has completed, has been queued or has failed.

DtoResponseAddImageWatermarkAdv

Errors
array of string
An array of error messages should an error occur.
File Content
byte
The processed document.
Filename
string
The filename of the document.
HTTP Status Code
integer
The HTTP Status code for the response.
HTTP Status Message
string
The HTTP Status message for the response.
Operation ID
string
The unique ID assigned to this operation.
Operation Status
string
Indicates whether the operation has completed, has been queued or has failed.

DtoResponseImageCleanUpDoc

Errors
array of string
An array of error messages should an error occur.
File Content
byte
The processed document.
Filename
string
The filename of the document.
HTTP Status Code
integer
The HTTP Status code for the response.
HTTP Status Message
string
The HTTP Status message for the response.
Operation ID
string
The unique ID assigned to this operation.
Operation Status
string
Indicates whether the operation has completed, has been queued or has failed.

DtoResponseImageCleanUpPhoto

Errors
array of string
An array of error messages should an error occur.
File Content
byte
The processed document.
Filename
string
The filename of the document.
HTTP Status Code
integer
The HTTP Status code for the response.
HTTP Status Message
string
The HTTP Status message for the response.
Operation ID
string
The unique ID assigned to this operation.
Operation Status
string
Indicates whether the operation has completed, has been queued or has failed.

DtoResponseExtractTextRegion

Errors
array of string
An array of error messages should an error occur.
File Content
byte
The processed document.
Filename
string
The filename of the document.
HTTP Status Code
integer
The HTTP Status code for the response.
HTTP Status Message
string
The HTTP Status message for the response.
Operation ID
string
The unique ID assigned to this operation.
Operation Status
string
Indicates whether the operation has completed, has been queued or has failed.
Text Region Results
array of TextRegionResult
A collection of text region results.

TextRegionResult

Name
string
The name assigned to the text region
Page Number
integer
The number of the page the text was extracted from
Text
string
The text extracted via OCR from the specified region

DtoResponseAddHtmlHeaderFooter

Errors
array of string
An array of error messages should an error occur.
File Content
byte
The processed document.
Filename
string
The filename of the document.
HTTP Status Code
integer
The HTTP Status code for the response.
HTTP Status Message
string
The HTTP Status message for the response.
Operation ID
string
The unique ID assigned to this operation.
Operation Status
string
Indicates whether the operation has completed, has been queued or has failed.

DtoResponseAddPageNumbers

Errors
array of string
An array of error messages should an error occur.
File Content
byte
The processed document.
Filename
string
The filename of the document.
HTTP Status Code
integer
The HTTP Status code for the response.
HTTP Status Message
string
The HTTP Status message for the response.
Operation ID
string
The unique ID assigned to this operation.
Operation Status
string
Indicates whether the operation has completed, has been queued or has failed.

DtoResponseGetPdfTextLayer

Errors
array of string
An array of error messages should an error occur.
File Content
byte
The processed document.
Filename
string
The filename of the document.
HTTP Status Code
integer
The HTTP Status code for the response.
HTTP Status Message
string
The HTTP Status message for the response.
Operation ID
string
The unique ID assigned to this operation.
Operation Status
string
Indicates whether the operation has completed, has been queued or has failed.
Text Layer
string
The text layer extracted from the PDF document.