Form Recognizer (Preview)

  • Reference

Extracts information from forms and images into structured data based on pre-trained models or model created by a set of representative training forms.

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
     -   US Department of Defense (DoD)
Power Automate Standard All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Standard All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Microsoft
URL https://aka.ms/formrecognizer
Email formrecog_contact@microsoft.com
Connector Metadata
Publisher Microsoft
Website https://aka.ms/formrecognizer
Privacy policy https://aka.ms/form-recognizer/privacy
Categories AI;Business Intelligence

The Form Recognizer connector provide integration to Cognitive Service Form Recognizer. It allows analyze and extract informatino from Forms, Invoices, Receipts, Business Cards, and ID Documents.

Prerequisites

To use this integration, you will need a Cognitive Service Form Recognizer resource in the Azure portal. Create resource link. You will get an endpoint and a key for authenticating your applications. To make a connection, provide the Account key, site URL and select Create connection. For operation costs on your connection, learn more here.

How to get credentials

  1. Open Form Recognizer resource in Azure portal (see [Prerequisites]).
  2. Select Keys and Endpoint under Resource Management
  3. Copy Endpoint and Key and use them to create new connection.

Getting started with your connector

Simplest way to try the Form Recognizer connector is to use any prebuilt models (Analyze Invoice, Receipt, Business Card, or ID Document). Provide PDF or image of your document. Analyze using connector operation based on your document type and inspect detected fields.

Creating a connection

The connector supports the following authentication types:
Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
Account Key securestring Form Recognizer Account Key True
Endpoint URL string Form Recognizer Endpoint Url (Example: https://your-formrecognizer-resource.cognitiveservices.azure.com/) True

Throttling Limits

Name Calls Renewal Period
API calls per connection10060 seconds

Actions

Analyze Business Card

Extract field text and semantic values from a given business card document.
Analyze Custom Form

Extract key-value pairs, tables, and semantic values from a given document.
Analyze ID Document

Extract field text and semantic values from a given ID document.
Analyze Invoice

Extract field text and semantic values from a given invoice document.
Analyze Layout

Extract text and layout information from a given document.
Analyze Receipt

Extract field text and semantic values from a given receipt document.

Analyze Business Card

Operation ID:
AnalyzeBusinessCardAsync

Extract field text and semantic values from a given business card document.

Parameters

Name Key Required Type Description
Include Text Details
 includeTextDetails boolean

Include text lines and element references in the result. Default: True (just for FR Connector).
Pages
 pages string

The page selection for multi-page PDF and TIFF documents, to extract Invoice information from individual pages and a range of pages (like page 2, and pages 5-7) by entering the page numbers and ranges separated by commas (e.g. '2, 5-7'). If not set, all pages will be processed.
Locale
 locale string

Locale of the invoice. Supported locale includes: en-US.
Document/Image File Content
 inputFileContent binary

A PDF document or image (JPG or PNG) file to analyze.
Document/Image URL
 inputFileUrl string

Url path for input file. Alternative to Document/Image File Content.

Returns

Status and result of the queued analyze operation.

Body
BusinessCardAnalyzeOperationResult

Analyze Custom Form

Operation ID:
AnalyzeWithCustomForm

Extract key-value pairs, tables, and semantic values from a given document.

Parameters

Name Key Required Type Description
Model Identifier
 modelId True string

Format - uuid. Model identifier.
Include Text Details
 includeTextDetails boolean

Include text lines and element references in the result. Default: True (just for FR Connector).
Pages
 pages string

The page selection for multi-page PDF and TIFF documents, to extract Invoice information from individual pages and a range of pages (like page 2, and pages 5-7) by entering the page numbers and ranges separated by commas (e.g. '2, 5-7'). If not set, all pages will be processed.
Document/Image File Content
 inputFileContent binary

A PDF document or image (JPG or PNG) file to analyze.
Document/Image URL
 inputFileUrl string

Url path for input file. Alternative to Document/Image File Content.

Returns

Status and result of the queued analyze operation.

Body
CustomFormsAnalyzeOperationResult

Analyze ID Document

Operation ID:
AnalyzeIdDocumentAsync

Extract field text and semantic values from a given ID document.

Parameters

Name Key Required Type Description
Include Text Details
 includeTextDetails boolean

Include text lines and element references in the result. Default: True (just for FR Connector).
Pages
 pages string

The page selection for multi-page PDF and TIFF documents, to extract Invoice information from individual pages and a range of pages (like page 2, and pages 5-7) by entering the page numbers and ranges separated by commas (e.g. '2, 5-7'). If not set, all pages will be processed.
Document/Image File Content
 inputFileContent binary

A PDF document or image (JPG or PNG) file to analyze.
Document/Image URL
 inputFileUrl string

Url path for input file. Alternative to Document/Image File Content.

Returns

Status and result of the queued analyze operation.

Body
IdAnalyzeOperationResult

Analyze Invoice

Operation ID:
AnalyzeInvoice

Extract field text and semantic values from a given invoice document.

Parameters

Name Key Required Type Description
Include Text Details
 includeTextDetails boolean

Include text lines and element references in the result. Default: True (just for FR Connector).
Pages
 pages string

The page selection for multi-page PDF and TIFF documents, to extract Invoice information from individual pages and a range of pages (like page 2, and pages 5-7) by entering the page numbers and ranges separated by commas (e.g. '2, 5-7'). If not set, all pages will be processed.
Locale
 locale string

Locale of the invoice. Supported locale includes: en-US.
Document/Image File Content
 inputFileContent binary

A PDF document or image (JPG or PNG) file to analyze.
Document/Image URL
 inputFileUrl string

Url path for input file. Alternative to Document/Image File Content.

Returns

Status and result of the queued analyze operation.

Body
InvoiceAnalyzeOperationResult

Analyze Layout

Operation ID:
AnalyzeLayoutAsync

Extract text and layout information from a given document.

Parameters

Name Key Required Type Description
Pages
 pages string

The page selection for multi-page PDF and TIFF documents, to extract Invoice information from individual pages and a range of pages (like page 2, and pages 5-7) by entering the page numbers and ranges separated by commas (e.g. '2, 5-7'). If not set, all pages will be processed.
Language
 language string

The BCP-47 language code of the text in the document.
Reading Order
 readingOrder string

Optional parameter to specify which reading order algorithm should be applied when ordering the extract text elements. Can be either 'basic' or 'natural'. Will default to basic if not specified
Document/Image File Content
 inputFileContent binary

A PDF document or image (JPG or PNG) file to analyze.
Document/Image URL
 inputFileUrl string

Url path for input file. Alternative to Document/Image File Content.

Returns

Status and result of the queued analyze operation.

Body
LayoutAnalyzeOperationResult

Analyze Receipt

Operation ID:
AnalyzeReceiptAsync

Extract field text and semantic values from a given receipt document.

Parameters

Name Key Required Type Description
Include Text Details
 includeTextDetails boolean

Include text lines and element references in the result. Default: True (just for FR Connector).
Pages
 pages string

The page selection for multi-page PDF and TIFF documents, to extract Invoice information from individual pages and a range of pages (like page 2, and pages 5-7) by entering the page numbers and ranges separated by commas (e.g. '2, 5-7'). If not set, all pages will be processed.
Locale
 locale string

Locale of the invoice. Supported locale includes: en-US.
Document/Image File Content
 inputFileContent binary

A PDF document or image (JPG or PNG) file to analyze.
Document/Image URL
 inputFileUrl string

Url path for input file. Alternative to Document/Image File Content.

Returns

Status and result of the queued analyze operation.

Body
ReceiptAnalyzeOperationResult

Definitions

OperationStatus

Status of the queued operation.

Status of the queued operation.

string

LayoutAnalyzeOperationResult

Status and result of the queued analyze operation.

Name Path Type Description
status
 status OperationStatus

Status of the queued operation.
createdDateTime
 createdDateTime string

Date and time (UTC) the analyze operation was submitted.
lastUpdatedDateTime
 lastUpdatedDateTime string

Date and time (UTC) when the status is last updated.
analyzeResult
 analyzeResult LayoutAnalyzeResult

Analyze operation result.

InvoiceAnalyzeOperationResult

Status and result of the queued analyze operation.

Name Path Type Description
status
 status OperationStatus

Status of the queued operation.
createdDateTime
 createdDateTime string

Date and time (UTC) the analyze operation was submitted.
lastUpdatedDateTime
 lastUpdatedDateTime string

Date and time (UTC) when the status is last updated.
analyzeResult
 analyzeResult InvoiceAnalyzeResult

Analyze operation result.

BusinessCardAnalyzeOperationResult

Status and result of the queued analyze operation.

Name Path Type Description
status
 status OperationStatus

Status of the queued operation.
createdDateTime
 createdDateTime string

Date and time (UTC) the analyze operation was submitted.
lastUpdatedDateTime
 lastUpdatedDateTime string

Date and time (UTC) when the status is last updated.
analyzeResult
 analyzeResult BusinessCardAnalyzeResult

Analyze operation result.

ReceiptAnalyzeOperationResult

Status and result of the queued analyze operation.

Name Path Type Description
status
 status OperationStatus

Status of the queued operation.
createdDateTime
 createdDateTime string

Date and time (UTC) the analyze operation was submitted.
lastUpdatedDateTime
 lastUpdatedDateTime string

Date and time (UTC) when the status is last updated.
analyzeResult
 analyzeResult ReceiptAnalyzeResult

Analyze operation result.

IdAnalyzeOperationResult

Status and result of the queued analyze operation.

Name Path Type Description
status
 status OperationStatus

Status of the queued operation.
createdDateTime
 createdDateTime string

Date and time (UTC) the analyze operation was submitted.
lastUpdatedDateTime
 lastUpdatedDateTime string

Date and time (UTC) when the status is last updated.
analyzeResult
 analyzeResult IdAnalyzeResult

Analyze operation result.

CustomFormsAnalyzeOperationResult

Status and result of the queued analyze operation.

Name Path Type Description
status
 status OperationStatus

Status of the queued operation.
createdDateTime
 createdDateTime string

Date and time (UTC) the analyze operation was submitted.
lastUpdatedDateTime
 lastUpdatedDateTime string

Date and time (UTC) when the status is last updated.
analyzeResult
 analyzeResult CustomFormsAnalyzeResult

Analyze operation result.

FormOperationError

Error reported during an operation.

Name Path Type Description
message
 message string

Error message.

LayoutAnalyzeResult

Analyze operation result.

Name Path Type Description
version
 version string

Version of schema used for this result.
readResults
 readResults array of ReadResult

Text extracted from the input.
pageResults
 pageResults array of PageResult

Page-level information extracted from the input.
errors
 errors array of FormOperationError

List of errors reported during the analyze operation.

InvoiceAnalyzeResult

Analyze operation result.

Name Path Type Description
version
 version string

Version of schema used for this result.
readResults
 readResults array of ReadResult

Text extracted from the input.
pageResults
 pageResults array of PageResult

Page-level information extracted from the input.
documentResults
 documentResults array of InvoiceDocumentResult

Document-level information extracted from the input.
errors
 errors array of FormOperationError

List of errors reported during the analyze operation.

BusinessCardAnalyzeResult

Analyze operation result.

Name Path Type Description
version
 version string

Version of schema used for this result.
readResults
 readResults array of ReadResult

Text extracted from the input.
pageResults
 pageResults array of PageResult

Page-level information extracted from the input.
documentResults
 documentResults array of BusinessCardDocumentResult

Document-level information extracted from the input.
errors
 errors array of FormOperationError

List of errors reported during the analyze operation.

ReceiptAnalyzeResult

Analyze operation result.

Name Path Type Description
version
 version string

Version of schema used for this result.
readResults
 readResults array of ReadResult

Text extracted from the input.
pageResults
 pageResults array of PageResult

Page-level information extracted from the input.
documentResults
 documentResults array of ReceiptDocumentResult

Document-level information extracted from the input.
errors
 errors array of FormOperationError

List of errors reported during the analyze operation.

IdAnalyzeResult

Analyze operation result.

Name Path Type Description
version
 version string

Version of schema used for this result.
readResults
 readResults array of ReadResult

Text extracted from the input.
pageResults
 pageResults array of PageResult

Page-level information extracted from the input.
documentResults
 documentResults array of IdDocumentResult

Document-level information extracted from the input.
errors
 errors array of FormOperationError

List of errors reported during the analyze operation.

CustomFormsAnalyzeResult

Analyze operation result.

Name Path Type Description
version
 version string

Version of schema used for this result.
readResults
 readResults array of ReadResult

Text extracted from the input.
pageResults
 pageResults array of PageResult

Page-level information extracted from the input.
documentResults
 documentResults array of CustomFormsDocumentResult

Document-level information extracted from the input.
errors
 errors array of FormOperationError

List of errors reported during the analyze operation.

ReadResult

Text extracted from a page in the input document.

Name Path Type Description
page
 page integer

The 1-based page number in the input document.
angle
 angle float

The general orientation of the text in clockwise direction, measured in degrees between (-180, 180].
width
 width float

The width of the image/PDF in pixels/inches, respectively.
height
 height float

The height of the image/PDF in pixels/inches, respectively.
unit
 unit string

The unit used by the width, height and boundingBox properties. For images, the unit is "pixel". For PDF, the unit is "inch".
lines
 lines array of TextLine

When includeTextDetails is set to true, a list of recognized text lines. The maximum number of lines returned is 300 per page. The lines are sorted top to bottom, left to right, although in certain cases proximity is treated with higher priority. As the sorting order depends on the detected text, it may change across images and OCR version updates. Thus, business logic should be built upon the actual line location instead of order.

TextLine

An object representing an extracted text line.

Name Path Type Description
text
 text string

The text content of the line.
boundingBox
 boundingBox BoundingBox

Quadrangle bounding box, with coordinates specified relative to the top-left of the original image. The eight numbers represent the four points, clockwise from the top-left corner relative to the text orientation. For image, the (x, y) coordinates are measured in pixels. For PDF, the (x, y) coordinates are measured in inches.
words
 words array of TextWord

List of words in the text line.

TextWord

An object representing a word.

Name Path Type Description
text
 text string

The text content of the word.
boundingBox
 boundingBox BoundingBox

Quadrangle bounding box, with coordinates specified relative to the top-left of the original image. The eight numbers represent the four points, clockwise from the top-left corner relative to the text orientation. For image, the (x, y) coordinates are measured in pixels. For PDF, the (x, y) coordinates are measured in inches.
confidence
 confidence Confidence

Confidence value.

BoundingBox

Quadrangle bounding box, with coordinates specified relative to the top-left of the original image. The eight numbers represent the four points, clockwise from the top-left corner relative to the text orientation. For image, the (x, y) coordinates are measured in pixels. For PDF, the (x, y) coordinates are measured in inches.

Name Path Type Description
Items
 float

PageResult

Extracted information from a single page.

Name Path Type Description
page
 page integer

Page number.
clusterId
 clusterId integer

Cluster identifier.
keyValuePairs
 keyValuePairs array of KeyValuePair

List of key-value pairs extracted from the page.
tables
 tables array of DataTable

List of data tables extracted from the page.

KeyValuePair

Information about the extracted key-value pair.

Name Path Type Description
label
 label string

A user defined label for the key/value pair entry.
key
 key KeyValueElement

Information about the extracted key or value in a key-value pair.
value
 value KeyValueElement

Information about the extracted key or value in a key-value pair.
confidence
 confidence Confidence

Confidence value.

KeyValueElement

Information about the extracted key or value in a key-value pair.

Name Path Type Description
text
 text string

The text content of the key or value.
boundingBox
 boundingBox BoundingBox

Quadrangle bounding box, with coordinates specified relative to the top-left of the original image. The eight numbers represent the four points, clockwise from the top-left corner relative to the text orientation. For image, the (x, y) coordinates are measured in pixels. For PDF, the (x, y) coordinates are measured in inches.
elements
 elements array of ElementReference

When includeTextDetails is set to true, a list of references to the text elements constituting this key or value.

ElementReference

Reference to a line or word.

Reference to a line or word.

string

DataTable

Information about the extracted table contained in a page.

Name Path Type Description
rows
 rows integer

Number of rows.
columns
 columns integer

Number of columns.
cells
 cells array of DataTableCell

List of cells contained in the table.

DataTableCell

Information about the extracted cell in a table.

Name Path Type Description
rowIndex
 rowIndex integer

Row index of the cell.
columnIndex
 columnIndex integer

Column index of the cell.
rowSpan
 rowSpan integer

Number of rows spanned by this cell.
columnSpan
 columnSpan integer

Number of columns spanned by this cell.
text
 text string

Text content of the cell.
boundingBox
 boundingBox BoundingBox

Quadrangle bounding box, with coordinates specified relative to the top-left of the original image. The eight numbers represent the four points, clockwise from the top-left corner relative to the text orientation. For image, the (x, y) coordinates are measured in pixels. For PDF, the (x, y) coordinates are measured in inches.
elements
 elements array of ElementReference

When includeTextDetails is set to true, a list of references to the text elements constituting this table cell.
isHeader
 isHeader boolean

Return if the current cell is a header cell.
isFooter
 isFooter boolean

Return if the current cell a footer cell.

InvoiceDocumentResult

A set of extracted fields corresponding to the input document.

Name Path Type Description
docType
 docType string

Document type.
pageRange
 pageRange array of integer

First and last page number where the document is found.
fields
 fields InvoiceFields

Invoice fields for 2.1.

BusinessCardDocumentResult

A set of extracted fields corresponding to the input document.

Name Path Type Description
docType
 docType string

Document type.
pageRange
 pageRange array of integer

First and last page number where the document is found.
fields
 fields BusinessCardFields

BusinessCard fields for 2.1.

CustomFormsDocumentResult

A set of extracted fields corresponding to the input document.

Name Path Type Description
docType
 docType string

Document type.
pageRange
 pageRange array of integer

First and last page number where the document is found.
Fields
 _fields array of CustomFormsFields

Array of fields with fieldName and fieldValue properties.

ReceiptDocumentResult

A set of extracted fields corresponding to the input document.

Name Path Type Description
docType
 docType string

Document type.
pageRange
 pageRange array of integer

First and last page number where the document is found.
fields
 fields ReceiptFields

Receiptfields for 2.1.

IdDocumentResult

A set of extracted fields corresponding to the input document.

Name Path Type Description
docType
 docType string

Document type.
pageRange
 pageRange array of integer

First and last page number where the document is found.
fields
 fields IdFields

ID Document fields for 2.1.

CustomFormsFields

Custom Form fields.

Name Path Type Description
Field Name
 fieldName string
Field Value
 fieldValue FieldValue

Predicted field value object.

InvoiceFields

Invoice fields for 2.1.

Name Path Type Description
Amount due (text)
 AmountDue.text string

Returns amount due as written on the invoice.
Amount due (number)
 AmountDue.valueNumber number

Formatted as a number. Example: 1234.98.
Confidence of amount due
 AmountDue.confidence float

How confident the model is in its prediction.
Billing address
 BillingAddress.text string
Confidence of billing address
 BillingAddress.confidence float

How confident the model is in its prediction.
Billing address recipient
 BillingAddressRecipient.text string
Confidence of billing address recipient
 BillingAddressRecipient.confidence float

How confident the model is in its prediction.
Customer address
 CustomerAddress.text string
Confidence of customer address
 CustomerAddress.confidence float

How confident the model is in its prediction.
Customer address recipient
 CustomerAddressRecipient.text string
Confidence of customer address recipient
 CustomerAddressRecipient.confidence float

How confident the model is in its prediction.
Customer ID
 CustomerId.text string
Confidence of customer ID
 CustomerId.confidence float

How confident the model is in its prediction.
Customer name
 CustomerName.text string
Confidence of customer name
 CustomerName.confidence float

How confident the model is in its prediction.
Due date (text)
 DueDate.text string

Returns due date as written on the invoice.
Due date (date)
 DueDate.valueDate date

Formatted as a date. Example: 2019-05-31.
Confidence of due date
 DueDate.confidence float

How confident the model is in its prediction.
Invoice date (text)
 InvoiceDate.text string

Returns invoice date as written on the invoice.
Invoice date (date)
 InvoiceDate.valueDate date

Formatted as a date. Example: 2019-05-31.
Confidence of invoice date
 InvoiceDate.confidence float

How confident the model is in its prediction.
Invoice ID
 InvoiceId.text string
Confidence of invoice ID
 InvoiceId.confidence float

How confident the model is in its prediction.
Invoice total (text)
 InvoiceTotal.text string

Returns invoice total as written on the invoice.
Invoice total (number)
 InvoiceTotal.valueNumber number

Formatted as a number. Example: 1234.98.
Confidence of invoice total
 InvoiceTotal.confidence float

How confident the model is in its prediction.
Previous unpaid balance (text)
 PreviousUnpaidBalance.text string

Returns previous unpaid balance as written on the invoice.
Previous unpaid balance (number)
 PreviousUnpaidBalance.valueNumber number

Formatted as a number. Example: 1234.98.
Confidence of previous unpaid balance
 PreviousUnpaidBalance.confidence float

How confident the model is in its prediction.
Purchase order
 PurchaseOrder.text string
Confidence of purchase order
 PurchaseOrder.confidence float

How confident the model is in its prediction.
Remittance address
 RemittanceAddress.text string
Confidence of remittance address
 RemittanceAddress.confidence float

How confident the model is in its prediction.
Remittance address recipient
 RemittanceAddressRecipient.text string
Confidence of remittance address recipient
 RemittanceAddressRecipient.confidence float

How confident the model is in its prediction.
Service address
 ServiceAddress.text string
Confidence of service address
 ServiceAddress.confidence float

How confident the model is in its prediction.
Service address recipient
 ServiceAddressRecipient.text string
Confidence of service address recipient
 ServiceAddressRecipient.confidence float

How confident the model is in its prediction.
Service end date (text)
 ServiceEndDate.text string

Returns service end date as written on the invoice.
Service end date (date)
 ServiceEndDate.valueDate date

Formatted as a date. Example: 2019-05-31.
Confidence of service end date
 ServiceEndDate.confidence float

How confident the model is in its prediction.
Service start date (text)
 ServiceStartDate.text string

Returns service start date as written on the invoice.
Service start date (date)
 ServiceStartDate.valueDate date

Formatted as a date. Example: 2019-05-31.
Confidence of service start date
 ServiceStartDate.confidence float

How confident the model is in its prediction.
Shipping address
 ShippingAddress.text string
Confidence of shipping address
 ShippingAddress.confidence float

How confident the model is in its prediction.
Shipping address recipient
 ShippingAddressRecipient.text string
Confidence of shipping address recipient
 ShippingAddressRecipient.confidence float

How confident the model is in its prediction.
Subtotal (text)
 SubTotal.text string

Returns subtotal as written on the invoice.
Subtotal (number)
 SubTotal.valueNumber number

Formatted as a number. Example: 1234.98.
Confidence of subtotal
 SubTotal.confidence float

How confident the model is in its prediction.
Total tax (text)
 TotalTax.text string

Returns total tax as written on the invoice.
Total tax (number)
 TotalTax.valueNumber number

Formatted as a number. Example: 1234.98.
Confidence of total tax
 TotalTax.confidence float

How confident the model is in its prediction.
Vendor address
 VendorAddress.text string
Confidence of vendor address
 VendorAddress.confidence float

How confident the model is in its prediction.
Vendor address recipient
 VendorAddressRecipient.text string
Confidence of vendor address recipient
 VendorAddressRecipient.confidence float

How confident the model is in its prediction.
Vendor name
 VendorName.text string
Confidence of vendor name
 VendorName.confidence float

How confident the model is in its prediction.
Items
 Items.valueArray array of object

Array of line items
Amount (text)
 Items.valueArray.valueObject.Amount.text string

Returns amount as written on the invoice.
Amount (number)
 Items.valueArray.valueObject.Amount.valueNumber number

Formatted as a number. Example: 12.
Confidence of amount
 Items.valueArray.valueObject.Amount.confidence float

How confident the model is in its prediction.
Description
 Items.valueArray.valueObject.Description.text string
Confidence of description
 Items.valueArray.valueObject.Description.confidence float

How confident the model is in its prediction.
Quantity (text)
 Items.valueArray.valueObject.Quantity.text string

Returns quantity as written on the invoice.
Quantity (number)
 Items.valueArray.valueObject.Quantity.valueNumber number

Formatted as a number. Example: 12.
Confidence of quantity
 Items.valueArray.valueObject.Quantity.confidence float

How confident the model is in its prediction.
Unit price (text)
 Items.valueArray.valueObject.UnitPrice.text string

Returns unit price as written on the invoice.
Unit price (number)
 Items.valueArray.valueObject.UnitPrice.valueNumber number

Formatted as a number. Example: 12.
Confidence of unit price
 Items.valueArray.valueObject.UnitPrice.confidence float

How confident the model is in its prediction.
Product code
 Items.valueArray.valueObject.ProductCode.text string
Confidence of product code
 Items.valueArray.valueObject.ProductCode.confidence float

How confident the model is in its prediction.
Unit
 Items.valueArray.valueObject.Unit.text string
Confidence of unit
 Items.valueArray.valueObject.Unit.confidence float

How confident the model is in its prediction.
Date (text)
 Items.valueArray.valueObject.Date.text string

Returns date as written on the invoice.
Date (date)
 Items.valueArray.valueObject.Date.valueDate date

Formatted as a date. Example: 2019-05-31.
Confidence of date
 Items.valueArray.valueObject.Date.confidence float

How confident the model is in its prediction.
Tax (text)
 Items.valueArray.valueObject.Tax.text string

Returns tax as written on the invoice.
Tax (number)
 Items.valueArray.valueObject.Tax.valueNumber number

Formatted as a number. Example: 12.
Confidence of tax
 Items.valueArray.valueObject.Tax.confidence float

How confident the model is in its prediction.

BusinessCardFields

BusinessCard fields for 2.1.

Name Path Type Description
Contact names
 ContactNames.valueArray array of object

Array of contact names
First name
 ContactNames.valueArray.valueObject.FirstName.text string
Confidence of first name
 ContactNames.valueArray.valueObject.FirstName.confidence float

How confident the model is in its prediction.
Last name
 ContactNames.valueArray.valueObject.LastName.text string
Confidence of last name
 ContactNames.valueArray.valueObject.LastName.confidence float

How confident the model is in its prediction.
Company names
 CompanyNames.valueArray array of object

Array of company names
Company name
 CompanyNames.valueArray.text string
Confidence of company name
 CompanyNames.valueArray.confidence float

How confident the model is in its prediction.
Departments
 Departments.valueArray array of object

Array of departments
Department
 Departments.valueArray.text string
Confidence of department
 Departments.valueArray.confidence float

How confident the model is in its prediction.
Job titles
 JobTitles.valueArray array of object

Array of job titles
Job title
 JobTitles.valueArray.text string
Confidence of job title
 JobTitles.valueArray.confidence float

How confident the model is in its prediction.
Emails
 Emails.valueArray array of object

Array of emails
Email
 Emails.valueArray.text string
Confidence of email
 Emails.valueArray.confidence float

How confident the model is in its prediction.
Websites
 Websites.valueArray array of object

Array of websites
Website
 Websites.valueArray.text string
Confidence of website
 Websites.valueArray.confidence float

How confident the model is in its prediction.
Addresses
 Addresses.valueArray array of object

Array of addresses
Address
 Addresses.valueArray.text string
Confidence of address
 Addresses.valueArray.confidence float

How confident the model is in its prediction.
Mobile phones
 MobilePhones.valueArray array of object

Array of mobile phones
Mobile phone
 MobilePhones.valueArray.text string
Confidence of mobile phone
 MobilePhones.valueArray.confidence float

How confident the model is in its prediction.
Faxes
 Faxes.valueArray array of object

Array of faxes
Fax
 Faxes.valueArray.text string
Confidence of fax
 Faxes.valueArray.confidence float

How confident the model is in its prediction.
Work phones
 WorkPhones.valueArray array of object

Array of work phones
Work phone
 WorkPhones.valueArray.text string
Confidence of work phone
 WorkPhones.valueArray.confidence float

How confident the model is in its prediction.
Other phones
 OtherPhones.valueArray array of object

Array of other phones
Other phone
 OtherPhones.valueArray.text string
Confidence of other phone
 OtherPhones.valueArray.confidence float

How confident the model is in its prediction.

ReceiptFields

Receiptfields for 2.1.

Name Path Type Description
Receipt type
 ReceiptType.text string
Confidence of receipt type
 ReceiptType.confidence float

How confident the model is in its prediction.
Merchant name
 MerchantName.text string
Confidence of merchant name
 MerchantName.confidence float

How confident the model is in its prediction.
Merchant phone number
 MerchantPhoneNumber.text string
Confidence of merchant phone number
 MerchantPhoneNumber.confidence float

How confident the model is in its prediction.
Merchant address
 MerchantAddress.text string
Confidence of merchant address
 MerchantAddress.confidence float

How confident the model is in its prediction.
Transaction date (text)
 TransactionDate.text string

Returns transaction date as written on the invoice.
Transaction date (date)
 TransactionDate.valueDate date

Formatted as a date. Example: 2019-05-31.
Confidence of transaction date
 TransactionDate.confidence float

How confident the model is in its prediction.
Transaction time (text)
 TransactionTime.text string

Returns transaction time as written on the invoice.
Transaction time (time)
 TransactionTime.valueDate time

Formatted as a date. Example: 2019-05-31.
Confidence of transaction time
 TransactionTime.confidence float

How confident the model is in its prediction.
Total (text)
 Total.text string

Returns total as written on the invoice.
Total (number)
 Total.valueNumber number

Formatted as a number. Example: 1234.98.
Confidence of total
 Total.confidence float

How confident the model is in its prediction.
Subtotal (text)
 Subtotal.text string

Returns subtotal as written on the invoice.
Subtotal (number)
 Subtotal.valueNumber number

Formatted as a number. Example: 1234.98.
Confidence of subtotal
 Subtotal.confidence float

How confident the model is in its prediction.
Tax (text)
 Tax.text string

Returns tax as written on the invoice.
Tax (number)
 Tax.valueNumber number

Formatted as a number. Example: 1234.98.
Confidence of tax
 Tax.confidence float

How confident the model is in its prediction.
Tip (text)
 Tip.text string

Returns tip as written on the invoice.
Tip (number)
 Tip.valueNumber number

Formatted as a number. Example: 1234.98.
Confidence of tip
 Tip.confidence float

How confident the model is in its prediction.
Items
 Items.valueArray array of object

Array of line items
Name
 Items.valueArray.valueObject.Name.text string
Confidence of name
 Items.valueArray.valueObject.Name.confidence float

How confident the model is in its prediction.
Quantity (text)
 Items.valueArray.valueObject.Quantity.text string

Returns quantity as written on the invoice.
Quantity (number)
 Items.valueArray.valueObject.Quantity.valueNumber number

Formatted as a number. Example: 12.
Confidence of quantity
 Items.valueArray.valueObject.Quantity.confidence float

How confident the model is in its prediction.
Price (text)
 Items.valueArray.valueObject.Price.text string

Returns price as written on the invoice.
Price (number)
 Items.valueArray.valueObject.Price.valueNumber number

Formatted as a number. Example: 12.
Confidence of price
 Items.valueArray.valueObject.Price.confidence float

How confident the model is in its prediction.
Total price (text)
 Items.valueArray.valueObject.TotalPrice.text string

Returns total price as written on the invoice.
Total price (number)
 Items.valueArray.valueObject.TotalPrice.valueNumber number

Formatted as a number. Example: 12.
Confidence of total price
 Items.valueArray.valueObject.TotalPrice.confidence float

How confident the model is in its prediction.

IdFields

ID Document fields for 2.1.

Name Path Type Description
Country Region
 CountryRegion.valueCountryRegion string
Confidence of Country Region
 CountryRegion.confidence float

How confident the model is in its prediction.
Date of expiration
 DateOfExpiration.text string

Returns date of expiration as written on the invoice.
Date of expiration (date)
 DateOfExpiration.valueDate date

Formatted as a date. Example: 2019-05-31.
Confidence of date of expiration
 DateOfExpiration.confidence float

How confident the model is in its prediction.
Date of birth (text)
 DateOfBirth.text string

Returns date of birth as written on the invoice.
Date of birth (date)
 DateOfBirth.valueDate date

Formatted as a date. Example: 2019-05-31.
Confidence of date of birth
 DateOfBirth.confidence float

How confident the model is in its prediction.
Document number
 DocumentNumber.text string
Confidence of document number
 DocumentNumber.confidence float

How confident the model is in its prediction.
First name
 FirstName.text string
Confidence of first name
 FirstName.confidence float

How confident the model is in its prediction.
Last name
 LastName.text string
Confidence of last name
 LastName.confidence float

How confident the model is in its prediction.
Nationality
 Nationality.valueCountryRegion string
Confidence of nationality
 Nationality.confidence float

How confident the model is in its prediction.
Sex
 Sex.text string
Confidence of sex
 Sex.confidence float

How confident the model is in its prediction.
Machine readable zone
 MachineReadableZone.text string
Confidence of machine readable zone
 MachineReadableZone.confidence float

How confident the model is in its prediction.
Document type
 DocumentType.text string
Confidence of document type
 DocumentType.confidence float

How confident the model is in its prediction.
Address
 Address.text string
Confidence of address
 Address.confidence float

How confident the model is in its prediction.
Region
 Region.text string
Confidence of region
 Region.confidence float

How confident the model is in its prediction.

FieldValue

Predicted field value object.

Name Path Type Description
type
 type FieldValueType

Semantic data type of the field value.
valueString
 valueString string

String value.
valueDate
 valueDate date-time

Date value.
valueTime
 valueTime date-time

Time value.
valuePhoneNumber
 valuePhoneNumber string

Phone number value.
valueNumber
 valueNumber number

Floating point value.
valueInteger
 valueInteger integer

Integer value.
text
 text string
boundingBox
 boundingBox BoundingBox

Quadrangle bounding box, with coordinates specified relative to the top-left of the original image. The eight numbers represent the four points, clockwise from the top-left corner relative to the text orientation. For image, the (x, y) coordinates are measured in pixels. For PDF, the (x, y) coordinates are measured in inches.
confidence
 confidence Confidence

Confidence value.
elements
 elements array of ElementReference

When includeTextDetails is set to true, a list of references to the text elements constituting this field.
page
 page integer

The 1-based page number in the input document.

FieldValueType

Semantic data type of the field value.

Semantic data type of the field value.

string

Confidence

Confidence value.

Confidence value.

float