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

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 endpointPublic Sector
UiPathDocumentOCR
https://govcloud.uipath.us/du_/ocrhttps://govcloud.uipath.us/du_/ocr
Invoices
https://govcloud.uipath.us/du_/ie/invoiceshttps://govcloud.uipath.us/du_/ie/invoices
InvoicesAustralia
Note: Deprecated: model has been merged into the Invoices model. See the Invoices model page for details.
https://govcloud.uipath.us/du_/ie/invoices_auhttps://govcloud.uipath.us/du_/ie/invoices_au
InvoicesIndia
https://govcloud.uipath.us/du_/ie/invoices_indiahttps://govcloud.uipath.us/du_/ie/invoices_india
InvoicesJapan
https://govcloud.uipath.us/du_/ie/invoices_japanhttps://govcloud.uipath.us/du_/ie/invoices_japan
InvoicesChina
https://govcloud.uipath.us/du_/ie/invoices_chinahttps://govcloud.uipath.us/du_/ie/invoices_china
Invoices Shipping
https://govcloud.uipath.us/du_/ie/invoices_shippinghttps://govcloud.uipath.us/du_/ie/invoices_shipping
Receipts
https://govcloud.uipath.us/du_/ie/receiptshttps://govcloud.uipath.us/du_/ie/receipts
PurchaseOrders
https://govcloud.uipath.us/du_/ie/purchase_ordershttps://govcloud.uipath.us/du_/ie/purchase_orders
UtilityBills
https://govcloud.uipath.us/du_/ie/utility_billshttps://govcloud.uipath.us/du_/ie/utility_bills
IDCards
https://govcloud.uipath.us/du_/ie/id_cardshttps://govcloud.uipath.us/du_/ie/id_cards
Passports
https://govcloud.uipath.us/du_/ie/passportshttps://govcloud.uipath.us/du_/ie/passports
Pay slips
https://govcloud.uipath.us/du_/ie/payslipshttps://govcloud.uipath.us/du_/ie/payslips
RemittanceAdvices
https://govcloud.uipath.us/du_/ie/remittance_adviceshttps://govcloud.uipath.us/du_/ie/remittance_advices
BillsOfLading
https://govcloud.uipath.us/du_/ie/bills_of_ladinghttps://govcloud.uipath.us/du_/ie/bills_of_lading
UB04 - ML package - Preview
https://govcloud.uipath.us/du_/ie/ub04https://govcloud.uipath.us/du_/ie/ub04
W2
https://govcloud.uipath.us/du_/ie/w2https://govcloud.uipath.us/du_/ie/w2
W9
https://govcloud.uipath.us/du_/ie/w9https://govcloud.uipath.us/du_/ie/w9
ACORD125
https://govcloud.uipath.us/du_/ie/acord125https://govcloud.uipath.us/du_/ie/acord125
I9
https://govcloud.uipath.us/du_/ie/i9https://govcloud.uipath.us/du_/ie/i9
- Preview
https://govcloud.uipath.us/du_/ie/990https://govcloud.uipath.us/du_/ie/990
4506T
https://govcloud.uipath.us/du_/ie/4506thttps://govcloud.uipath.us/du_/ie/4506t
ACORD25
https://govcloud.uipath.us/du_/ie/acord25https://govcloud.uipath.us/du_/ie/acord25
1040
https://govcloud.uipath.us/du_/ie/1040https://govcloud.uipath.us/du_/ie/1040
1040 Schedule C - ML package - Preview
https://govcloud.uipath.us/du_/ie/1040_schedule_chttps://govcloud.uipath.us/du_/ie/1040_schedule_c
1040 Schedule D - ML package - Preview
https://govcloud.uipath.us/du_/ie/1040_schedule_dhttps://govcloud.uipath.us/du_/ie/1040_schedule_d
1040 Schedule E - ML package - Preview
https://govcloud.uipath.us/du_/ie/1040_schedule_ehttps://govcloud.uipath.us/du_/ie/1040_schedule_e
Checks
https://govcloud.uipath.us/du_/ie/checkshttps://govcloud.uipath.us/du_/ie/checks
https://govcloud.uipath.us/du_/ie/certificates_incorporationhttps://govcloud.uipath.us/du_/ie/certificates_incorporation
https://govcloud.uipath.us/du_/ie/certificates_originhttps://govcloud.uipath.us/du_/ie/certificates_origin
https://govcloud.uipath.us/du_/ie/children_product_certificateshttps://govcloud.uipath.us/du_/ie/children_product_certificates
https://govcloud.uipath.us/du_/ie/cms1500https://govcloud.uipath.us/du_/ie/cms1500
https://govcloud.uipath.us/du_/ie/eu_declaration_conformityhttps://govcloud.uipath.us/du_/ie/eu_declaration_conformity
BankStatements
https://govcloud.uipath.us/du_/ie/bank_statementshttps://govcloud.uipath.us/du_/ie/bank_statements
FinancialStatements
https://govcloud.uipath.us/du_/ie/financial_statementshttps://govcloud.uipath.us/du_/ie/financial_statements
PackingLists
https://govcloud.uipath.us/du_/ie/packing_listshttps://govcloud.uipath.us/du_/ie/packing_lists
Acord131
https://govcloud.uipath.us/du_/ie/acord131https://govcloud.uipath.us/du_/ie/acord131
Acord140
https://govcloud.uipath.us/du_/ie/acord140https://govcloud.uipath.us/du_/ie/acord140
VehicleTitles
https://govcloud.uipath.us/du_/ie/vehicle_titleshttps://govcloud.uipath.us/du_/ie/vehicle_titles
Acord126
https://govcloud.uipath.us/du_/ie/acord126https://govcloud.uipath.us/du_/ie/acord126
FM1003 - Preview
https://govcloud.uipath.us/du_/ie/fm1003https://govcloud.uipath.us/du_/ie/fm1003
FormExtractor
https://govcloud.uipath.us/du_/svc/formextractorhttps://govcloud.uipath.us/du_/svc/formextractor
IntelligentKeywordClassifier
https://govcloud.uipath.us/du_/svc/intelligentkeywordshttps://govcloud.uipath.us/du_/svc/intelligentkeywords

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 applicationsManaging 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?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.