Scan Vietnamese National ID Card

POST

https://api.staple.io/v1/documents/scan/vid

POST

/v1/documents/scan/vid

$ curl -X POST https://api.staple.io/v1/documents/scan/vid \
>      -H "x-api-key: <apiKey>" \
>      -H "Content-Type: multipart/form-data"

200Scan Vietnamese National ID Card

1 {
2   "scanDocuments": {
3     "data": {
4       "BigBoxes": [
5         {
6           "box": [
7             585,
8             210,
9             401,
10             401,
11             493,
12             305.5,
13             ""
14           ],
15           "page": 0
16         },
17         {
18           "box": [
19             410,
20             42,
21             1070,
22             337,
23             740,
24             189.5,
25             "CỘNG HÒA XÃ HỘI CHỦ NGHĨA VIỆT NAM\nĐộc lập-Tự do-Hạnh phúc\nGIẤY CHỨNG MINH NHÂN DÂN\nSO\n225918410\nHọ tên:\nNGUYỄN THỊ MỸ LINH\n"
26           ],
27           "page": 0
28         },
29         {
30           "box": [
31             386,
32             398,
33             1105,
34             708,
35             745.5,
36             553,
37             "Sinh ngày.\n05-04-1972...\nNguyên quán:\n..\nCa Nha Trang , Khánh Hòa\nNơi ĐKK thường trú :\n35 Tân Hòa ,\nVĩnh Tường , Nha Trang , Khánh Hòa\n"
38           ],
39           "page": 0
40         },
41         {
42           "box": [
43             617,
44             1216,
45             551,
46             1421,
47             584,
48             1318.5,
49             ""
50           ],
51           "page": 0
52         },
53         {
54           "box": [
55             127,
56             814,
57             259,
58             857,
59             193,
60             835.5,
61             "Dân tộc:.\n"
62           ],
63           "page": 0
64         },
65         {
66           "box": [
67             403,
68             805,
69             487,
70             847,
71             445,
72             826,
73             "Kinh\n"
74           ],
75           "page": 0
76         },
77         {
78           "box": [
79             622,
80             798,
81             1062,
82             936,
83             842,
84             867,
85             "Không\nTôn giáo:.\nDẤU VẾT RIÊNG VÀ DỊ HÌNH\n"
86           ],
87           "page": 0
88         },
89         {
90           "box": [
91             561,
92             955,
93             1111,
94             998,
95             836,
96             976.5,
97             "Sẹo chấm cách 2cm5 dưới sau\n"
98           ],
99           "page": 0
100         },
101         {
102           "box": [
103             510,
104             915,
105             479,
106             1108,
107             494.5,
108             1011.5,
109             ""
110           ],
111           "page": 0
112         },
113         {
114           "box": [
115             570,
116             1020,
117             718,
118             1062,
119             644,
120             1041,
121             "mép trái\n"
122           ],
123           "page": 0
124         },
125         {
126           "box": [
127             547,
128             1111,
129             1126,
130             1203,
131             836.5,
132             1157,
133             "01 năm 2016.\n26 tháng\nNgày\nT.KHÁNH HÒA\nGIÁM DOL SA\n"
134           ],
135           "page": 0
136         },
137         {
138           "box": [
139             557,
140             1166,
141             767,
142             1233,
143             662,
144             1199.5,
145             "GIÁM DOL SA\n"
146           ],
147           "page": 0
148         },
149         {
150           "box": [
151             510,
152             1203,
153             476,
154             1404,
155             493,
156             1303.5,
157             ""
158           ],
159           "page": 0
160         },
161         {
162           "box": [
163             615,
164             1214,
165             1087,
166             1446,
167             851,
168             1330,
169             "al\nthi chọc cuối\n"
170           ],
171           "page": 0
172         }
173       ],
174       "DOB": {
175         "UICategory": "Personal Information",
176         "UIName": "Date of Birth",
177         "matches": [
178           {
179             "keyword": [
180               409,
181               401,
182               563,
183               447,
184               486,
185               424,
186               "Sinh ngày."
187             ],
188             "match": "05-04-1972",
189             "matchmulti": null,
190             "page": 0,
191             "value": [
192               708,
193               410,
194               945,
195               447,
196               826.5,
197               428.5,
198               "05-04-1972..."
199             ]
200           }
201         ]
202       },
203       "DetectedText": "CỘNG HÒA XÃ HỘI CHỦ NGHĨA VIỆT NAM Độc lập-Tự do-Hạnh phúc GIẤY CHỨNG MINH NHÂN DÂN SO 225918410 Họ tên: NGUYỄN THỊ MỸ LINH Sinh ngày. 05-04-1972... Nguyên quán: .. Ca Nha Trang , Khánh Hòa Nơi ĐKK thường trú : 35 Tân Hòa , Vĩnh Tường , Nha Trang , Khánh Hòa Dân tộc:. Kinh Tôn giáo:. Không DẤU VẾT RIÊNG VÀ DỊ HÌNH Sẹo chấm cách 2cm5 dưới sau mép trái Ngày 26 tháng 01 năm 2016. T.KHÁNH HÒA GIÁM DOL SA al thi chọc cuối ",
204       "DocSize": [
205         [
206           1473,
207           1200,
208           3
209         ]
210       ],
211       "Domicile": {
212         "UICategory": "Personal Information",
213         "UIName": "Current Address",
214         "matches": [
215           {
216             "keyword": [
217               398,
218               466,
219               632,
220               505,
221               515,
222               485.5,
223               "Nguyên quán:"
224             ],
225             "match": "Ca Nha Trang , Khánh Hòa",
226             "matchmulti": null,
227             "page": 0,
228             "value": [
229               546,
230               466,
231               644,
232               504,
233               595,
234               485,
235               "..\nCa Nha Trang , Khánh Hòa"
236             ]
237           }
238         ]
239       },
240       "ExpiryDate": {
241         "UICategory": "Card Information",
242         "UIName": "Expiry Date",
243         "matches": [
244           {
245             "keyword": null,
246             "match": null,
247             "page": null,
248             "value": null
249           }
250         ]
251       },
252       "Gender": {
253         "UICategory": "Personal Information",
254         "UIName": "Gender",
255         "matches": [
256           {
257             "keyword": null,
258             "match": null,
259             "page": null,
260             "value": null
261           }
262         ]
263       },
264       "IdNumber": {
265         "UICategory": "Card Information",
266         "UIName": "ID Number",
267         "matches": [
268           {
269             "keyword": null,
270             "match": "225918410",
271             "matchmulti": null,
272             "page": 0,
273             "value": [
274               607,
275               201,
276               875,
277               257,
278               741,
279               229,
280               "225918410"
281             ]
282           }
283         ]
284       },
285       "IssueDate": {
286         "UICategory": "Card Information",
287         "UIName": "Issue Date",
288         "matches": [
289           {
290             "keyword": null,
291             "match": "26",
292             "page": null,
293             "value": null
294           }
295         ]
296       },
297       "IssueMonth": {
298         "UICategory": "Card Information",
299         "UIName": "Issue Month",
300         "matches": [
301           {
302             "keyword": null,
303             "match": "01",
304             "page": null,
305             "value": null
306           }
307         ]
308       },
309       "IssueYear": {
310         "UICategory": "Card Information",
311         "UIName": "Issue Year",
312         "matches": [
313           {
314             "keyword": null,
315             "match": "2016",
316             "page": null,
317             "value": null
318           }
319         ]
320       },
321       "Name": {
322         "UICategory": "Personal Information",
323         "UIName": "Full Name",
324         "matches": [
325           {
326             "keyword": [
327               407,
328               259,
329               506,
330               329,
331               456.5,
332               294,
333               "Họ tên:"
334             ],
335             "match": "SO   NGUYỄN THỊ MỸ LINH",
336             "matchmulti": null,
337             "page": 0,
338             "value": [
339               407,
340               199,
341               506,
342               248,
343               456.5,
344               223.5,
345               "SO\n225918410\nHọ tên:\nNGUYỄN THỊ MỸ LINH"
346             ]
347           }
348         ]
349       },
350       "Nationality": {
351         "UICategory": "Personal Information",
352         "UIName": "Nationality",
353         "matches": [
354           {
355             "keyword": null,
356             "match": null,
357             "page": null,
358             "value": null
359           }
360         ]
361       },
362       "PermanentAddress": {
363         "UICategory": "Personal Information",
364         "UIName": "Permanent Address",
365         "matches": [
366           {
367             "keyword": [
368               398,
369               590,
370               738,
371               634,
372               568,
373               612,
374               "Nơi ĐKK thường trú :"
375             ],
376             "match": "35 Tân Hòa , Vĩnh Tường , Nha Trang , Khánh Hòa",
377             "matchmulti": null,
378             "page": 0,
379             "value": [
380               385,
381               593,
382               1028,
383               637,
384               706.5,
385               615,
386               "35 Tân Hòa ,\nVĩnh Tường , Nha Trang , Khánh Hòa"
387             ]
388           }
389         ]
390       },
391       "SmallBoxes": [
392         {
393           "box": [
394             435,
395             45,
396             1073,
397             88,
398             754,
399             66.5,
400             "CỘNG HÒA XÃ HỘI CHỦ NGHĨA VIỆT NAM"
401           ],
402           "page": 0
403         },
404         {
405           "box": [
406             562,
407             88,
408             957,
409             124,
410             759.5,
411             106,
412             "Độc lập-Tự do-Hạnh phúc"
413           ],
414           "page": 0
415         },
416         {
417           "box": [
418             456,
419             132,
420             1063,
421             180,
422             759.5,
423             156,
424             "GIẤY CHỨNG MINH NHÂN DÂN"
425           ],
426           "page": 0
427         },
428         {
429           "box": [
430             518,
431             199,
432             560,
433             248,
434             539,
435             223.5,
436             "SO"
437           ],
438           "page": 0
439         },
440         {
441           "box": [
442             607,
443             201,
444             875,
445             257,
446             741,
447             229,
448             "225918410"
449           ],
450           "page": 0
451         },
452         {
453           "box": [
454             407,
455             259,
456             506,
457             329,
458             456.5,
459             294,
460             "Họ tên:"
461           ],
462           "page": 0
463         },
464         {
465           "box": [
466             531,
467             260,
468             1058,
469             334,
470             794.5,
471             297,
472             "NGUYỄN THỊ MỸ LINH"
473           ],
474           "page": 0
475         },
476         {
477           "box": [
478             409,
479             401,
480             563,
481             447,
482             486,
483             424,
484             "Sinh ngày."
485           ],
486           "page": 0
487         },
488         {
489           "box": [
490             708,
491             410,
492             945,
493             447,
494             826.5,
495             428.5,
496             "05-04-1972..."
497           ],
498           "page": 0
499         },
500         {
501           "box": [
502             398,
503             466,
504             632,
505             505,
506             515,
507             485.5,
508             "Nguyên quán:"
509           ],
510           "page": 0
511         },
512         {
513           "box": [
514             634,
515             466,
516             644,
517             504,
518             639,
519             485,
520             ".."
521           ],
522           "page": 0
523         },
524         {
525           "box": [
526             546,
527             530,
528             1053,
529             585,
530             799.5,
531             557.5,
532             "Ca Nha Trang , Khánh Hòa"
533           ],
534           "page": 0
535         },
536         {
537           "box": [
538             398,
539             590,
540             738,
541             634,
542             568,
543             612,
544             "Nơi ĐKK thường trú :"
545           ],
546           "page": 0
547         },
548         {
549           "box": [
550             800,
551             593,
552             1028,
553             637,
554             914,
555             615,
556             "35 Tân Hòa ,"
557           ],
558           "page": 0
559         },
560         {
561           "box": [
562             385,
563             651,
564             1105,
565             705,
566             745,
567             678,
568             "Vĩnh Tường , Nha Trang , Khánh Hòa"
569           ],
570           "page": 0
571         },
572         {
573           "box": [
574             127,
575             814,
576             259,
577             857,
578             193,
579             835.5,
580             "Dân tộc:."
581           ],
582           "page": 0
583         },
584         {
585           "box": [
586             403,
587             805,
588             487,
589             847,
590             445,
591             826,
592             "Kinh"
593           ],
594           "page": 0
595         },
596         {
597           "box": [
598             622,
599             820,
600             772,
601             866,
602             697,
603             843,
604             "Tôn giáo:."
605           ],
606           "page": 0
607         },
608         {
609           "box": [
610             903,
611             809,
612             1016,
613             853,
614             959.5,
615             831,
616             "Không"
617           ],
618           "page": 0
619         },
620         {
621           "box": [
622             640,
623             883,
624             1062,
625             928,
626             851,
627             905.5,
628             "DẤU VẾT RIÊNG VÀ DỊ HÌNH"
629           ],
630           "page": 0
631         },
632         {
633           "box": [
634             561,
635             955,
636             1111,
637             998,
638             836,
639             976.5,
640             "Sẹo chấm cách 2cm5 dưới sau"
641           ],
642           "page": 0
643         },
644         {
645           "box": [
646             570,
647             1016,
648             718,
649             1066,
650             644,
651             1041,
652             "mép trái"
653           ],
654           "page": 0
655         },
656         {
657           "box": [
658             547,
659             1112,
660             633,
661             1157,
662             590,
663             1134.5,
664             "Ngày"
665           ],
666           "page": 0
667         },
668         {
669           "box": [
670             673,
671             1109,
672             824,
673             1155,
674             748.5,
675             1132,
676             "26 tháng"
677           ],
678           "page": 0
679         },
680         {
681           "box": [
682             865,
683             1104,
684             1119,
685             1153,
686             992,
687             1128.5,
688             "01 năm 2016."
689           ],
690           "page": 0
691         },
692         {
693           "box": [
694             808,
695             1155,
696             1127,
697             1206,
698             967.5,
699             1180.5,
700             "T.KHÁNH HÒA"
701           ],
702           "page": 0
703         },
704         {
705           "box": [
706             557,
707             1166,
708             767,
709             1233,
710             662,
711             1199.5,
712             "GIÁM DOL SA"
713           ],
714           "page": 0
715         },
716         {
717           "box": [
718             802,
719             1214,
720             924,
721             1325,
722             863,
723             1269.5,
724             "al"
725           ],
726           "page": 0
727         },
728         {
729           "box": [
730             615,
731             1357,
732             1087,
733             1446,
734             851,
735             1401.5,
736             "thi chọc cuối"
737           ],
738           "page": 0
739         }
740       ],
741       "num_pages": 1
742     },
743     "docId": 8729,
744     "status": "COMPLETED"
745   }
746 }

Scan a document using the Vietnamese National ID Card model in Staple to receive the structured data extracted. The documents would 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.

filesfileRequired

File to upload

qidstringRequired

handwrittenstringRequired

Authentication

Request

Response