document-understanding
latest
false
- Overview
- Getting started
- Building models
- Consuming models
- ML packages
- 1040 - document type
- 1040 Schedule C - document type
- 1040 Schedule D - document type
- 1040 Schedule E - document type
- 1040x - document type
- 3949a - document type
- 4506T - document type
- 709 - document type
- 941x - document type
- 9465 - document type
- ACORD125 - document type
- ACORD126 - document type
- ACORD131 - document type
- ACORD140 - document type
- ACORD25 - document type
- Bank Statements - document type
- Bills Of Lading - document type
- Certificate of Incorporation - document type
- Certificate of Origin - document type
- Checks - document type
- Children Product Certificate - document type
- CMS 1500 - document type
- EU Declaration of Conformity - document type
- Financial Statements - document type
- FM1003 - document type
- I9 - document type
- ID Cards - document type
- Invoices - document type
- Invoices Australia - document type
- Invoices China - document type
- Invoices Hebrew - document type
- Invoices India - document type
- Invoices Japan - document type
- Invoices Shipping - document type
- Packing Lists - document type
- Payslips - document type
- Passports - document type
- Purchase Orders - document type
- Receipts - document type
- Remittance Advices - document type
- UB04 - document type
- Utility Bills - document type
- Vehicle Titles - document type
- W2 - document type
- W9 - document type
- Public endpoints
- Supported languages
- Data and security
- Licensing and Charging Logic
- How to
- Troubleshooting
Document Understanding User Guide
Last updated May 8, 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 - document type - Preview | |
| W2 | |
| W9 | |
| ACORD125 | |
| I9 | |
| - Preview | |
| 4506T | |
| ACORD25 | |
| 1040 | |
| 1040 Schedule C - document type - Preview | |
| 1040 Schedule D - document type - Preview | |
| 1040 Schedule E - document type - 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.
