Industries Common Resources Developer Guide
jNewer Version Available
Fetch Extracted Text Action
Special Access Rules
This action is available in API version 58.0 and later for users with the AWSTextract1000LimitAddOn or IntelligentDocumentReaderAddOn license.
Supported REST HTTP Methods
- URI
- /services/data/vXX.X/actions/standard/fetchExtractedText
- Formats
- JSON, XML
- HTTP Methods
- POST
- Authentication
- Authorization: Bearer token
Inputs
| Input | Details |
|---|---|
| contentDocumentId |
|
| endPageIndex |
|
| startPageIndex |
|
Outputs
| Output | Details |
|---|---|
| ocrDocumentScanResultDetails |
|
Example
Sample Request
1{
2 "inputs":[
3 {
4 "contentDocumentId":"069T10000004FnoIAE",
5 "startPageIndex":1,
6 "endPageIndex":20
7 }
8 ]
9}Sample Response
1[
2 {
3 "actionName":"fetchExtractedText",
4 "errors":null,
5 "isSuccess":true,
6 "outputValues":{
7 "ocrDocumentScanResultDetails":{
8 "ocrDocumentScanResultDetails":[
9 {
10 "status":"SUCCESS",
11 "pageNumber":1,
12 "ocrService":"AMAZON_TEXTRACT",
13 "ocrDocumentScanResultId":"0ixT100000000bv",
14 "keyValuePairs":[
15 {
16 "value":{
17 "value":"30 NOV 2009",
18 "confidence":51.1217041015625
19 },
20 "key":{
21 "value":"Issued On",
22 "confidence":51.1217041015625
23 }
24 },
25 {
26 "value":{
27 "value":"F",
28 "confidence":62.40586471557617
29 },
30 "key":{
31 "value":"Sex",
32 "confidence":62.40586471557617
33 }
34 },
35 {
36 "value":{
37 "value":"C03004786",
38 "confidence":29.852550506591797
39 },
40 "key":{
41 "value":"Passport Card no",
42 "confidence":29.852550506591797
43 }
44 },
45 {
46 "value":{
47 "value":"NEW YORK U.S.A.",
48 "confidence":44.244361877441406
49 },
50 "key":{
51 "value":"Place of Birth",
52 "confidence":44.244361877441406
53 }
54 },
55 {
56 "value":{
57 "value":"1 JAN 1981",
58 "confidence":71.45907592773438
59 },
60 "key":{
61 "value":"Date of Birth",
62 "confidence":71.45907592773438
63 }
64 },
65 {
66 "value":{
67 "value":"29 NOV 2019",
68 "confidence":57.35758590698242
69 },
70 "key":{
71 "value":"Expires On",
72 "confidence":57.35758590698242
73 }
74 },
75 {
76 "value":{
77 "value":"HAPPY",
78 "confidence":34.885074615478516
79 },
80 "key":{
81 "value":"Given Names",
82 "confidence":34.885074615478516
83 }
84 }
85 ]
86 },
87 {
88 "status":"SUCCESS",
89 "pageNumber":1,
90 "ocrService":"AMAZON_TEXTRACT_ANALYZED_ID",
91 "ocrDocumentScanResultId":"0ixT100000000c0",
92 "keyValuePairs":[
93 {
94 "value":{
95 "value":"HAPPY",
96 "confidence":82.33665466308594
97 },
98 "key":{
99 "value":"FIRST_NAME",
100 "confidence":100.0
101 }
102 },
103 {
104 "value":{
105 "value":"TRAVELER",
106 "confidence":80.86970520019531
107 },
108 "key":{
109 "value":"LAST_NAME",
110 "confidence":100.0
111 }
112 },
113 {
114 "value":{
115 "value":"",
116 "confidence":99.19149780273438
117 },
118 "key":{
119 "value":"MIDDLE_NAME",
120 "confidence":0.0
121 }
122 },
123 {
124 "value":{
125 "value":"",
126 "confidence":99.17862701416016
127 },
128 "key":{
129 "value":"SUFFIX",
130 "confidence":0.0
131 }
132 },
133 {
134 "value":{
135 "value":"",
136 "confidence":99.21914672851562
137 },
138 "key":{
139 "value":"CITY_IN_ADDRESS",
140 "confidence":0.0
141 }
142 },
143 {
144 "value":{
145 "value":"",
146 "confidence":99.13475036621094
147 },
148 "key":{
149 "value":"ZIP_CODE_IN_ADDRESS",
150 "confidence":0.0
151 }
152 },
153 {
154 "value":{
155 "value":"",
156 "confidence":99.09383392333984
157 },
158 "key":{
159 "value":"STATE_IN_ADDRESS",
160 "confidence":0.0
161 }
162 },
163 {
164 "value":{
165 "value":"",
166 "confidence":99.17210388183594
167 },
168 "key":{
169 "value":"STATE_NAME",
170 "confidence":0.0
171 }
172 },
173 {
174 "value":{
175 "value":"C03004786",
176 "confidence":94.59364318847656
177 },
178 "key":{
179 "value":"DOCUMENT_NUMBER",
180 "confidence":100.0
181 }
182 },
183 {
184 "value":{
185 "value":"29 NOV 2019",
186 "confidence":95.38605499267578
187 },
188 "key":{
189 "value":"EXPIRATION_DATE",
190 "confidence":100.0
191 }
192 },
193 {
194 "value":{
195 "value":"1 JAN 1981",
196 "confidence":97.8244857788086
197 },
198 "key":{
199 "value":"DATE_OF_BIRTH",
200 "confidence":100.0
201 }
202 },
203 {
204 "value":{
205 "value":"30 NOV 2009",
206 "confidence":86.14622497558594
207 },
208 "key":{
209 "value":"DATE_OF_ISSUE",
210 "confidence":100.0
211 }
212 },
213 {
214 "value":{
215 "value":"DRIVER LICENSE FRONT",
216 "confidence":93.44902038574219
217 },
218 "key":{
219 "value":"ID_TYPE",
220 "confidence":100.0
221 }
222 },
223 {
224 "value":{
225 "value":"",
226 "confidence":99.12863159179688
227 },
228 "key":{
229 "value":"ENDORSEMENTS",
230 "confidence":0.0
231 }
232 },
233 {
234 "value":{
235 "value":"",
236 "confidence":99.17374420166016
237 },
238 "key":{
239 "value":"VETERAN",
240 "confidence":0.0
241 }
242 },
243 {
244 "value":{
245 "value":"",
246 "confidence":99.16364288330078
247 },
248 "key":{
249 "value":"RESTRICTIONS",
250 "confidence":0.0
251 }
252 },
253 {
254 "value":{
255 "value":"",
256 "confidence":99.1679458618164
257 },
258 "key":{
259 "value":"CLASS",
260 "confidence":0.0
261 }
262 },
263 {
264 "value":{
265 "value":"",
266 "confidence":99.17534637451172
267 },
268 "key":{
269 "value":"ADDRESS",
270 "confidence":0.0
271 }
272 },
273 {
274 "value":{
275 "value":"",
276 "confidence":99.17364501953125
277 },
278 "key":{
279 "value":"COUNTY",
280 "confidence":0.0
281 }
282 },
283 {
284 "value":{
285 "value":"NEW YORK U.S.A.",
286 "confidence":94.59681701660156
287 },
288 "key":{
289 "value":"PLACE_OF_BIRTH",
290 "confidence":100.0
291 }
292 },
293 {
294 "value":{
295 "value":"",
296 "confidence":97.52543640136719
297 },
298 "key":{
299 "value":"MRZ_CODE",
300 "confidence":0.0
301 }
302 }
303 ]
304 }
305 ]
306 }
307 },
308 "version":1
309 }
310]