Public endpoints
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).
note
The following table lists public endpoint URLs for each region applicable to different models. Keep in mind the following specifics:
- All public endpoints are available across all regions.
- Public endpoints for extraction models in Europe, Japan and the United States are based on the Helix Extractor, except for Financial Statements.
- FormExtractor and IntelligentKeywordClassifier are not available in GXP_EU, GXP_US regions. Public endpoints are available in multiple regions. Select Expand Table for a full, scrollable list, and make sure you connect your activity to the correct endpoint according to each server region.
Public endpoints are available in multiple regions. Select Expand Table for a full, scrollable list, and make sure you connect your activity to the correct endpoint according to each server region.
| Public endpoint | Europe | USA | Japan | Australia | Canada | India | United Kingdom | Singapore | Switzerland | United Arab Emirates | GXP_US | GXP_EU |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| UiPathDocumentOCR | https://du.uipath.com/ocr | https://du-us.uipath.com/ocr | https://du-jp.uipath.com/ocr | https://du-au.uipath.com/ocr | https://du-ca.uipath.com/ocr | https://du-in.uipath.com/ocr | https://du-uk.uipath.com/ocr | https://du-sg.uipath.com/ocr | https://du-sz.uipath.com/ocr | https://du-ua.uipath.com/ocr | https://du-gxp-us.uipath.com/ocr | https://du-gxp-eu.uipath.com/ocr |
| UiPath Extended Languages OCR | https://du.uipath.com/extended-ocr | https://du-us.uipath.com/extended-ocr | https://du-jp.uipath.com/extended-ocr | https://du-au.uipath.com/extended-ocr | https://du-ca.uipath.com/extended-ocr | https://du-in.uipath.com/extended-ocr | https://du-uk.uipath.com/extended-ocr | https://du-sg.uipath.com/extended-ocr | N/A | N/A | https://du-gxp-us.uipath.com/extended-ocr | https://du-gxp-eu.uipath.com/extended-ocr |
| ChineseJapaneseKoreanOCRNote: Deprecated and will be removed from use. Use the UiPath Extended Languages OCR public endpoint instead. | https://du.uipath.com/cjk-ocr | https://du-us.uipath.com/cjk-ocr | https://du-jp.uipath.com/cjk-ocr | https://du-au.uipath.com/cjk-ocr | https://du-ca.uipath.com/cjk-ocr | https://du-in.uipath.com/cjk-ocr | https://du-uk.uipath.com/cjk-ocr | https://du-sg.uipath.com/cjk-ocr | N/A | N/A | https://du-gxp-us.uipath.com/cjk-ocr | https://du-gxp-eu.uipath.com/cjk-ocr |
| Invoices | https://du.uipath.com/ie/invoices | https://du-us.uipath.com/ie/invoices | https://du-jp.uipath.com/ie/invoices | https://du-au.uipath.com/ie/invoices | https://du-ca.uipath.com/ie/invoices | https://du-in.uipath.com/ie/invoices | https://du-uk.uipath.com/ie/invoices | https://du-sg.uipath.com/ie/invoices | https://du-sz.uipath.com/ie/invoices | https://du-ua.uipath.com/ie/invoices | https://du-gxp-us.uipath.com/ie/invoices | https://du-gxp-eu.uipath.com/ie/invoices |
| Invoices2 - Preview Note: Only available as a public endpoint. | https://du.uipath.com/ie/invoices2 | https://du-us.uipath.com/ie/invoices2 | https://du-jp.uipath.com/ie/invoices2 | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A |
| InvoicesIndia | https://du.uipath.com/ie/invoices_india | https://du-us.uipath.com/ie/invoices_india | https://du-jp.uipath.com/ie/invoices_india | https://du-au.uipath.com/ie/invoices_india | https://du-ca.uipath.com/ie/invoices_india | https://du-in.uipath.com/ie/invoices_india | https://du-uk.uipath.com/ie/invoices_india | https://du-sg.uipath.com/ie/invoices_india | https://du-sz.uipath.com/ie/invoices_india | https://du-ua.uipath.com/ie/invoices_india | https://du-gxp-us.uipath.com/ie/invoices_india | https://du-gxp-eu.uipath.com/ie/invoices_india |
| InvoicesJapan | https://du.uipath.com/ie/invoices_japan | https://du-us.uipath.com/ie/invoices_japan | https://du-jp.uipath.com/ie/invoices_japan | https://du-au.uipath.com/ie/invoices_japan | https://du-ca.uipath.com/ie/invoices_japan | https://du-in.uipath.com/ie/invoices_japan | https://du-uk.uipath.com/ie/invoices_japan | https://du-sg.uipath.com/ie/invoices_japan | https://du-sz.uipath.com/ie/invoices_japan | https://du-ua.uipath.com/ie/invoices_japan | https://du-gxp-us.uipath.com/ie/invoices_japan | https://du-gxp-eu.uipath.com/ie/invoices_japan |
| InvoicesChina | https://du.uipath.com/ie/invoices_china | https://du-us.uipath.com/ie/invoices_china | https://du-jp.uipath.com/ie/invoices_china | https://du-au.uipath.com/ie/invoices_china | https://du-ca.uipath.com/ie/invoices_china | https://du-in.uipath.com/ie/invoices_china | https://du-uk.uipath.com/ie/invoices_china | https://du-sg.uipath.com/ie/invoices_china | https://du-sz.uipath.com/ie/invoices_china | https://du-ua.uipath.com/ie/invoices_china | https://du-gxp-us.uipath.com/ie/invoices_china | https://du-gxp-eu.uipath.com/ie/invoices_china |
| Invoices Hebrew - Preview | https://du.uipath.com/ie/invoices_hebrew | https://du-us.uipath.com/ie/invoices_hebrew | https://du-jp.uipath.com/ie/invoices_hebrew | https://du-au.uipath.com/ie/invoices_hebrew | https://du-ca.uipath.com/ie/invoices_hebrew | https://du-in.uipath.com/ie/invoices_hebrew | https://du-uk.uipath.com/ie/invoices_hebrew | https://du-sg.uipath.com/ie/invoices_hebrew | https://du-sz.uipath.com/ie/invoices_hebrew | https://du-ua.uipath.com/ie/invoices_hebrew | https://du-gxp-us.uipath.com/ie/invoices_hebrew | https://du-gxp-eu.uipath.com/ie/invoices_hebrew |
| Invoices Shipping | https://du.uipath.com/ie/invoices_shipping | https://du-us.uipath.com/ie/invoices_shipping | https://du-jp.uipath.com/ie/invoices_shipping | https://du-au.uipath.com/ie/invoices_shipping | https://du-ca.uipath.com/ie/invoices_shipping | https://du-in.uipath.com/ie/invoices_shipping | https://du-uk.uipath.com/ie/invoices_shipping | https://du-sg.uipath.com/ie/invoices_shipping | https://du-sz.uipath.com/ie/invoices_shipping | https://du-ua.uipath.com/ie/invoices_shipping | https://du-gxp-us.uipath.com/ie/invoices_shipping | https://du-gxp-eu.uipath.com/ie/invoices_shipping |
| Receipts | https://du.uipath.com/ie/receipts | https://du-us.uipath.com/ie/receipts | https://du-jp.uipath.com/ie/receipts | https://du-au.uipath.com/ie/receipts | https://du-ca.uipath.com/ie/receipts | https://du-in.uipath.com/ie/receipts | https://du-uk.uipath.com/ie/receipts | https://du-sg.uipath.com/ie/receipts | https://du-sz.uipath.com/ie/receipts | https://du-ua.uipath.com/ie/receipts | https://du-gxp-us.uipath.com/ie/receipts | https://du-gxp-eu.uipath.com/ie/receipts |
| Receipts2 - Preview Note: Only available as a public endpoint. | https://du.uipath.com/ie/receipts2 | https://du-us.uipath.com/ie/receipts2 | https://du-jp.uipath.com/ie/receipts2 | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A |
| PurchaseOrders | https://du.uipath.com/ie/purchase_orders | https://du-us.uipath.com/ie/purchase_orders | https://du-jp.uipath.com/ie/purchase_orders | https://du-au.uipath.com/ie/purchase_orders | https://du-ca.uipath.com/ie/purchase_orders | https://du-in.uipath.com/ie/purchase_orders | https://du-uk.uipath.com/ie/purchase_orders | https://du-sg.uipath.com/ie/purchase_orders | https://du-sz.uipath.com/ie/purchase_orders | https://du-ua.uipath.com/ie/purchase_orders | https://du-gxp-us.uipath.com/ie/purchase_orders | https://du-gxp-eu.uipath.com/ie/purchase_orders |
| UtilityBills | https://du.uipath.com/ie/utility_bills | https://du-us.uipath.com/ie/utility_bills | https://du-jp.uipath.com/ie/utility_bills | https://du-au.uipath.com/ie/utility_bills | https://du-ca.uipath.com/ie/utility_bills | https://du-in.uipath.com/ie/utility_bills | https://du-uk.uipath.com/ie/utility_bills | https://du-sg.uipath.com/ie/utility_bills | https://du-sz.uipath.com/ie/utility_bills | https://du-ua.uipath.com/ie/utility_bills | https://du-gxp-us.uipath.com/ie/utility_bills | https://du-gxp-eu.uipath.com/ie/utility_bills |
| IDCards | https://du.uipath.com/ie/id_cards | https://du-us.uipath.com/ie/id_cards | https://du-jp.uipath.com/ie/id_cards | https://du-au.uipath.com/ie/id_cards | https://du-ca.uipath.com/ie/id_cards | https://du-in.uipath.com/ie/id_cards | https://du-uk.uipath.com/ie/id_cards | https://du-sg.uipath.com/ie/id_cards | https://du-sz.uipath.com/ie/id_cards | https://du-ua.uipath.com/ie/id_cards | https://du-gxp-us.uipath.com/ie/id_cards | https://du-gxp-eu.uipath.com/ie/id_cards |
| Passports | https://du.uipath.com/ie/passports | https://du-us.uipath.com/ie/passports | https://du-jp.uipath.com/ie/passports | https://du-au.uipath.com/ie/passports | https://du-ca.uipath.com/ie/passports | https://du-in.uipath.com/ie/passports | https://du-uk.uipath.com/ie/passports | https://du-sg.uipath.com/ie/passports | https://du-sz.uipath.com/ie/passports | https://du-ua.uipath.com/ie/passports | https://du-gxp-us.uipath.com/ie/passports | https://du-gxp-eu.uipath.com/ie/passports |
| Pay slips | https://du.uipath.com/ie/payslips | https://du-us.uipath.com/ie/payslips | https://du-jp.uipath.com/ie/payslips | https://du-au.uipath.com/ie/payslips | https://du-ca.uipath.com/ie/payslips | https://du-in.uipath.com/ie/payslips | https://du-uk.uipath.com/ie/payslips | https://du-sg.uipath.com/ie/payslips | https://du-sz.uipath.com/ie/payslips | https://du-ua.uipath.com/ie/payslips | https://du-gxp-us.uipath.com/ie/payslips | https://du-gxp-eu.uipath.com/ie/payslips |
| RemittanceAdvices | https://du.uipath.com/ie/remittance_advices | https://du-us.uipath.com/ie/remittance_advices | https://du-jp.uipath.com/ie/remittance_advices | https://du-au.uipath.com/ie/remittance_advices | https://du-ca.uipath.com/ie/remittance_advices | https://du-in.uipath.com/ie/remittance_advices | https://du-uk.uipath.com/ie/remittance_advices | https://du-sg.uipath.com/ie/remittance_advices | https://du-sz.uipath.com/ie/remittance_advices | https://du-ua.uipath.com/ie/remittance_advices | https://du-gxp-us.uipath.com/ie/remittance_advices | https://du-gxp-eu.uipath.com/ie/remittance_advices |
| BillsOfLading | https://du.uipath.com/ie/bills_of_lading | https://du-us.uipath.com/ie/bills_of_lading | https://du-jp.uipath.com/ie/bills_of_lading | https://du-au.uipath.com/ie/bills_of_lading | https://du-ca.uipath.com/ie/bills_of_lading | https://du-in.uipath.com/ie/bills_of_lading | https://du-uk.uipath.com/ie/bills_of_lading | https://du-sg.uipath.com/ie/bills_of_lading | https://du-sz.uipath.com/ie/bills_of_lading | https://du-ua.uipath.com/ie/bills_of_lading | https://du-gxp-us.uipath.com/ie/bills_of_lading | https://du-gxp-eu.uipath.com/ie/bills_of_lading |
| UB04 - Preview | https://du.uipath.com/ie/ub04 | https://du-us.uipath.com/ie/ub04 | https://du-jp.uipath.com/ie/ub04 | https://du-au.uipath.com/ie/ub04 | https://du-ca.uipath.com/ie/ub04 | https://du-in.uipath.com/ie/ub04 | https://du-uk.uipath.com/ie/ub04 | https://du-sg.uipath.com/ie/ub04 | https://du-sz.uipath.com/ie/ub04 | https://du-ua.uipath.com/ie/ub04 | https://du-gxp-us.uipath.com/ie/ub04 | https://du-gxp-eu.uipath.com/ie/ub04 |
| W2 | https://du.uipath.com/ie/w2 | https://du-us.uipath.com/ie/w2 | https://du-jp.uipath.com/ie/w2 | https://du-au.uipath.com/ie/w2 | https://du-ca.uipath.com/ie/w2 | https://du-in.uipath.com/ie/w2 | https://du-uk.uipath.com/ie/w2 | https://du-sg.uipath.com/ie/w2 | https://du-sz.uipath.com/ie/w2 | https://du-ua.uipath.com/ie/w2 | https://du-gxp-us.uipath.com/ie/w2 | https://du-gxp-eu.uipath.com/ie/w2 |
| W9 | https://du.uipath.com/ie/w9 | https://du-us.uipath.com/ie/w9 | https://du-jp.uipath.com/ie/w9 | https://du-au.uipath.com/ie/w9 | https://du-ca.uipath.com/ie/w9 | https://du-in.uipath.com/ie/w9 | https://du-uk.uipath.com/ie/w9 | https://du-sg.uipath.com/ie/w9 | https://du-sz.uipath.com/ie/w9 | https://du-ua.uipath.com/ie/w9 | https://du-gxp-us.uipath.com/ie/w9 | https://du-gxp-eu.uipath.com/ie/w9 |
| ACORD125 | https://du.uipath.com/ie/acord125 | https://du-us.uipath.com/ie/acord125 | https://du-jp.uipath.com/ie/acord125 | https://du-au.uipath.com/ie/acord125 | https://du-ca.uipath.com/ie/acord125 | https://du-in.uipath.com/ie/acord125 | https://du-uk.uipath.com/ie/acord125 | https://du-sg.uipath.com/ie/acord125 | https://du-sz.uipath.com/ie/acord125 | https://du-ua.uipath.com/ie/acord125 | https://du-gxp-us.uipath.com/ie/acord125 | https://du-gxp-eu.uipath.com/ie/acord125 |
| I9 | https://du.uipath.com/ie/i9 | https://du-us.uipath.com/ie/i9 | https://du-jp.uipath.com/ie/i9 | https://du-au.uipath.com/ie/i9 | https://du-ca.uipath.com/ie/i9 | https://du-in.uipath.com/ie/i9 | https://du-uk.uipath.com/ie/i9 | https://du-sg.uipath.com/ie/i9 | https://du-sz.uipath.com/ie/i9 | https://du-ua.uipath.com/ie/i9 | https://du-gxp-us.uipath.com/ie/i9 | https://du-gxp-eu.uipath.com/ie/i9 |
| 709 - Preview | https://du.uipath.com/ie/709 | https://du-us.uipath.com/ie/709 | https://du-jp.uipath.com/ie/709 | https://du-au.uipath.com/ie/709 | https://du-ca.uipath.com/ie/709 | https://du-in.uipath.com/ie/709 | https://du-uk.uipath.com/ie/709 | https://du-sg.uipath.com/ie/709 | https://du-sz.uipath.com/ie/709 | https://du-ua.uipath.com/ie/709 | https://du-gxp-us.uipath.com/ie/709 | https://du-gxp-eu.uipath.com/ie/709 |
| 941x - Preview | https://du.uipath.com/ie/941x | https://du-us.uipath.com/ie/941x | https://du-jp.uipath.com/ie/941x | https://du-au.uipath.com/ie/941x | https://du-ca.uipath.com/ie/941x | https://du-in.uipath.com/ie/941x | https://du-uk.uipath.com/ie/941x | https://du-sg.uipath.com/ie/941x | https://du-sz.uipath.com/ie/941x | https://du-ua.uipath.com/ie/941x | https://du-gxp-us.uipath.com/ie/941x | https://du-gxp-eu.uipath.com/ie/941x |
| 3949a - Preview | https://du.uipath.com/ie/3949a | https://du-us.uipath.com/ie/3949a | https://du-jp.uipath.com/ie/3949a | https://du-au.uipath.com/ie/3949a | https://du-ca.uipath.com/ie/3949a | https://du-in.uipath.com/ie/3949a | https://du-uk.uipath.com/ie/3949a | https://du-sg.uipath.com/ie/3949a | https://du-sz.uipath.com/ie/3949a | https://du-ua.uipath.com/ie/3949a | https://du-gxp-us.uipath.com/ie/3949a | https://du-gxp-eu.uipath.com/ie/3949a |
| 4506T | https://du.uipath.com/ie/4506t | https://du-us.uipath.com/ie/4506t | https://du-jp.uipath.com/ie/4506t | https://du-au.uipath.com/ie/4506t | https://du-ca.uipath.com/ie/4506t | https://du-in.uipath.com/ie/4506t | https://du-uk.uipath.com/ie/4506t | https://du-sg.uipath.com/ie/4506t | https://du-sz.uipath.com/ie/4506t | https://du-ua.uipath.com/ie/4506t | https://du-gxp-us.uipath.com/ie/4506t | https://du-gxp-eu.uipath.com/ie/4506t |
| 9465 - Preview | https://du.uipath.com/ie/9465 | https://du-us.uipath.com/ie/9465 | https://du-jp.uipath.com/ie/9465 | https://du-au.uipath.com/ie/9465 | https://du-ca.uipath.com/ie/9465 | https://du-in.uipath.com/ie/9465 | https://du-uk.uipath.com/ie/9465 | https://du-sg.uipath.com/ie/9465 | https://du-sz.uipath.com/ie/9465 | https://du-ua.uipath.com/ie/9465 | https://du-gxp-us.uipath.com/ie/9465 | https://du-gxp-eu.uipath.com/ie/9465 |
| ACORD25 | https://du.uipath.com/ie/acord25 | https://du-us.uipath.com/ie/acord25 | https://du-jp.uipath.com/ie/acord25 | https://du-au.uipath.com/ie/acord25 | https://du-ca.uipath.com/ie/acord25 | https://du-in.uipath.com/ie/acord25 | https://du-uk.uipath.com/ie/acord25 | https://du-sg.uipath.com/ie/acord25 | https://du-sz.uipath.com/ie/acord25 | https://du-ua.uipath.com/ie/acord25 | https://du-gxp-us.uipath.com/ie/acord25 | https://du-gxp-eu.uipath.com/ie/acord25 |
| 1040 | https://du.uipath.com/ie/1040 | https://du-us.uipath.com/ie/1040 | https://du-jp.uipath.com/ie/1040 | https://du-au.uipath.com/ie/1040 | https://du-ca.uipath.com/ie/1040 | https://du-in.uipath.com/ie/1040 | https://du-uk.uipath.com/ie/1040 | https://du-sg.uipath.com/ie/1040 | https://du-sz.uipath.com/ie/1040 | https://du-ua.uipath.com/ie/1040 | https://du-gxp-us.uipath.com/ie/1040 | https://du-gxp-eu.uipath.com/ie/1040 |
| 1040 Schedule C - Preview | https://du.uipath.com/ie/1040_schedule_c | https://du-us.uipath.com/ie/1040_schedule_c | https://du-jp.uipath.com/ie/1040_schedule_c | https://du-au.uipath.com/ie/1040_schedule_c | https://du-ca.uipath.com/ie/1040_schedule_c | https://du-in.uipath.com/ie/1040_schedule_c | https://du-uk.uipath.com/ie/1040_schedule_c | https://du-sg.uipath.com/ie/1040_schedule_c | https://du-sz.uipath.com/ie/1040_schedule_c | https://du-ua.uipath.com/ie/1040_schedule_c | https://du-gxp-us.uipath.com/ie/1040_schedule_c | https://du-gxp-eu.uipath.com/ie/1040_schedule_c |
| 1040 Schedule D - Preview | https://du.uipath.com/ie/1040_schedule_d | https://du-us.uipath.com/ie/1040_schedule_d | https://du-jp.uipath.com/ie/1040_schedule_d | https://du-au.uipath.com/ie/1040_schedule_d | https://du-ca.uipath.com/ie/1040_schedule_d | https://du-in.uipath.com/ie/1040_schedule_d | https://du-uk.uipath.com/ie/1040_schedule_d | https://du-sg.uipath.com/ie/1040_schedule_d | https://du-sz.uipath.com/ie/1040_schedule_d | https://du-ua.uipath.com/ie/1040_schedule_d | https://du-gxp-us.uipath.com/ie/1040_schedule_d | https://du-gxp-eu.uipath.com/ie/1040_schedule_d |
| 1040 Schedule E - Preview | https://du.uipath.com/ie/1040_schedule_e | https://du-us.uipath.com/ie/1040_schedule_e | https://du-jp.uipath.com/ie/1040_schedule_e | https://du-au.uipath.com/ie/1040_schedule_e | https://du-ca.uipath.com/ie/1040_schedule_e | https://du-in.uipath.com/ie/1040_schedule_e | https://du-uk.uipath.com/ie/1040_schedule_e | https://du-sg.uipath.com/ie/1040_schedule_e | https://du-sz.uipath.com/ie/1040_schedule_e | https://du-ua.uipath.com/ie/1040_schedule_e | https://du-gxp-us.uipath.com/ie/1040_schedule_e | https://du-gxp-eu.uipath.com/ie/1040_schedule_e |
| 1040x - Preview | https://du.uipath.com/ie/1040x | https://du-us.uipath.com/ie/1040x | https://du-jp.uipath.com/ie/1040x | https://du-au.uipath.com/ie/1040x | https://du-ca.uipath.com/ie/1040x | https://du-in.uipath.com/ie/1040x | https://du-uk.uipath.com/ie/1040x | https://du-sg.uipath.com/ie/1040x | https://du-sz.uipath.com/ie/1040x | https://du-ua.uipath.com/ie/1040x | https://du-gxp-us.uipath.com/ie/1040x | https://du-gxp-eu.uipath.com/ie/1040x |
| Checks | https://du.uipath.com/ie/checks | https://du-us.uipath.com/ie/checks | https://du-jp.uipath.com/ie/checks | https://du-au.uipath.com/ie/checks | https://du-ca.uipath.com/ie/checks | https://du-in.uipath.com/ie/checks | https://du-uk.uipath.com/ie/checks | https://du-sg.uipath.com/ie/checks | https://du-sz.uipath.com/ie/checks | https://du-ua.uipath.com/ie/checks | https://du-gxp-us.uipath.com/ie/checks | https://du-gxp-eu.uipath.com/ie/checks |
| Certificate of Incorporation/ Good Standing | https://du.uipath.com/ie/certificates_incorporation | https://du-us.uipath.com/ie/certificates_incorporation | https://du-jp.uipath.com/ie/certificates_incorporation | https://du-au.uipath.com/ie/certificates_incorporation | https://du-ca.uipath.com/ie/certificates_incorporation | https://du-in.uipath.com/ie/certificates_incorporation | https://du-uk.uipath.com/ie/certificates_incorporation | https://du-sg.uipath.com/ie/certificates_incorporation | https://du-sz.uipath.com/ie/certificates_incorporation | https://du-ua.uipath.com/ie/certificates_incorporation | https://du-gxp-us.uipath.com/ie/certificates_incorporation | https://du-gxp-eu.uipath.com/ie/certificates_incorporation |
| Certificate of Origin | https://du.uipath.com/ie/certificates_origin | https://du-us.uipath.com/ie/certificates_origin | https://du-jp.uipath.com/ie/certificates_origin | https://du-au.uipath.com/ie/certificates_origin | https://du-ca.uipath.com/ie/certificates_origin | https://du-in.uipath.com/ie/certificates_origin | https://du-uk.uipath.com/ie/certificates_origin | https://du-sg.uipath.com/ie/certificates_origin | https://du-sz.uipath.com/ie/certificates_origin | https://du-ua.uipath.com/ie/certificates_origin | https://du-gxp-us.uipath.com/ie/certificates_origin | https://du-gxp-eu.uipath.com/ie/certificates_origin |
| Children Product Certificate | https://du.uipath.com/ie/children_product_certificates | https://du-us.uipath.com/ie/children_product_certificates | https://du-jp.uipath.com/ie/children_product_certificates | https://du-au.uipath.com/ie/children_product_certificates | https://du-ca.uipath.com/ie/children_product_certificates | https://du-in.uipath.com/ie/children_product_certificates | https://du-uk.uipath.com/ie/children_product_certificates | https://du-sg.uipath.com/ie/children_product_certificates | https://du-sz.uipath.com/ie/children_product_certificates | https://du-ua.uipath.com/ie/children_product_certificates | https://du-gxp-us.uipath.com/ie/children_product_certificates | https://du-gxp-eu.uipath.com/ie/children_product_certificates |
| CMS1500 | https://du.uipath.com/ie/cms1500 | https://du-us.uipath.com/ie/cms1500 | https://du-jp.uipath.com/ie/cms1500 | https://du-au.uipath.com/ie/cms1500 | https://du-ca.uipath.com/ie/cms1500 | https://du-in.uipath.com/ie/cms1500 | https://du-uk.uipath.com/ie/cms1500 | https://du-sg.uipath.com/ie/cms1500 | https://du-sz.uipath.com/ie/cms1500 | https://du-ua.uipath.com/ie/cms1500 | https://du-gxp-us.uipath.com/ie/cms1500 | https://du-gxp-eu.uipath.com/ie/cms1500 |
| EU Declaration of Conformity | https://du.uipath.com/ie/eu_declaration_conformity | https://du-us.uipath.com/ie/eu_declaration_conformity | https://du-jp.uipath.com/ie/eu_declaration_conformity | https://du-au.uipath.com/ie/eu_declaration_conformity | https://du-ca.uipath.com/ie/eu_declaration_conformity | https://du-in.uipath.com/ie/eu_declaration_conformity | https://du-uk.uipath.com/ie/eu_declaration_conformity | https://du-sg.uipath.com/ie/eu_declaration_conformity | https://du-sz.uipath.com/ie/eu_declaration_conformity | https://du-ua.uipath.com/ie/eu_declaration_conformity | https://du-gxp-us.uipath.com/ie/eu_declaration_conformity | https://du-gxp-eu.uipath.com/ie/eu_declaration_conformity |
| BankStatements | https://du.uipath.com/ie/bank_statements | https://du-us.uipath.com/ie/bank_statements | https://du-jp.uipath.com/ie/bank_statements | https://du-au.uipath.com/ie/bank_statements | https://du-ca.uipath.com/ie/bank_statements | https://du-in.uipath.com/ie/bank_statements | https://du-uk.uipath.com/ie/bank_statements | https://du-sg.uipath.com/ie/bank_statements | https://du-sz.uipath.com/ie/bank_statements | https://du-ua.uipath.com/ie/bank_statements | https://du-gxp-us.uipath.com/ie/bank_statements | https://du-gxp-eu.uipath.com/ie/bank_statements |
| FinancialStatements | https://du.uipath.com/ie/financial_statements | https://du-us.uipath.com/ie/financial_statements | https://du-jp.uipath.com/ie/financial_statements | https://du-au.uipath.com/ie/financial_statements | https://du-ca.uipath.com/ie/financial_statements | https://du-in.uipath.com/ie/financial_statements | https://du-uk.uipath.com/ie/financial_statements | https://du-sg.uipath.com/ie/financial_statements | https://du-sz.uipath.com/ie/financial_statements | https://du-ua.uipath.com/ie/financial_statements | https://du-gxp-us.uipath.com/ie/financial_statements | https://du-gxp-eu.uipath.com/ie/financial_statements |
| US Mortgage Closing Disclosures - Preview Note: Only available as a public endpoint. | https://du.uipath.com/ie/us_mortgage_closing_disclosures | https://du-us.uipath.com/ie/us_mortgage_closing_disclosures | https://du-jp.uipath.com/ie/us_mortgage_closing_disclosures | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A |
| PackingLists | https://du.uipath.com/ie/packing_lists | https://du-us.uipath.com/ie/packing_lists | https://du-jp.uipath.com/ie/packing_lists | https://du-au.uipath.com/ie/packing_lists | https://du-ca.uipath.com/ie/packing_lists | https://du-in.uipath.com/ie/packing_lists | https://du-uk.uipath.com/ie/packing_lists | https://du-sg.uipath.com/ie/packing_lists | https://du-sz.uipath.com/ie/packing_lists | https://du-ua.uipath.com/ie/packing_lists | https://du-gxp-us.uipath.com/ie/packing_lists | https://du-gxp-eu.uipath.com/ie/packing_lists |
| Acord131 | https://du.uipath.com/ie/acord131 | https://du-us.uipath.com/ie/acord131 | https://du-jp.uipath.com/ie/acord131 | https://du-au.uipath.com/ie/acord131 | https://du-ca.uipath.com/ie/acord131 | https://du-in.uipath.com/ie/acord131 | https://du-uk.uipath.com/ie/acord131 | https://du-sg.uipath.com/ie/acord131 | https://du-sz.uipath.com/ie/acord131 | https://du-ua.uipath.com/ie/acord131 | https://du-gxp-us.uipath.com/ie/acord131 | https://du-gxp-eu.uipath.com/ie/acord131 |
| Acord140 | https://du.uipath.com/ie/acord140 | https://du-us.uipath.com/ie/acord140 | https://du-jp.uipath.com/ie/acord140 | https://du-au.uipath.com/ie/acord140 | https://du-ca.uipath.com/ie/acord140 | https://du-in.uipath.com/ie/acord140 | https://du-uk.uipath.com/ie/acord140 | https://du-sg.uipath.com/ie/acord140 | https://du-sz.uipath.com/ie/acord140 | https://du-ua.uipath.com/ie/acord140 | https://du-gxp-us.uipath.com/ie/acord140 | https://du-gxp-eu.uipath.com/ie/acord140 |
| VehicleTitles | https://du.uipath.com/ie/vehicle_titles | https://du-us.uipath.com/ie/vehicle_titles | https://du-jp.uipath.com/ie/vehicle_titles | https://du-au.uipath.com/ie/vehicle_titles | https://du-ca.uipath.com/ie/vehicle_titles | https://du-in.uipath.com/ie/vehicle_titles | https://du-uk.uipath.com/ie/vehicle_titles | https://du-sg.uipath.com/ie/vehicle_titles | https://du-sz.uipath.com/ie/vehicle_titles | https://du-ua.uipath.com/ie/vehicle_titles | https://du-gxp-us.uipath.com/ie/vehicle_titles | https://du-gxp-eu.uipath.com/ie/vehicle_titles |
| Acord126 | https://du.uipath.com/ie/acord126 | https://du-us.uipath.com/ie/acord126 | https://du-jp.uipath.com/ie/acord126 | https://du-au.uipath.com/ie/acord126 | https://du-ca.uipath.com/ie/acord126 | https://du-in.uipath.com/ie/acord126 | https://du-uk.uipath.com/ie/acord126 | https://du-sg.uipath.com/ie/acord126 | https://du-sz.uipath.com/ie/acord126 | https://du-ua.uipath.com/ie/acord126 | https://du-gxp-us.uipath.com/ie/acord126 | https://du-gxp-eu.uipath.com/ie/acord126 |
| FM1003 - Preview | https://du.uipath.com/ie/fm1003 | https://du-us.uipath.com/ie/fm1003 | https://du-jp.uipath.com/ie/fm1003 | https://du-au.uipath.com/ie/fm1003 | https://du-ca.uipath.com/ie/fm1003 | https://du-in.uipath.com/ie/fm1003 | https://du-uk.uipath.com/ie/fm1003 | https://du-sg.uipath.com/ie/fm1003 | https://du-sz.uipath.com/ie/fm1003 | https://du-ua.uipath.com/ie/fm1003 | https://du-gxp-us.uipath.com/ie/fm1003 | https://du-gxp-eu.uipath.com/ie/fm1003 |
| FormExtractor | https://du.uipath.com/svc/formextractor | https://du-us.uipath.com/svc/formextractor | https://du-jp.uipath.com/svc/formextractor | https://du-au.uipath.com/svc/formextractor | https://du-ca.uipath.com/svc/formextractor | https://du-in.uipath.com/svc/formextractor | https://du-uk.uipath.com/svc/formextractor | https://du-sg.uipath.com/svc/formextractor | https://du-sz.uipath.com/svc/formextractor | https://du-ua.uipath.com/svc/formextractor | N/A | N/A |
| IntelligentKeywordClassifier | https://du.uipath.com/svc/intelligentkeywords | https://du-us.uipath.com/svc/intelligentkeywords | https://du-jp.uipath.com/svc/intelligentkeywords | https://du-au.uipath.com/svc/intelligentkeywords | https://du-ca.uipath.com/svc/intelligentkeywords | https://du-in.uipath.com/svc/intelligentkeywords | https://du-uk.uipath.com/svc/intelligentkeywords | https://du-sg.uipath.com/svc/intelligentkeywords | https://du-sz.uipath.com/svc/intelligentkeywords | https://du-ua.uipath.com/svc/intelligentkeywords | N/A | N/A |
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
- 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.
- 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.ApiRemember 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
- 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.