IDP by Workato

Intelligent document processing (IDP) is a critical part of automation workflows. IDP by Workato provides a simple way for you to select or specify the fields you plan to use in your action to extract relevant data from your images and PDFs. This information then becomes available as output datapills for use in downstream actions.

For example, you can use the IDP by Workato connector to process invoices and reconciliation, parse and manage claims, perform identity verification, and parse generic documents such as resumes, receipts, or documentation for relevant text.

FEATURE AVAILABILITY

IDP by Workato is available for all users across all Workato data centers. You can opt-in to this feature by agreeing to our AI feature addendum (opens new window). Contact your Customer Success representative to learn more.

Key features

IDP by Workato includes the following key features to help you process unstructured data into structured data:

• Free-form schema: IDP by Workato supports free-form schemas. This enables you to process any type of document, regardless of its structure.

• Handwritten text: IDP by Workato can process handwritten text. This enables you to handle a diverse range of documents and use cases.

• Multi-language support: IDP by Workato supports multiple languages. This enables you to process a wide-range of documents, including international documents or invoices.

Connection setup

This connector does not require connection setup.

Process document action

Complete the following steps to set up your IDP by Workato action:

1

Search for and select IDP by Workato as your connector action after you have set up your trigger.

Choose IDP by Workato as your app

2

Select Process document using IDP by Workato as your action.

3

Provide File contents to process.

Process document action

4

Use the File type drop-down menu to select the file type you plan to process. This connector supports png, jpg, webp, gif, and pdf file types.

5

Use the Document type drop-down menu to select the document type you plan to process. Available options are Documents, Invoices, and Receipts. Receipts and invoices have a predefined schema you can use directly. Select Documents if you plan to provide your own schema.

6

Add your JSON schema or enter Fields to identify manually.

1

Click the Use JSON button under Fields to identify.

2

Paste the JSON sample you plan to use into the code box and then click Next. Alternatively, you can upload your JSON code by selecting Upload sample JSON from your device from the drop-down menu.

Paste or upload your JSON schema

3

Click Next and then review your JSON.

4

Click Generate schema.

1

Click Add fields manually under Fields to identify.

2

Name your field.

Add fields manually

3

Optional. Add a Description.

4

Select the Data type.

5

Use the Optional drop-down menu to determine if the field is optional or not.

6

Optional. Use the Nested drop-down menu to determine if the field is nested under another field.

7

Click Add field.

7

Click Save.

Confidence scores

IDP by Workato provides confidence scores to enable you to understand whether your process is working well and add flags for additional review as required. Confidence scores allow you to define a scalable process with minimum oversight and review for your document processing and data extraction.

Your confidence score is a number between 0 and 1 that represents the likelihood that the output contains the information you identified in your schema. For example, a confidence score of 0.95 (95%) indicates that the correct output occurs approximately 19 out of 20 times. We recommend that you designate a team member to review low confidence scores carefully to identify where improvements can be made in the data extraction workflow.

Input fields

The input fields for this action vary depending on the information included in the file contents. Refer to the following example input fields for more information:

Example invoice input

The input fields in this example are based on the following invoice:

Invoice example

The invoice is uploaded to Workato FileStorage in this example. This allows to use the Get file contents in Workato FileStorage action. You can then use the Process a document with IDP by Workato action with the following input fields:

Input field	Description
File contents	This the invoice file. This example maps the File contents datapill from the Get File contents action.
File type	Specify the file type of the document. Supported formats are png, jpg, webp, gif, and PDF. This example uses png.
Document type	Specify the document type of the file. This example uses Invoices.
Fields to identify	Specify the fields you plan to identify from the file contents. Add descriptions for extracting the fields.

Invoice input fields

Example document input

The input fields in this example are based on the following document:

Document example

The document is uploaded to Workato FileStorage in this example. This allows you to use the Get file contents in Workato FileStorage action. You can then use the Process a document with IDP by Workato action with the following input fields:

Input field	Description
File contents	This the invoice file. This example maps the File contents datapill from the Get File contents action.
File type	The file type of the document. Supported formats are png, jpg, webp, gif, and PDF. This example uses PDF.
Document type	Specify the document type of the file. This example uses Documents.
Fields to identify	Specify the fields you plan to identify from the file contents. Add descriptions for extracting the fields.

Document input fields

Output fields

The output of this action is a single datatree that contains information about the file contents you included in your schema, as well as confidence scores. Refer to the following example output datatree for more information on value and confidence score output:

Example value output

{
	"values": {
		"invoice_number": "I-N-V-50513188",
		"invoice_date": "17-Sep-2009",
		"due_date": "07-Mar-1996",
		"order_date": null,
		"total_amount": 722.84,
		"line_items": [
			{
				"description": "Cultural identify.",
				"quantity": 2,
				"price": 21.06,
				"product_code": null,
				"unit_price": 10.53
			},
			{
				"description": "Sister degree letter.",
				"quantity": 4,
				"price": 153.6,
				"product_code": null,
				"unit_price": 38.4
			},
			{
				"description": "Quite always item.",
				"quantity": 4,
				"price": 131.32,
				"product_code": null,
				"unit_price": 32.83
			},
			{
				"description": "Shoulder.",
				"quantity": 5,
				"price": 364,
				"product_code": null,
				"unit_price": 72.8
			},
			{
				"description": "Wall laugh.",
				"quantity": 5,
				"price": 38,
				"product_code": null,
				"unit_price": 7.6
			}
		],
		"vendor_address": "8110 Lee Haven, West Michele, IN 23979 US",
		"recipient_address": "838 Harris Ferry, Matthew burgh, MP 10645 US",
		"vendor_phone": "+1(193)406-5197",
		"vendor_url": "www.Graham-Carrillo-and-Stark.com",
		"vendor_gst_number": "24H-D-E7487R-E-S-R-T4",
		"vendor_email": "[email protected]",
		"recipient_phone": "+1(362)455-4064",
		"recipient_url": "https://www.torres.biz/",
		"recipient_gst_number": null,
		"recipient_email": "[email protected]",
		"purchase_order_number": null,
		"subtotal": 707.98,
		"tax_amount": 14.86,
		"discount": null,
		"payment_terms": null,
		"notes": null,
		"shipping_fee": null,
		"service_charge": null,
		"account_number": "16870634",
		"bank_code": null,
		"swift_number": "S-B-I-N-I-N-B-B250",
		"payment_method": null,
		"terms_and_conditions": "Terms and Conditions will be charged if payment is not made within the due date.",
		"remaining_calls": 99,
		"consumed_calls": 1,
		"reset_time": "2024-06-21T02:14:56.000000-07:00"
	}
}

Example confidence scores

{

	"confidence_scores": {
		"invoice_number": 0.9999498764044592,
		"invoice_date": 0.9996482332742705,
		"due_date": 0.9999909854763569,
		"order_date": 0.9999952766598805,
		"total_amount": 0.9999833454831217,
		"line_items": [
			{
				"description": 0.9928496557986662,
				"quantity": 0.9137961392004543,
				"price": 0.9659621927727069,
				"product_code": 0.999996766699321
			},
			{
				"description": 0.9999201908481007,
				"quantity": 0.9999195718568064,
				"price": 0.9978151698276594,
				"product_code": 0.9999995679801468
			},
			{
				"description": 0.9998884805883848,
				"quantity": 0.9999804063791609,
				"price": 0.9999548387307367,
				"product_code": 0.9999996871837311
			},
			{
				"description": 0.9997998524901466,
				"quantity": 0.9999720029460075,
				"price": 0.9998689017394373,
				"product_code": 0.9999999031936844
			},
			{
				"description": 0.9999628251424393,
				"quantity": 0.9999601429370041,
				"price": 0.9998570904479072,
				"product_code": 0.9999998063873687
			}
		],
		"vendor_phone": 0.9110792042231154,
		"vendor_url": 0.9452639023666751,
		"vendor_gst_number": 0.9992403800587537,
		"vendor_email": 0.9990823827609913,
		"recipient_phone": 0.9949677082415654,
		"recipient_url": 0.9963093776626322,
		"recipient_gst_number": 0.9997899093338881,
		"recipient_email": 0.9980467902735672,
		"purchase_order_number": 0.9999576695636125,
		"subtotal": 0.9999805851068317,
		"tax_amount": 0.9990580898021001,
		"discount": 0.9956880111711502,
		"payment_terms": 0.8990708766681919,
		"notes": 0.7962851560580655,
		"shipping_fee": 0.999827195289032,
		"service_charge": 0.9999335967675153,
		"account_number": 0.9943227138851094,
		"bank_code": 0.9813131412674407,
		"swift_number": 0.9913429312416263,
		"payment_method": 0.9992365566395588
	}
}