document-understanding
latest
false
- Overview
- Getting started
- Building models
- Consuming models
- ML packages
- 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
- Public endpoints
- Supported languages
- Data and security
- Licensing and Charging Logic
- How to
- Troubleshooting
Document Understanding User Guide
Last updated Apr 10, 2025
Public endpoints
The size of documents that can be extracted is limited per page to 20 megapixels and 10MB, in
JSON-Base64 format.
Note: Public extraction
endpoints (endpoints containing
/ie, for example Invoices,
https://govcloud/uipath.us/du_/ie/invoices) only work
with documents that have up to 30 pages (or 30MB payload in total).
Make sure you connect your activity to the correct endpoint according to each server region.
| Public endpoint | Public Sector |
|---|---|
| UiPathDocumentOCR |
|
| Invoices | |
| InvoicesAustralia Note: Deprecated:
model has been merged into the Invoices model. See the Invoices
model page for details.
| |
| InvoicesIndia | |
| InvoicesJapan | |
| InvoicesChina | |
| Invoices Shipping | |
| Receipts | |
| PurchaseOrders | |
| UtilityBills | |
| IDCards | |
| Passports | |
| Pay slips | |
| RemittanceAdvices | |
| BillsOfLading | |
| UB04 - ML package - Preview | |
| W2 | |
| W9 | |
| ACORD125 | |
| I9 | |
| - Preview | |
| 4506T | |
| ACORD25 | |
| 1040 | |
| 1040 Schedule C - ML package - Preview | |
| 1040 Schedule D - ML package - Preview | |
| 1040 Schedule E - ML package - Preview | |
| Checks | |
| |
| |
| |
| |
| |
| BankStatements | |
| FinancialStatements | |
| PackingLists | |
| Acord131 | |
| Acord140 | |
| VehicleTitles | |
| Acord126 | |
| FM1003 - Preview | |
| FormExtractor | |
| IntelligentKeywordClassifier | |
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 applicationsManaging 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.
