document-understanding
latest
false
UiPath logo, featuring letters U and I in white
Document Understanding Modern Projects User Guide
Automation CloudAutomation Cloud Public SectorAutomation SuiteStandalone
Last updated Nov 14, 2024

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 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-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 endpointWest Europe

Australia

USA

Canada

Japan

Singapore

United KingdomIndia
UiPathDocumentOCR 
https://du.uipath.com/ocrhttps://du.uipath.com/ocr
 
https://du-au.uipath.com/ocrhttps://du-au.uipath.com/ocr
 
https://du-us.uipath.com/ocrhttps://du-us.uipath.com/ocr
 
https://du-ca.uipath.com/ocrhttps://du-ca.uipath.com/ocr
 
https://du-jp.uipath.com/ocrhttps://du-jp.uipath.com/ocr
 
https://du-sg.uipath.com/ocrhttps://du-sg.uipath.com/ocr
 
https://du-uk.uipath.com/ocrhttps://du-uk.uipath.com/ocr
 
https://du-uk.uipath.com/ocrhttps://du-uk.uipath.com/ocr
UiPath Extended Languages OCR 
https://du.uipath.com/extended-ocrhttps://du.uipath.com/extended-ocr
N/AN/AN/A 
https://du-jp.uipath.com/extended-ocrhttps://du-jp.uipath.com/extended-ocr
 
https://du-sg.uipath.com/extended-ocrhttps://du-sg.uipath.com/extended-ocr
N/AN/A
ChineseJapaneseKoreanOCR 
https://du.uipath.com/cjk-ocrhttps://du.uipath.com/cjk-ocr

N/A

N/A

N/A

 
https://du-jp.uipath.com/cjk-ocrhttps://du-jp.uipath.com/cjk-ocr
 
https://du-sg.uipath.com/cjk-ocrhttps://du-sg.uipath.com/cjk-ocr
N/AN/A
Invoices 
https://du.uipath.com/ie/invoiceshttps://du.uipath.com/ie/invoices
N/AN/AN/AN/AN/A 
https://du-uk.uipath.com/ie/invoiceshttps://du-uk.uipath.com/ie/invoices
 
https://du-uk.uipath.com/ie/invoiceshttps://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_auhttps://du.uipath.com/ie/invoices_au
N/AN/AN/AN/AN/AN/AN/A
InvoicesIndia 
https://du.uipath.com/ie/invoices_indiahttps://du.uipath.com/ie/invoices_india
N/AN/AN/AN/AN/AN/AN/A
InvoicesJapan 
https://du.uipath.com/ie/invoices_japanhttps://du.uipath.com/ie/invoices_japan
N/AN/AN/AN/AN/AN/AN/A
InvoicesChina 
https://du.uipath.com/ie/invoices_chinahttps://du.uipath.com/ie/invoices_china
N/AN/AN/AN/AN/AN/AN/A
Invoices Hebrew - ML package - Preview 
https://du.uipath.com/ie/invoices_hebrewhttps://du.uipath.com/ie/invoices_hebrew
N/AN/AN/AN/AN/AN/AN/A
Invoices Shipping 
https://du.uipath.com/ie/invoices_shippinghttps://du.uipath.com/ie/invoices_shipping
N/AN/AN/AN/AN/AN/AN/A
Receipts 
https://du.uipath.com/ie/receiptshttps://du.uipath.com/ie/receipts
N/AN/AN/AN/AN/AN/AN/A
PurchaseOrders 
https://du.uipath.com/ie/purchase_ordershttps://du.uipath.com/ie/purchase_orders
N/AN/AN/AN/AN/AN/AN/A
UtilityBills 
https://du.uipath.com/ie/utility_billshttps://du.uipath.com/ie/utility_bills
N/AN/AN/AN/AN/AN/AN/A
IDCards 
https://du.uipath.com/ie/id_cardshttps://du.uipath.com/ie/id_cards
N/AN/AN/AN/AN/AN/AN/A
Passports 
https://du.uipath.com/ie/passportshttps://du.uipath.com/ie/passports
N/AN/AN/AN/AN/AN/AN/A
Pay slips 
https://du.uipath.com/ie/payslipshttps://du.uipath.com/ie/payslips
N/AN/AN/AN/AN/AN/AN/A
RemittanceAdvices 
https://du.uipath.com/ie/remittance_adviceshttps://du.uipath.com/ie/remittance_advices
N/AN/AN/AN/AN/AN/AN/A
BillsOfLading 
https://du.uipath.com/ie/bills_of_ladinghttps://du.uipath.com/ie/bills_of_lading
N/AN/AN/AN/AN/AN/AN/A
UB04 - ML package - Preview 
https://du.uipath.com/ie/ub04https://du.uipath.com/ie/ub04
N/AN/AN/AN/AN/AN/AN/A
W2 
https://du.uipath.com/ie/w2https://du.uipath.com/ie/w2
N/AN/AN/AN/AN/AN/AN/A
W9 
https://du.uipath.com/ie/w9https://du.uipath.com/ie/w9
N/AN/AN/AN/AN/AN/AN/A
ACORD125 
https://du.uipath.com/ie/acord125https://du.uipath.com/ie/acord125
N/AN/AN/AN/AN/AN/AN/A
I9 
https://du.uipath.com/ie/i9https://du.uipath.com/ie/i9
N/AN/AN/AN/AN/AN/AN/A
709 - ML package - Preview 
https://du.uipath.com/ie/709https://du.uipath.com/ie/709
N/AN/AN/AN/AN/AN/AN/A
941x - ML package - Preview 
https://du.uipath.com/ie/941xhttps://du.uipath.com/ie/941x
N/AN/AN/AN/AN/AN/AN/A
3949a - ML package - Preview 
https://du.uipath.com/ie/3949ahttps://du.uipath.com/ie/3949a
N/AN/AN/AN/AN/AN/AN/A
4506T 
https://du.uipath.com/ie/4506thttps://du.uipath.com/ie/4506t
N/AN/AN/AN/AN/AN/AN/A
9465 - ML package - Preview 
https://du.uipath.com/ie/9465https://du.uipath.com/ie/9465
N/AN/AN/AN/AN/AN/AN/A
ACORD25 
https://du.uipath.com/ie/acord25https://du.uipath.com/ie/acord25
N/AN/AN/AN/AN/AN/AN/A
1040 
https://du.uipath.com/ie/1040https://du.uipath.com/ie/1040
N/AN/AN/AN/AN/AN/AN/A
1040 Schedule C - ML package - Preview 
https://du.uipath.com/ie/1040_schedule_chttps://du.uipath.com/ie/1040_schedule_c
N/AN/AN/AN/AN/AN/AN/A
1040 Schedule D - ML package - Preview 
https://du.uipath.com/ie/1040_schedule_dhttps://du.uipath.com/ie/1040_schedule_d
N/AN/AN/AN/AN/AN/AN/A
1040 Schedule E - ML package - Preview 
https://du.uipath.com/ie/1040_schedule_ehttps://du.uipath.com/ie/1040_schedule_e
N/AN/AN/AN/AN/AN/AN/A
1040x - ML package - Preview 
https://du.uipath.com/ie/1040xhttps://du.uipath.com/ie/1040x
N/AN/AN/AN/A N/AN/A
Checks 
https://du.uipath.com/ie/checkshttps://du.uipath.com/ie/checks
N/AN/AN/AN/AN/AN/AN/A
https://du.uipath.com/ie/certificates_incorporationhttps://du.uipath.com/ie/certificates_incorporation
N/AN/AN/AN/AN/AN/AN/A
https://du.uipath.com/ie/certificates_originhttps://du.uipath.com/ie/certificates_origin
N/AN/AN/AN/AN/AN/AN/A
https://du.uipath.com/ie/children_product_certificateshttps://du.uipath.com/ie/children_product_certificates
N/AN/AN/AN/AN/AN/AN/A
https://du.uipath.com/ie/cms1500https://du.uipath.com/ie/cms1500
N/AN/AN/AN/AN/AN/AN/A
https://du.uipath.com/ie/eu_declaration_conformityhttps://du.uipath.com/ie/eu_declaration_conformity
N/AN/AN/AN/AN/AN/AN/A
BankStatements 
https://du.uipath.com/ie/bank_statementshttps://du.uipath.com/ie/bank_statements
N/AN/AN/AN/AN/AN/AN/A
FinancialStatements 
https://du.uipath.com/ie/financial_statementshttps://du.uipath.com/ie/financial_statements
N/AN/AN/AN/AN/AN/AN/A
PackingLists 
https://du.uipath.com/ie/packing_listshttps://du.uipath.com/ie/packing_lists
N/AN/AN/AN/AN/AN/AN/A
Acord131 
https://du.uipath.com/ie/acord131https://du.uipath.com/ie/acord131
N/AN/AN/AN/AN/AN/AN/A
Acord140 
https://du.uipath.com/ie/acord140https://du.uipath.com/ie/acord140
N/AN/AN/AN/AN/AN/AN/A
VehicleTitles 
https://du.uipath.com/ie/vehicle_titleshttps://du.uipath.com/ie/vehicle_titles
N/AN/AN/AN/AN/AN/AN/A
Acord126 
https://du.uipath.com/ie/acord126https://du.uipath.com/ie/acord126
N/AN/AN/AN/AN/AN/AN/A
FM1003 - Preview 
https://du.uipath.com/ie/fm1003https://du.uipath.com/ie/fm1003
N/AN/AN/AN/A

N/A

N/AN/A
FormExtractor 
https://du.uipath.com/svc/formextractorhttps://du.uipath.com/svc/formextractor
 
https://du-au.uipath.com/svc/formextractorhttps://du-au.uipath.com/svc/formextractor
 
https://du-us.uipath.com/svc/formextractorhttps://du-us.uipath.com/svc/formextractor
 
https://du-ca.uipath.com/svc/formextractorhttps://du-ca.uipath.com/svc/formextractor
 
https://du-jp.uipath.com/svc/formextractorhttps://du-jp.uipath.com/svc/formextractor
 
https://du-sg.uipath.com/svc/formextractorhttps://du-sg.uipath.com/svc/formextractor
N/AN/A
IntelligentKeywordClassifier 
https://du.uipath.com/svc/intelligentkeywordshttps://du.uipath.com/svc/intelligentkeywords
 
https://du-au.uipath.com/svc/intelligentkeywordshttps://du-au.uipath.com/svc/intelligentkeywords
 
https://du-us.uipath.com/svc/intelligentkeywordshttps://du-us.uipath.com/svc/intelligentkeywords
 
https://du-ca.uipath.com/svc/intelligentkeywordshttps://du-ca.uipath.com/svc/intelligentkeywords
 
https://du-jp.uipath.com/svc/intelligentkeywordshttps://du-jp.uipath.com/svc/intelligentkeywords
 
https://du-sg.uipath.com/svc/intelligentkeywordshttps://du-sg.uipath.com/svc/intelligentkeywords
N/AN/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.

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 UnderstandingTM 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 UnderstandingTM 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.
  • Retrieving document type information with APIs
  • Prerequisites
  • Steps

Was this page helpful?

Support and Services
Get The Help You Need
UiPath Academy
Learning RPA - Automation Courses
UiPath Forum
UiPath Community Forum
Uipath Logo White
Trust and Security
Terms of Use
Privacy Policy
Cookies Policy
© 2005-2024 UiPath. All rights reserved.