document-understanding
latest
false
- Overview
- Getting started
- Activities
- Insights dashboards
- Document Understanding Process
- Quickstart tutorials
- Framework components
- ML packages
- Overview
- Document Understanding - ML package
- DocumentClassifier - ML package
- ML packages with OCR capabilities
- 1040 - ML package
- 1040 Schedule C - ML package
- 1040 Schedule D - ML package
- 1040 Schedule E - ML package
- 1040x - ML package
- 3949a - ML package
- 4506T - ML package
- 709 - ML package
- 941x - ML package
- 9465 - ML package
- ACORD125 - ML package
- ACORD126 - ML package
- ACORD131 - ML package
- ACORD140 - ML package
- ACORD25 - ML package
- Bank Statements - ML package
- Bills Of Lading - ML package
- Certificate of Incorporation - ML package
- Certificate of Origin - ML package
- Checks - ML package
- Children Product Certificate - ML package
- CMS 1500 - ML package
- EU Declaration of Conformity - ML package
- Financial Statements - ML package
- FM1003 - ML package
- I9 - ML package
- ID Cards - ML package
- Invoices - ML package
- Invoices Australia - ML package
- Invoices China - ML package
- Invoices Hebrew - ML package
- Invoices India - ML package
- Invoices Japan - ML package
- Invoices Shipping - ML package
- Packing Lists - ML package
- Payslips - ML package
- Passports - ML package
- Purchase Orders - ML package
- Receipts - ML Package
- Remittance Advices - ML package
- UB04 - ML package
- Utility Bills - ML package
- Vehicle Titles - ML package
- W2 - ML package
- W9 - ML package
- Other Out-of-the-box ML Packages
- Public endpoints
- Traffic limitations
- OCR Configuration
- Pipelines
- OCR services
- Supported languages
- Deep Learning
- Data and security
- Licensing
Document Understanding User Guide
Last updated Apr 17, 2025
Public endpoints
Depending on your license which is verified based on your API key, there are two types of limitations available for each ML
package:
- Community licensed traffic - The size of documents that can be extracted is limited to 2 pages and 4MB and there is a rate-limiting per account at 50
requests per hour. When an account reaches the rate limit, the server responds with
429 - Too Many Requestserror status. Community Edition license of Document Understanding has no quantity displayed on the Licenses page within the Document UnderstandingTM section. - Enterprise licensed traffic - The consumption entitlement is displayed as a number of pages on the Licenses page within the Document
UnderstandingTM section. The size of documents that can be extracted is limited per page to 20 megapixels and 10MB, in
JSON-Base64format.
Note: Public extraction endpoints (endpoints containing
/ie,
for example Invoices, https://du.uipath.com/ie/invoices)
only work with documents that have up to 30 pages (or 30MB
payload in total).
Note: The Predict functionality for Document Manager in classic projects and prelabeling for
Build in modern projects rely on UiPath DocPath, but only for tenants based in the
Europe region. If your tenant is located in a region outside of Europe, these
functionalities use the previous-generation model architecture.
Note: The following
table lists public endpoint URLs for each region applicable to different models. Keep in
mind the following specifics:
- All public endpoints are available across all regions.
- Public endpoints for extraction
models in West Europe are based on DocPath, except for the following:
- 9465
- Financial Statements
- Invoices China
- Invoices Hebrew
- Invoices Japan
- Receipts Japan
- The following public endpoints
are based on DocPath in the Japan region:
- Invoices China
- Invoices Japan
- Receipts Japan
- FormExtractor and IntelligentKeywordClassifier are not available in GXP_EU, GXP_US regions.
Public endpoints are available in multiple regions. Select Expand Table for a full, scrollable list, and make sure you connect your activity to the correct endpoint according to each server region.
| Public endpoint | West Europe | USA | Japan | Australia | Canada | India | United Kingdom | Singapore | GXP_US | GXP_EU |
|---|---|---|---|---|---|---|---|---|---|---|
| UiPathDocumentOCR |
|
|
|
|
|
|
|
|
|
|
| Uipath Extended Languages OCR |
|
|
|
|
|
|
|
|
|
|
| ChineseJapaneseKoreanOCR Note: Deprecated and will be
removed from use. Use the UiPath Extended Languages OCR public
endpoint instead.
|
|
|
|
|
|
|
|
|
|
|
| Invoices |
|
|
|
|
|
|
|
|
|
|
| InvoicesIndia |
|
|
|
|
|
|
|
|
|
|
| InvoicesJapan |
|
|
|
|
|
|
|
|
|
|
| InvoicesChina |
|
|
|
|
|
|
|
|
|
|
| Invoices Hebrew - ML package - Preview |
|
|
|
|
|
|
|
|
|
|
| Invoices Shipping |
|
|
|
|
|
|
|
|
|
|
| Receipts |
|
|
|
|
|
|
|
|
|
|
| Receipts Japan
Note: Only
available as a public endpoint.
| N/A | N/A |
| N/A | N/A | N/A | N/A | N/A | N/A | N/A |
| PurchaseOrders |
|
|
|
|
|
|
|
|
|
|
| UtilityBills |
|
|
|
|
|
|
|
|
|
|
| IDCards |
|
|
|
|
|
|
|
|
|
|
| Passports |
|
|
|
|
|
|
|
|
|
|
| Pay slips |
|
|
|
|
|
|
|
|
|
|
| ML Classification |
|
|
|
|
|
|
|
|
|
|
| RemittanceAdvices |
|
|
|
|
|
|
|
|
|
|
| BillsOfLading |
|
|
|
|
|
|
|
|
|
|
| UB04 - ML package - Preview |
|
|
|
|
|
|
|
|
|
|
| W2 |
|
|
|
|
|
|
|
|
|
|
| W9 |
|
|
|
|
|
|
|
|
|
|
| ACORD125 |
|
|
|
|
|
|
|
|
|
|
| I9 |
|
|
|
|
|
|
|
|
|
|
| 709 - ML package - Preview |
|
|
|
|
|
|
|
|
|
|
| 941x - ML package - Preview |
|
|
|
|
|
|
|
|
|
|
| 3949a - ML package - Preview |
|
|
|
|
|
|
|
|
|
|
| 4506T |
|
|
|
|
|
|
|
|
|
|
| 9465 - ML package - Preview |
|
|
|
|
|
|
|
|
|
|
| ACORD25 |
|
|
|
|
|
|
|
|
|
|
| 1040 |
|
|
|
|
|
|
|
|
|
|
| 1040 Schedule C - ML package - Preview |
|
|
|
|
|
|
|
|
|
|
| 1040 Schedule D - ML package - Preview |
|
|
|
|
|
|
|
|
|
|
| 1040 Schedule E - ML package - Preview |
|
|
|
|
|
|
|
|
|
|
| 1040x - ML package - Preview |
|
|
|
|
|
|
|
|
|
|
| Checks |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
|
|
|
|
|
|
|
|
|
| |
|
|
|
|
|
|
|
|
|
| |
|
|
|
|
|
|
|
|
|
| |
|
|
|
|
|
|
|
|
|
| |
| BankStatements |
|
|
|
|
|
|
|
|
|
|
| FinancialStatements |
|
|
|
|
|
|
|
|
|
|
| PackingLists |
|
|
|
|
|
|
|
|
|
|
| Acord131 |
|
|
|
|
|
|
|
|
|
|
| Acord140 |
|
|
|
|
|
|
|
|
|
|
| VehicleTitles |
|
|
|
|
|
|
|
|
|
|
| Acord126 |
|
|
|
|
|
|
|
|
|
|
| FM1003 - Preview |
|
|
|
|
|
|
|
|
|
|
| FormExtractor |
|
|
|
|
|
|
|
| N/A | N/A |
| IntelligentKeywordClassifier |
|
|
|
|
|
|
|
| N/A | N/A |
Important: Having an Enterprise licensing plan on your Automation CloudTM does not imply that you have access to the Enterprise licensed traffic for Document Understanding. Access to the Enterprise
licensed traffic is subject to a different, separate license.
You can retrieve document type information for out-of-the-box extraction models, such as invoices, receipts, passports, and others, using the Discovery APIs from Swagger.
- Create an external application in your cloud
organization, that uses Document
UnderstandingTM as
Resource.
Visit Managing external applications to learn how to add and configure an external application.
- Depending on the information that you want to retrieve, you must add one of the following application scopes to the external
application:
- Du.Digitization.Api
- Du.Classification.Api
- Du.Extraction.Api
- Du.Validation.Api
Remember your App ID and Secret ID, because you will use these to log in to Swagger.
Visit Managing external applications to learn how to create and configure an external application.
- To access the APIs in Swagger, go to the toolbar of the Document UnderstandingTM service, search the REST APIs dropdown, and select Framework.
- In Swagger, select Authorize, and log in with the App ID (Client ID) and Secret ID (Client secret) of the previously created external application.
- Depending on your use case, try out the following APIs:
GET/projects/{projectId}/document-types/{documentTypeId}: Retrieve details about a specific document type.GET/projects/{projectId}/classifiers/{classifierId}: Retrieve details about a specific classifier.GET/projects/{projectId}/extractors/{extractorId}: Retrieve details about a specific extractor.
