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 Requests error status. Community Edition license of Document Understanding has no quantity displayed on the Licenses page within the Document Understanding^TM section.
• Enterprise licensed traffic - The consumption entitlement is displayed as a number of pages on the Licenses page within the Document Understanding^TM section. 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://du.uipath.com/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.

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.

Public endpoint	West Europe	Australia	USA	Canada	Japan	Singapore	United Kingdom	India
UiPathDocumentOCR	https://du.uipath.com/ocr	https://du-au.uipath.com/ocr	https://du-us.uipath.com/ocr	https://du-ca.uipath.com/ocr	https://du-jp.uipath.com/ocr	https://du-sg.uipath.com/ocr	https://du-uk.uipath.com/ocr	https://du-uk.uipath.com/ocr
UiPath Extended Languages OCR	https://du.uipath.com/extended-ocr	N/A	N/A	N/A	https://du-jp.uipath.com/extended-ocr	https://du-sg.uipath.com/extended-ocr	N/A	N/A
ChineseJapaneseKoreanOCR	https://du.uipath.com/cjk-ocr	N/A	N/A	N/A	https://du-jp.uipath.com/cjk-ocr	https://du-sg.uipath.com/cjk-ocr	N/A	N/A
Invoices	https://du.uipath.com/ie/invoices	N/A	N/A	N/A	N/A	N/A	https://du-uk.uipath.com/ie/invoices	https://du-uk.uipath.com/ie/invoices
InvoicesAustralia Note: Deprecated: model has been merged into the Invoices model. See the Invoices model page for details.	https://du.uipath.com/ie/invoices_au	N/A	N/A	N/A	N/A	N/A	N/A	N/A
InvoicesIndia	https://du.uipath.com/ie/invoices_india	N/A	N/A	N/A	N/A	N/A	N/A	N/A
InvoicesJapan	https://du.uipath.com/ie/invoices_japan	N/A	N/A	N/A	https://du-jp.uipath.com/ie/invoices_japan	N/A	N/A	N/A
InvoicesChina	https://du.uipath.com/ie/invoices_china	N/A	N/A	N/A	N/A	N/A	N/A	N/A
Invoices Hebrew - ML package - Preview	https://du.uipath.com/ie/invoices_hebrew	N/A	N/A	N/A	N/A	N/A	N/A	N/A
Invoices Shipping	https://du.uipath.com/ie/invoices_shipping	N/A	N/A	N/A	N/A	N/A	N/A	N/A
Receipts	https://du.uipath.com/ie/receipts	N/A	N/A	N/A	N/A	N/A	N/A	N/A
Receipts Japan	N/A	N/A	N/A	N/A	https://du-jp.uipath.com/ie/receipts_japan	N/A	N/A	N/A
PurchaseOrders	https://du.uipath.com/ie/purchase_orders	N/A	N/A	N/A	N/A	N/A	N/A	N/A
UtilityBills	https://du.uipath.com/ie/utility_bills	N/A	N/A	N/A	N/A	N/A	N/A	N/A
IDCards	https://du.uipath.com/ie/id_cards	N/A	N/A	N/A	N/A	N/A	N/A	N/A
Passports	https://du.uipath.com/ie/passports	N/A	N/A	N/A	N/A	N/A	N/A	N/A
Pay slips	https://du.uipath.com/ie/payslips	N/A	N/A	N/A	N/A	N/A	N/A	N/A
RemittanceAdvices	https://du.uipath.com/ie/remittance_advices	N/A	N/A	N/A	N/A	N/A	N/A	N/A
BillsOfLading	https://du.uipath.com/ie/bills_of_lading	N/A	N/A	N/A	N/A	N/A	N/A	N/A
UB04 - ML package - Preview	https://du.uipath.com/ie/ub04	N/A	N/A	N/A	N/A	N/A	N/A	N/A
W2	https://du.uipath.com/ie/w2	N/A	N/A	N/A	N/A	N/A	N/A	N/A
W9	https://du.uipath.com/ie/w9	N/A	N/A	N/A	N/A	N/A	N/A	N/A
ACORD125	https://du.uipath.com/ie/acord125	N/A	N/A	N/A	N/A	N/A	N/A	N/A
I9	https://du.uipath.com/ie/i9	N/A	N/A	N/A	N/A	N/A	N/A	N/A
709 - ML package - Preview	https://du.uipath.com/ie/709	N/A	N/A	N/A	N/A	N/A	N/A	N/A
941x - ML package - Preview	https://du.uipath.com/ie/941x	N/A	N/A	N/A	N/A	N/A	N/A	N/A
3949a - ML package - Preview	https://du.uipath.com/ie/3949a	N/A	N/A	N/A	N/A	N/A	N/A	N/A
4506T	https://du.uipath.com/ie/4506t	N/A	N/A	N/A	N/A	N/A	N/A	N/A
9465 - ML package - Preview	https://du.uipath.com/ie/9465	N/A	N/A	N/A	N/A	N/A	N/A	N/A
ACORD25	https://du.uipath.com/ie/acord25	N/A	N/A	N/A	N/A	N/A	N/A	N/A
1040	https://du.uipath.com/ie/1040	N/A	N/A	N/A	N/A	N/A	N/A	N/A
1040 Schedule C - ML package - Preview	https://du.uipath.com/ie/1040_schedule_c	N/A	N/A	N/A	N/A	N/A	N/A	N/A
1040 Schedule D - ML package - Preview	https://du.uipath.com/ie/1040_schedule_d	N/A	N/A	N/A	N/A	N/A	N/A	N/A
1040 Schedule E - ML package - Preview	https://du.uipath.com/ie/1040_schedule_e	N/A	N/A	N/A	N/A	N/A	N/A	N/A
1040x - ML package - Preview	https://du.uipath.com/ie/1040x	N/A	N/A	N/A	N/A		N/A	N/A
Checks	https://du.uipath.com/ie/checks	N/A	N/A	N/A	N/A	N/A	N/A	N/A
Certificate of Incorporation/ Good Standing	https://du.uipath.com/ie/certificates_incorporation	N/A	N/A	N/A	N/A	N/A	N/A	N/A
Certificate of Origin	https://du.uipath.com/ie/certificates_origin	N/A	N/A	N/A	N/A	N/A	N/A	N/A
Children Product Certificate	https://du.uipath.com/ie/children_product_certificates	N/A	N/A	N/A	N/A	N/A	N/A	N/A
CMS1500	https://du.uipath.com/ie/cms1500	N/A	N/A	N/A	N/A	N/A	N/A	N/A
EU Declaration of Conformity	https://du.uipath.com/ie/eu_declaration_conformity	N/A	N/A	N/A	N/A	N/A	N/A	N/A
BankStatements	https://du.uipath.com/ie/bank_statements	N/A	N/A	N/A	N/A	N/A	N/A	N/A
FinancialStatements	https://du.uipath.com/ie/financial_statements	N/A	N/A	N/A	N/A	N/A	N/A	N/A
PackingLists	https://du.uipath.com/ie/packing_lists	N/A	N/A	N/A	N/A	N/A	N/A	N/A
Acord131	https://du.uipath.com/ie/acord131	N/A	N/A	N/A	N/A	N/A	N/A	N/A
Acord140	https://du.uipath.com/ie/acord140	N/A	N/A	N/A	N/A	N/A	N/A	N/A
VehicleTitles	https://du.uipath.com/ie/vehicle_titles	N/A	N/A	N/A	N/A	N/A	N/A	N/A
Acord126	https://du.uipath.com/ie/acord126	N/A	N/A	N/A	N/A	N/A	N/A	N/A
FM1003 - Preview	https://du.uipath.com/ie/fm1003	N/A	N/A	N/A	N/A	N/A	N/A	N/A
FormExtractor	https://du.uipath.com/svc/formextractor	https://du-au.uipath.com/svc/formextractor	https://du-us.uipath.com/svc/formextractor	https://du-ca.uipath.com/svc/formextractor	https://du-jp.uipath.com/svc/formextractor	https://du-sg.uipath.com/svc/formextractor	N/A	N/A
IntelligentKeywordClassifier	https://du.uipath.com/svc/intelligentkeywords	https://du-au.uipath.com/svc/intelligentkeywords	https://du-us.uipath.com/svc/intelligentkeywords	https://du-ca.uipath.com/svc/intelligentkeywords	https://du-jp.uipath.com/svc/intelligentkeywords	https://du-sg.uipath.com/svc/intelligentkeywords	N/A	N/A

Important: Having an Enterprise licensing plan on your Automation Cloud^TM 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.

Retrieving document type information with APIs

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.

Prerequisites

1. Create an external application in your cloud organization, that uses Document Understanding^TM as Resource.

   Visit Managing external applications to learn how to add and configure an external application.

2. 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.

Steps

1. To access the APIs in Swagger, go to the toolbar of the Document Understanding^TM service, search the REST APIs dropdown, and select Framework.
2. In Swagger, select Authorize, and log in with the App ID (Client ID) and Secret ID (Client secret) of the previously created external application.
3. 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.