Extract Thai ID Card

POST

https://api.staple.io/v1/documents/extract/tid

POST

/v1/documents/extract/tid

$ curl -X POST https://api.staple.io/v1/documents/extract/tid \
>      -H "x-api-key: <apiKey>" \
>      -H "Content-Type: multipart/form-data" \
>      -F file=@string

200Extract Thai ID Card

1 {
2   "BigBoxes": [
3     {
4       "box": [
5         150,
6         14,
7         1193,
8         719,
9         671.5,
10         366.5,
11         "บัตร ประจำ ตัว ประชาชน Thai National ID Car\nเลข ประจำ ตัว ประชาชน 13004 00124 03 9\nIdentification Number\nชื่อ ตัว และ ชื่อสกุล น.ส. อรัญ ญา แซ่ จิ ว\nName\nMiss Aranya\nLast name\nSaejeaw\nเกิด วัน ที่ 25 พ.ย.2533\nDate of Birth 25 Nov.1990\nศาสนา พุ ท ย\nที่ อยู่ 50 หมู่ ที่ 3 ต . บ้าน ปรางค์\nอ . คง จ . นครราชสีมา\n24 พ.ณ.2558\n2. ค .2560\nร\nใน บัตร หมดอายุ\nวัน ออก บัตร\nส ก็ อ )\n( า ที่ ต่อ\n24 Nov.2026\n288 2017\n30000502021140\nDate of Expiry\nเจ้าพนักงาน ออก บัตร\nDate of Tenue\n"
12       ],
13       "page": 0
14     },
15     {
16       "box": [
17         691,
18         650,
19         863,
20         676,
21         777,
22         663,
23         "24 Nov.2026\n"
24       ],
25       "page": 0
26     }
27   ],
28   "DOB": {
29     "UICategory": "Personal Information",
30     "UIName": "DOB",
31     "matches": [
32       {
33         "keyword": [
34           439,
35           382,
36           666,
37           431,
38           552,
39           406.5,
40           "Date of Birth"
41         ],
42         "match": "25 Nov.1990",
43         "matchmulti": null,
44         "page": 0,
45         "value": [
46           666,
47           382,
48           876,
49           431,
50           771,
51           406.5,
52           " 25 Nov.1990"
53         ]
54       }
55     ]
56   },
57   "DetectedText": "บัตร ประจำ ตัว ประชาชน Thai National ID Car เลข ประจำ ตัว ประชาชน 13004 00124 03 9 Identification Number ชื่อ ตัว และ ชื่อสกุล  น.ส. อรัญ ญา แซ่ จิ ว Name Miss Aranya Last name Saejeaw เกิด วัน ที่ 25 พ.ย.2533 Date of Birth  25 Nov.1990 ศาสนา พุ ท ย ที่ อยู่ 50 หมู่ ที่ 3 ต . บ้าน ปรางค์ อ . คง จ . นครราชสีมา 2. ค .2560 ร 24 พ.ณ.2558 วัน ออก บัตร ใน บัตร หมดอายุ 288 2017 ( า ที่ ต่อ ส ก็ อ ) Date of Tenue เจ้าพนักงาน ออก บัตร Date of Expiry 30000502021140 24 Nov.2026 ",
58   "DocSize": [
59     [
60       721,
61       1200,
62       3
63     ]
64   ],
65   "ExpiryDate": {
66     "UICategory": "Card Information",
67     "UIName": "Date of Expiry",
68     "matches": [
69       {
70         "keyword": [
71           690,
72           678,
73           873,
74           711,
75           781.5,
76           694.5,
77           "Date of Expiry"
78         ],
79         "match": "24 Nov.2026",
80         "matchmulti": null,
81         "page": 0,
82         "value": [
83           690,
84           650,
85           863,
86           677,
87           776.5,
88           663.5,
89           "Date of Expiry\n24 Nov.2026"
90         ]
91       }
92     ]
93   },
94   "FirstNameE": {
95     "UICategory": "Personal Information",
96     "UIName": "Firstname (Eng)",
97     "matches": [
98       {
99         "keyword": null,
100         "match": "Miss Aranya",
101         "matchmulti": null,
102         "page": 0,
103         "value": [
104           522,
105           226,
106           763,
107           269,
108           642.5,
109           247.5,
110           "Miss Aranya"
111         ]
112       }
113     ]
114   },
115   "ID": {
116     "UICategory": "Card Information",
117     "UIName": "ID Number",
118     "matches": [
119       {
120         "keyword": null,
121         "match": "เลข ประจำ ตัว ประชาชน 13004 00124 03 9",
122         "matchmulti": null,
123         "page": 0,
124         "value": [
125           247,
126           62,
127           969,
128           137,
129           608,
130           99.5,
131           "เลข ประจำ ตัว ประชาชน 13004 00124 03 9"
132         ]
133       }
134     ]
135   },
136   "IssueDate": {
137     "UICategory": "Card Information",
138     "UIName": "Date of Issue",
139     "matches": [
140       {
141         "keyword": null,
142         "match": "288 2017",
143         "matchmulti": null,
144         "page": 0,
145         "value": [
146           150,
147           654,
148           309,
149           685,
150           229.5,
151           669.5,
152           "288 2017"
153         ]
154       }
155     ]
156   },
157   "LastNameE": {
158     "UICategory": "Personal Information",
159     "UIName": "Lastname (Eng)",
160     "matches": [
161       {
162         "keyword": [
163           411,
164           280,
165           553,
166           326,
167           482,
168           303,
169           "Last name"
170         ],
171         "match": "Saejeaw",
172         "matchmulti": null,
173         "page": 0,
174         "value": [
175           590,
176           280,
177           739,
178           328,
179           664.5,
180           304,
181           "Saejeaw"
182         ]
183       }
184     ]
185   },
186   "NameT": {
187     "UICategory": "Personal Information",
188     "UIName": "Name (Thai)",
189     "matches": [
190       {
191         "keyword": [
192           163,
193           141,
194           488,
195           236,
196           325,
197           188.5,
198           "ชื่อ ตัว และ ชื่อสกุล"
199         ],
200         "match": "น.ส. อรัญ ญา แซ่ จิ ว",
201         "matchmulti": null,
202         "page": 0,
203         "value": [
204           488,
205           141,
206           830,
207           236,
208           659,
209           188.5,
210           " น.ส. อรัญ ญา แซ่ จิ ว"
211         ]
212       }
213     ]
214   },
215   "SmallBoxes": [
216     {
217       "box": [
218         252,
219         14,
220         1193,
221         81,
222         722.5,
223         47.5,
224         "บัตร ประจำ ตัว ประชาชน Thai National ID Car"
225       ],
226       "page": 0
227     },
228     {
229       "box": [
230         247,
231         62,
232         969,
233         137,
234         608,
235         99.5,
236         "เลข ประจำ ตัว ประชาชน 13004 00124 03 9"
237       ],
238       "page": 0
239     },
240     {
241       "box": [
242         246,
243         111,
244         553,
245         144,
246         399.5,
247         127.5,
248         "Identification Number"
249       ],
250       "page": 0
251     },
252     {
253       "box": [
254         163,
255         141,
256         488,
257         236,
258         325,
259         188.5,
260         "ชื่อ ตัว และ ชื่อสกุล"
261       ],
262       "page": 0
263     },
264     {
265       "box": [
266         488,
267         141,
268         830,
269         236,
270         659,
271         188.5,
272         " น.ส. อรัญ ญา แซ่ จิ ว"
273       ],
274       "page": 0
275     },
276     {
277       "box": [
278         412,
279         226,
280         489,
281         269,
282         450.5,
283         247.5,
284         "Name"
285       ],
286       "page": 0
287     },
288     {
289       "box": [
290         522,
291         226,
292         763,
293         269,
294         642.5,
295         247.5,
296         "Miss Aranya"
297       ],
298       "page": 0
299     },
300     {
301       "box": [
302         411,
303         280,
304         553,
305         326,
306         482,
307         303,
308         "Last name"
309       ],
310       "page": 0
311     },
312     {
313       "box": [
314         590,
315         280,
316         739,
317         328,
318         664.5,
319         304,
320         "Saejeaw"
321       ],
322       "page": 0
323     },
324     {
325       "box": [
326         444,
327         328,
328         803,
329         374,
330         623.5,
331         351,
332         "เกิด วัน ที่ 25 พ.ย.2533"
333       ],
334       "page": 0
335     },
336     {
337       "box": [
338         439,
339         382,
340         666,
341         431,
342         552,
343         406.5,
344         "Date of Birth"
345       ],
346       "page": 0
347     },
348     {
349       "box": [
350         666,
351         382,
352         876,
353         431,
354         771,
355         406.5,
356         " 25 Nov.1990"
357       ],
358       "page": 0
359     },
360     {
361       "box": [
362         440,
363         437,
364         599,
365         484,
366         519.5,
367         460.5,
368         "ศาสนา พุ ท ย"
369       ],
370       "page": 0
371     },
372     {
373       "box": [
374         157,
375         473,
376         580,
377         540,
378         368.5,
379         506.5,
380         "ที่ อยู่ 50 หมู่ ที่ 3 ต . บ้าน ปรางค์"
381       ],
382       "page": 0
383     },
384     {
385       "box": [
386         157,
387         535,
388         440,
389         580,
390         298.5,
391         557.5,
392         "อ . คง จ . นครราชสีมา"
393       ],
394       "page": 0
395     },
396     {
397       "box": [
398         155,
399         586,
400         309,
401         618,
402         232,
403         602,
404         "2. ค .2560"
405       ],
406       "page": 0
407     },
408     {
409       "box": [
410         356,
411         594,
412         366,
413         631,
414         361,
415         612.5,
416         "ร"
417       ],
418       "page": 0
419     },
420     {
421       "box": [
422         694,
423         584,
424         858,
425         612,
426         776,
427         598,
428         "24 พ.ณ.2558"
429       ],
430       "page": 0
431     },
432     {
433       "box": [
434         153,
435         618,
436         277,
437         653,
438         215,
439         635.5,
440         "วัน ออก บัตร"
441       ],
442       "page": 0
443     },
444     {
445       "box": [
446         692,
447         614,
448         861,
449         654,
450         776.5,
451         634,
452         "ใน บัตร หมดอายุ"
453       ],
454       "page": 0
455     },
456     {
457       "box": [
458         150,
459         654,
460         309,
461         685,
462         229.5,
463         669.5,
464         "288 2017"
465       ],
466       "page": 0
467     },
468     {
469       "box": [
470         370,
471         645,
472         464,
473         685,
474         417,
475         665,
476         "( า ที่ ต่อ"
477       ],
478       "page": 0
479     },
480     {
481       "box": [
482         559,
483         642,
484         619,
485         682,
486         589,
487         662,
488         "ส ก็ อ )"
489       ],
490       "page": 0
491     },
492     {
493       "box": [
494         152,
495         685,
496         313,
497         715,
498         232.5,
499         700,
500         "Date of Tenue"
501       ],
502       "page": 0
503     },
504     {
505       "box": [
506         366,
507         682,
508         626,
509         716,
510         496,
511         699,
512         "เจ้าพนักงาน ออก บัตร"
513       ],
514       "page": 0
515     },
516     {
517       "box": [
518         690,
519         678,
520         873,
521         711,
522         781.5,
523         694.5,
524         "Date of Expiry"
525       ],
526       "page": 0
527     },
528     {
529       "box": [
530         911,
531         669,
532         1137,
533         700,
534         1024,
535         684.5,
536         "30000502021140"
537       ],
538       "page": 0
539     },
540     {
541       "box": [
542         691,
543         650,
544         863,
545         677,
546         777,
547         663.5,
548         "24 Nov.2026"
549       ],
550       "page": 0
551     }
552   ],
553   "num_pages": 1
554 }

Extract the structured data from a document using the Thai ID Card model in Staple. The document would NOT be left in the queue specified for any further manipulation.

Authentication

x-api-keystring

API key issued by Staple.

AuthorizationBearer

JWT obtained from the login endpoint.

Request

This endpoint expects a multipart form containing a file.

filefileRequired

File to upload

Authentication

Request

Response