Scan Passport

POST

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

POST

/v1/documents/scan/passport

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

200Scan Passport

1 {
2   "scanDocuments": {
3     "data": {
4       "Code": {
5         "UICategory": "Basic Information",
6         "UIName": "Code",
7         "UIType": "Text",
8         "matches": [
9           {
10             "keyword": [
11               896,
12               2142,
13               1493,
14               2222,
15               1194,
16               2182,
17               "<< <<<<<<0",
18               "<< <<<<<<0"
19             ],
20             "match": "<< <<<<<<0",
21             "matchmulti": null,
22             "page": 0,
23             "value": [
24               896,
25               2142,
26               1493,
27               2222,
28               1194,
29               2182,
30               "<< <<<<<<0",
31               "<< <<<<<<0"
32             ]
33           }
34         ]
35       },
36       "CountryCode": {
37         "UICategory": "Basic Information",
38         "UIName": "Country Code",
39         "UIType": "Text",
40         "matches": [
41           {
42             "keyword": [
43               1039,
44               1713,
45               1179,
46               1729,
47               1109,
48               1721,
49               "Code",
50               "Κωδικός /Kodu/Code"
51             ],
52             "match": "CYP",
53             "matchmulti": null,
54             "page": 0,
55             "value": [
56               1040,
57               1731,
58               1076,
59               1749,
60               1058,
61               1740,
62               "CYP",
63               "CYP"
64             ]
65           }
66         ]
67       },
68       "DOB": {
69         "UICategory": "Basic Information",
70         "UIName": "DOB",
71         "UIType": "Date",
72         "matches": [
73           {
74             "keyword": [
75               1340,
76               1829,
77               1439,
78               1845,
79               1389.5,
80               1837,
81               "Date of Birth ( 7 )",
82               "Date of Birth ( 7 )"
83             ],
84             "match": "20/03/1991",
85             "matchmulti": null,
86             "page": 0,
87             "value": [
88               1340,
89               1844,
90               1427,
91               1868,
92               1383.5,
93               1856,
94               "20/03/1991",
95               "20/03/1991"
96             ]
97           }
98         ]
99       },
100       "DocSize": [
101         [
102           2339,
103           1654
104         ]
105       ],
106       "ExpiryDate": {
107         "UICategory": "Basic Information",
108         "UIName": "Expiry Date",
109         "UIType": "Date",
110         "matches": [
111           {
112             "keyword": [
113               1339,
114               1812,
115               1409,
116               1830,
117               1374,
118               1821,
119               "Date Gen.",
120               "Ημερ . Γένν ."
121             ],
122             "match": "20/03/1991",
123             "matchmulti": null,
124             "page": 0,
125             "value": [
126               1340,
127               1844,
128               1427,
129               1868,
130               1383.5,
131               1856,
132               "20/03/1991",
133               "20/03/1991"
134             ]
135           }
136         ]
137       },
138       "FirstName": {
139         "UICategory": "Basic Information",
140         "UIName": "First Name",
141         "UIType": "Text",
142         "matches": [
143           {
144             "keyword": [
145               891,
146               1826,
147               1094,
148               1843,
149               992.5,
150               1834.5,
151               "Names / Adi / Given Names (2)",
152               "Ονόματα /Adi/Given Names ( 2 )"
153             ],
154             "match": "ΑΔΩΝΙΣ",
155             "matchmulti": null,
156             "page": 0,
157             "value": [
158               890,
159               1845,
160               959,
161               1864,
162               924.5,
163               1854.5,
164               "ΑΔΩΝΙΣ",
165               "ΑΔΩΝΙΣ"
166             ]
167           }
168         ]
169       },
170       "Gender": {
171         "UICategory": "Basic Information",
172         "UIName": "Gender",
173         "UIType": "Text",
174         "matches": [
175           {
176             "keyword": null,
177             "match": null,
178             "page": null,
179             "value": null
180           }
181         ]
182       },
183       "IssueDate": {
184         "UICategory": "Basic Information",
185         "UIName": "Issue Date",
186         "UIType": "Date",
187         "matches": [
188           {
189             "keyword": [
190               1338,
191               1894,
192               1421,
193               1912,
194               1379.5,
195               1903,
196               "Issued on ( 6 )",
197               "Issued on ( 6 )"
198             ],
199             "match": "24/04/2013",
200             "matchmulti": null,
201             "page": 0,
202             "value": [
203               1339,
204               1915,
205               1430,
206               1934,
207               1384.5,
208               1924.5,
209               "24/04/2013",
210               "24/04/2013"
211             ]
212           }
213         ]
214       },
215       "LastName": {
216         "UICategory": "Basic Information",
217         "UIName": "Last Name",
218         "UIType": "Text",
219         "matches": [
220           {
221             "keyword": [
222               891,
223               1759,
224               1091,
225               1778,
226               991,
227               1768.5,
228               "Endvulo / Surname / Surname (1)",
229               "Endvulo/Soyadı /Surname ( 1 )"
230             ],
231             "match": "Gender ",
232             "matchmulti": null,
233             "page": 0,
234             "value": [
235               1340,
236               1760,
237               1493,
238               1777,
239               1416.5,
240               1768.5,
241               "Gender / Sex (5)",
242               "Φύλο /Cinsiyeti/Sex ( 5 )"
243             ]
244           }
245         ]
246       },
247       "Nationality": {
248         "UICategory": "Basic Information",
249         "UIName": "Nationality",
250         "UIType": "Text",
251         "matches": [
252           {
253             "keyword": [
254               890,
255               1893,
256               1112,
257               1911,
258               1001,
259               1902,
260               "Citizenship / Tabliyet / Nationality (3)",
261               "Ιθαγένεια /Tabliyet/Nationality ( 3 )"
262             ],
263             "match": "CYPRIOT",
264             "matchmulti": null,
265             "page": 0,
266             "value": [
267               889,
268               1936,
269               971,
270               1954,
271               930,
272               1945,
273               "CYPRIOT",
274               "CYPRIOT"
275             ]
276           }
277         ]
278       },
279       "PassportNumber": {
280         "UICategory": "Basic Information",
281         "UIName": "Passport Number",
282         "UIType": "Text",
283         "matches": [
284           {
285             "keyword": [
286               1229,
287               1714,
288               1514,
289               1732,
290               1371.5,
291               1723,
292               "No . Passport No / Passport No.",
293               "Αρ . Διαβατηρίου /Pasaport No/Passport No."
294             ],
295             "match": "K0012129",
296             "matchmulti": null,
297             "page": 0,
298             "value": [
299               1230,
300               1731,
301               1324,
302               1751,
303               1277,
304               1741,
305               "K00121296",
306               "K00121296"
307             ]
308           }
309         ]
310       },
311       "PlaceOfBirth": {
312         "UICategory": "Basic Information",
313         "UIName": "Place Of Birth",
314         "UIType": "Text",
315         "matches": [
316           {
317             "keyword": [
318               889,
319               1959,
320               1188,
321               1979,
322               1038.5,
323               1969,
324               "Τόπος γέννησης / Dodum veri / Place of Birth (4)",
325               "Τόπος γέννησης /Dodum veri/Place of Birth ( 4 )"
326             ],
327             "match": "LIMASSOL",
328             "matchmulti": null,
329             "page": 0,
330             "value": [
331               886,
332               1978,
333               977,
334               1998,
335               931.5,
336               1988,
337               "LIMASSOL",
338               "ΛΕΜΕΣΟΣ"
339             ]
340           }
341         ]
342       },
343       "SmallBoxes": [
344         {
345           "box": [
346             628,
347             1514,
348             652,
349             1483,
350             640,
351             1498.5,
352             "For",
353             "Για"
354           ],
355           "page": 0
356         },
357         {
358           "box": [
359             628,
360             1476,
361             653,
362             1402,
363             640.5,
364             1439,
365             "official",
366             "επίσημη"
367           ],
368           "page": 0
369         },
370         {
371           "box": [
372             628,
373             1396,
374             654,
375             1338,
376             641,
377             1367,
378             "use",
379             "χρήση"
380           ],
381           "page": 0
382         },
383         {
384           "box": [
385             650,
386             1514,
387             680,
388             1447,
389             665,
390             1480.5,
391             "Formal",
392             "Resmi"
393           ],
394           "page": 0
395         },
396         {
397           "box": [
398             651,
399             1447,
400             681,
401             1377,
402             666,
403             1412,
404             "usage",
405             "kullanış"
406           ],
407           "page": 0
408         },
409         {
410           "box": [
411             653,
412             1371,
413             682,
414             1339,
415             667.5,
416             1355,
417             "for",
418             "için"
419           ],
420           "page": 0
421         },
422         {
423           "box": [
424             684,
425             1495,
426             705,
427             1463,
428             694.5,
429             1479,
430             "For",
431             "For"
432           ],
433           "page": 0
434         },
435         {
436           "box": [
437             684,
438             1457,
439             706,
440             1394,
441             695,
442             1425.5,
443             "official",
444             "official"
445           ],
446           "page": 0
447         },
448         {
449           "box": [
450             685,
451             1390,
452             707,
453             1358,
454             696,
455             1374,
456             "use",
457             "use"
458           ],
459           "page": 0
460         },
461         {
462           "box": [
463             718,
464             1645,
465             1504,
466             1667,
467             1111,
468             1656,
469             "REPUBLIC OF CYPRUS KIBRIS CUMHURIYETI REPUBLIC OF CYPRUS",
470             "ΚΥΠΡΙΑΚΗ ΔΗΜΟΚΡΑΤΙΑ KIBRIS CUMHURIYETI REPUBLIC OF CYPRUS"
471           ],
472           "page": 0
473         },
474         {
475           "box": [
476             735,
477             1676,
478             973,
479             1693,
480             854,
481             1684.5,
482             "AIABATHPIO / PASSPORT / PASSPORT",
483             "AIABATHPIO/PASAPORT/PASSPORT"
484           ],
485           "page": 0
486         },
487         {
488           "box": [
489             892,
490             1713,
491             1000,
492             1730,
493             946,
494             1721.5,
495             "Type",
496             "Είδος /Tip/Type"
497           ],
498           "page": 0
499         },
500         {
501           "box": [
502             1039,
503             1713,
504             1179,
505             1729,
506             1109,
507             1721,
508             "Code",
509             "Κωδικός /Kodu/Code"
510           ],
511           "page": 0
512         },
513         {
514           "box": [
515             892,
516             1731,
517             901,
518             1749,
519             896.5,
520             1740,
521             "P",
522             "P"
523           ],
524           "page": 0
525         },
526         {
527           "box": [
528             1040,
529             1731,
530             1076,
531             1749,
532             1058,
533             1740,
534             "CYP",
535             "CYP"
536           ],
537           "page": 0
538         },
539         {
540           "box": [
541             891,
542             1759,
543             1091,
544             1778,
545             991,
546             1768.5,
547             "Endvulo / Surname / Surname (1)",
548             "Endvulo/Soyadı /Surname ( 1 )"
549           ],
550           "page": 0
551         },
552         {
553           "box": [
554             892,
555             1777,
556             995,
557             1796,
558             943.5,
559             1786.5,
560             "PANAGIDIS",
561             "ΠΑΝΑΓΙΔΗΣ"
562           ],
563           "page": 0
564         },
565         {
566           "box": [
567             892,
568             1802,
569             991,
570             1821,
571             941.5,
572             1811.5,
573             "PANAGIDIS",
574             "PANAGIDIS"
575           ],
576           "page": 0
577         },
578         {
579           "box": [
580             891,
581             1826,
582             1094,
583             1843,
584             992.5,
585             1834.5,
586             "Names / Adi / Given Names (2)",
587             "Ονόματα /Adi/Given Names ( 2 )"
588           ],
589           "page": 0
590         },
591         {
592           "box": [
593             890,
594             1845,
595             959,
596             1864,
597             924.5,
598             1854.5,
599             "ΑΔΩΝΙΣ",
600             "ΑΔΩΝΙΣ"
601           ],
602           "page": 0
603         },
604         {
605           "box": [
606             890,
607             1868,
608             959,
609             1885,
610             924.5,
611             1876.5,
612             "ADONIS",
613             "ADONIS"
614           ],
615           "page": 0
616         },
617         {
618           "box": [
619             890,
620             1893,
621             1112,
622             1911,
623             1001,
624             1902,
625             "Citizenship / Tabliyet / Nationality (3)",
626             "Ιθαγένεια /Tabliyet/Nationality ( 3 )"
627           ],
628           "page": 0
629         },
630         {
631           "box": [
632             891,
633             1912,
634             984,
635             1931,
636             937.5,
637             1921.5,
638             "CYPRUS",
639             "ΚΥΠΡΙΑΚΗ"
640           ],
641           "page": 0
642         },
643         {
644           "box": [
645             889,
646             1936,
647             971,
648             1954,
649             930,
650             1945,
651             "CYPRIOT",
652             "CYPRIOT"
653           ],
654           "page": 0
655         },
656         {
657           "box": [
658             889,
659             1959,
660             1188,
661             1979,
662             1038.5,
663             1969,
664             "Τόπος γέννησης / Dodum veri / Place of Birth (4)",
665             "Τόπος γέννησης /Dodum veri/Place of Birth ( 4 )"
666           ],
667           "page": 0
668         },
669         {
670           "box": [
671             886,
672             1978,
673             977,
674             1998,
675             931.5,
676             1988,
677             "LIMASSOL",
678             "ΛΕΜΕΣΟΣ"
679           ],
680           "page": 0
681         },
682         {
683           "box": [
684             891,
685             2003,
686             978,
687             2022,
688             934.5,
689             2012.5,
690             "LEMESOS",
691             "LEMESOS"
692           ],
693           "page": 0
694         },
695         {
696           "box": [
697             890,
698             2025,
699             1099,
700             2046,
701             994.5,
702             2035.5,
703             "Signature (10)",
704             "Υπογραφή /Imza/Signature ( 10 )"
705           ],
706           "page": 0
707         },
708         {
709           "box": [
710             1229,
711             1714,
712             1514,
713             1732,
714             1371.5,
715             1723,
716             "No . Passport No / Passport No.",
717             "Αρ . Διαβατηρίου /Pasaport No/Passport No."
718           ],
719           "page": 0
720         },
721         {
722           "box": [
723             1230,
724             1731,
725             1324,
726             1751,
727             1277,
728             1741,
729             "K00121296",
730             "K00121296"
731           ],
732           "page": 0
733         },
734         {
735           "box": [
736             1340,
737             1760,
738             1493,
739             1777,
740             1416.5,
741             1768.5,
742             "Gender / Sex (5)",
743             "Φύλο /Cinsiyeti/Sex ( 5 )"
744           ],
745           "page": 0
746         },
747         {
748           "box": [
749             1339,
750             1780,
751             1432,
752             1800,
753             1385.5,
754             1790,
755             "APPENIM",
756             "APPENIM"
757           ],
758           "page": 0
759         },
760         {
761           "box": [
762             1339,
763             1812,
764             1409,
765             1830,
766             1374,
767             1821,
768             "Date Gen.",
769             "Ημερ . Γένν ."
770           ],
771           "page": 0
772         },
773         {
774           "box": [
775             1415,
776             1812,
777             1514,
778             1830,
779             1464.5,
780             1821,
781             "| Date of birth I",
782             "| Dogum tarihi I"
783           ],
784           "page": 0
785         },
786         {
787           "box": [
788             1340,
789             1829,
790             1439,
791             1845,
792             1389.5,
793             1837,
794             "Date of Birth ( 7 )",
795             "Date of Birth ( 7 )"
796           ],
797           "page": 0
798         },
799         {
800           "box": [
801             1340,
802             1844,
803             1427,
804             1868,
805             1383.5,
806             1856,
807             "20/03/1991",
808             "20/03/1991"
809           ],
810           "page": 0
811         },
812         {
813           "box": [
814             1338,
815             1878,
816             1455,
817             1897,
818             1396.5,
819             1887.5,
820             "Date Ed. / Verilis",
821             "Ημερ . Έκδ . /Verilis"
822           ],
823           "page": 0
824         },
825         {
826           "box": [
827             1338,
828             1894,
829             1421,
830             1912,
831             1379.5,
832             1903,
833             "Issued on ( 6 )",
834             "Issued on ( 6 )"
835           ],
836           "page": 0
837         },
838         {
839           "box": [
840             1339,
841             1915,
842             1430,
843             1934,
844             1384.5,
845             1924.5,
846             "24/04/2013",
847             "24/04/2013"
848           ],
849           "page": 0
850         },
851         {
852           "box": [
853             1339,
854             1946,
855             1469,
856             1963,
857             1404,
858             1954.5,
859             "Expires / Müddeti /",
860             "Λήγει την /Müddeti/"
861           ],
862           "page": 0
863         },
864         {
865           "box": [
866             1341,
867             1964,
868             1424,
869             1979,
870             1382.5,
871             1971.5,
872             "Expires on ( 8 )",
873             "Expires on ( 8 )"
874           ],
875           "page": 0
876         },
877         {
878           "box": [
879             1336,
880             1981,
881             1427,
882             2003,
883             1381.5,
884             1992,
885             "24/04/2023",
886             "24/04/2023"
887           ],
888           "page": 0
889         },
890         {
891           "box": [
892             1337,
893             2012,
894             1508,
895             2031,
896             1422.5,
897             2021.5,
898             "Publisher Top / Veren makam /",
899             "Εκδ . Αρχή /Veren makam/"
900           ],
901           "page": 0
902         },
903         {
904           "box": [
905             1337,
906             2029,
907             1440,
908             2049,
909             1388.5,
910             2039,
911             "Issuing Auth. ( 9 )",
912             "Issuing Auth. ( 9 )"
913           ],
914           "page": 0
915         },
916         {
917           "box": [
918             1337,
919             2048,
920             1402,
921             2066,
922             1369.5,
923             2057,
924             "Τ.Α.Π.Μ",
925             "Τ.Α.Π.Μ"
926           ],
927           "page": 0
928         },
929         {
930           "box": [
931             1337,
932             2074,
933             1404,
934             2092,
935             1370.5,
936             2083,
937             "CRMD",
938             "C.R.M.D"
939           ],
940           "page": 0
941         },
942         {
943           "box": [
944             621,
945             2140,
946             645,
947             2170,
948             633,
949             2155,
950             "P <",
951             "P <"
952           ],
953           "page": 0
954         },
955         {
956           "box": [
957             896,
958             2142,
959             931,
960             2172,
961             913.5,
962             2157,
963             "<<",
964             "<<"
965           ],
966           "page": 0
967         },
968         {
969           "box": [
970             1349,
971             2148,
972             1494,
973             2176,
974             1421.5,
975             2162,
976             "* Multiplication table",
977             "* くくくく くくく"
978           ],
979           "page": 0
980         },
981         {
982           "box": [
983             1360,
984             2194,
985             1493,
986             2222,
987             1426.5,
988             2208,
989             "<<<<<< 0",
990             "<<<<<< 0"
991           ],
992           "page": 0
993         }
994       ],
995       "num_pages": 1
996     },
997     "docId": 8734,
998     "status": "COMPLETED"
999   }
1000 }

Scan a document using the Passport 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