Version 3
POST
https://okayiddemo.innov8tif.com/okayid/api/v3/ocr
Request Body
Name | Type | Description |
---|---|---|
docTypeEnabled | string | Set to True - Document type will be returned. |
faceImageEnabled | string | Set to true - Cropped face image will be returned. |
imageEnabled | string | Set to True - Cropped document image will be returned. |
imageFormat | string | Clarify the image format jpg, jpeg, png, bmp, gif, tiff, tif |
backImage | string | Back id card image in base64 |
base64ImageString | string | Front id card/passport image in base64 |
apiKey | string | To be assigned by Innov8tif |
{
"status": "success",
"message": "",
"images": [
{
"Base64ImageString": "/9j/...../9k=",
"Format": ".jpg",
"LightIndex": 6,
"PageIndex": 0
},
{
"Base64ImageString": "/9j/....../Z",
"Format": ".jpg",
"LightIndex": 6,
"PageIndex": 1
}
],
"result": [
{
"ListVerifiedFields": {
"pFieldMaps": [
{
"wLCID": 0,
"FieldType": 1,
"wFieldType": 1,
"Field_MRZ": null,
"Field_Visual": "MYS",
"Matrix": [
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
]
},
{
"wLCID": 0,
"FieldType": 2,
"wFieldType": 2,
"Field_MRZ": null,
"Field_Visual": "861200556488",
"Matrix": [
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
]
},
{
"wLCID": 1086,
"FieldType": 71172108,
"wFieldType": 12,
"Field_MRZ": null,
"Field_Visual": "PEREMPUAN",
"Matrix": [
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
]
},
{
"wLCID": 0,
"FieldType": 12,
"wFieldType": 12,
"Field_MRZ": null,
"Field_Visual": "F",
"Matrix": [
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
]
},
{
"wLCID": 0,
"FieldType": 17,
"wFieldType": 17,
"Field_MRZ": null,
"Field_Visual": "NO 22 JATAN BB 3/3^NANDAR RUDIT PUCHONG^47000 PUCHONG^SELANGOR",
"Matrix": [
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
]
},
{
"wLCID": 0,
"FieldType": 25,
"wFieldType": 25,
"Field_MRZ": null,
"Field_Visual": "LIEW HEY LEE",
"Matrix": [
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
]
},
{
"wLCID": 0,
"FieldType": 38,
"wFieldType": 38,
"Field_MRZ": null,
"Field_Visual": "Malaysia",
"Matrix": [
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
]
},
{
"wLCID": 0,
"FieldType": 57,
"wFieldType": 57,
"Field_MRZ": null,
"Field_Visual": "8612005564880202",
"Matrix": [
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
]
},
{
"wLCID": 0,
"FieldType": 433,
"wFieldType": 433,
"Field_MRZ": null,
"Field_Visual": "WARGANEGARA",
"Matrix": [
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
]
}
]
}
}
],
"faceImages": "/9j/.......//Z",
"documentType": "Malaysia - Id Card #2"
}
Input Example
JSON
{
"base64ImageString": "/9j/4AAQSkZJRgAB...wEwJefc\r\nf//Z\r\n",
"backImage":"/9j/4AAQSkZJRgAB...wEwJefc\r\nf//Z\r\n",
"apiKey":"API_KEY",
"imageFormat":".jpg",
"imageEnabled":true,
"faceImageEnabled": true,
"docTypeEnabled":true
}
Last updated