Intelligent Application Processing Extract Output

Returns the extraction status, the extracted data when extraction succeeds, and the ID of the created Document Checklist Item record when applicable.

JSON example 1

1{
2  "extractionStatus": "EXTRACTED",
3  "dciRecordId": "1LaSG000005I1Fh0AK",
4  "extractedData": {
5    "name": {
6      "type": "string",
7      "value": "Marie Jones"
8    },
9    "role": {
10      "type": "string",
11      "value": "Student Seeking Internship"
12    },
13    "summary": {
14      "type": "string",
15      "value": "Dedicated accounting student with a 4.0 GPA to date. Completed 32 credit hours, including classes in auditing, cost accounting, and managerial accounting. Recent work experience in small business bookkeeping; well-versed in accounting software such as QuickBooks and NetSuite."
16    },
17    "contact_information": {
18      "type": "array",
19      "value": [
20        {
21          "type": "object",
22          "value": {
23            "address": {
24              "type": "string",
25              "value": "4759 Sunnydale Street, Plano, Texas, United States, 75071"
26            },
27            "phone": {
28              "type": "string",
29              "value": "555-456-7890"
30            },
31            "email": {
32              "type": "string",
33              "value": "email@university.com"
34            }
35          }
36        }
37      ]
38    },
39    "professional_experience": {
40      "type": "array",
41      "value": [
42        {
43          "type": "object",
44          "value": {
45            "position": {
46              "type": "string",
47              "value": "Bookkeeper"
48            },
49            "organization": {
50              "type": "string",
51              "value": "Small Accounting Corp"
52            },
53            "dates": {
54              "type": "string",
55              "value": "May 2022 - September 2022"
56            },
57            "responsibilities": {
58              "type": "string",
59              "value": "Managed private client accounts, tracked accounts payable and receivable, prepared client and supplier invoices, processed weekly payroll, and reconciled bank account balances."
60            }
61          }
62        }
63      ]
64    },
65    "education": {
66      "type": "array",
67      "value": [
68        {
69          "type": "object",
70          "value": {
71            "degree": {
72              "type": "string",
73              "value": "Bachelor of Science (BS) in Accounting"
74            },
75            "field_of_study": {
76              "type": "string",
77              "value": "Accounting"
78            },
79            "institution": {
80              "type": "string",
81              "value": "University of Michigan, Ann Arbor"
82            },
83            "dates": {
84              "type": "string",
85              "value": "Expected: 2024"
86            }
87          }
88        }
89      ]
90    },
91    "key_skills": {
92      "type": "array",
93      "value": [
94        {
95          "type": "object",
96          "value": {
97            "skill": {
98              "type": "string",
99              "value": "Bookkeeping"
100            }
101          }
102        }
103      ]
104    }
105  }
106}

JSON Example 2

1{
2  "extractionStatus": "EXTRACTED",
3  "extractedData": {
4    "name": {
5      "type": "string",
6      "value": "Marie Jones"
7    },
8    "role": {
9      "type": "string",
10      "value": "Student Seeking Internship"
11    }
12  }
13}

JSON Example 3

1{
2  "extractionStatus": "SKIPPED",
3  "skipReason": "FILE_TOO_LARGE"
4}

Property Name	Type	Description	Filter Group and Version	Available Version
`dciRecordId`	String	ID of the created Document Checklist Item record. Returned only when the request included a `recordId` and DCI creation succeeded.	Big, 67.0	67.0
`extractedData`	String	Data extracted from the file, as a JSON string. Returned only when `extractionStatus` is `EXTRACTED`. Pass this string into `extractedContent` on the Merge Extractions resource.	Big, 67.0	67.0
`extractionStatus`	String	Indicates whether data was extracted from the file. Always returned. Valid values: `EXTRACTED` — Document AI returned data. A Document Checklist Item record is created when applicable. `SKIPPED` — Extraction was skipped because the file didn't meet requirements. See `skipReason`. When the status is `SKIPPED`, `extractedData` and `dciRecordId` aren't returned.	Big, 67.0	67.0
`skipReason`	String	Why extraction was skipped. Returned only when `extractionStatus` is `SKIPPED`. Valid values: `FILE_TOO_LARGE` — The file exceeds the 10 MB size limit. `UNSUPPORTED_MIME` — The file type isn't supported. Supported types are `application/pdf`, `image/jpeg`, and `image/png`.	Big, 67.0	67.0

Public Sector Developer Guide

Intelligent Application Processing Extract Output

See Also