Version 1
POST https://okayiddemo.innov8tif.com/okayid/api/v1/ocr
Request Body
Name
Type
Description
apiKey
string
To be assigned by Innov8tif
base64ImageString
string
Front id card/passport image in base64
backImage
string
Back id card image in base64
imageFormat
string
Clarify the image format: jpg, jpeg, png, bmp, gif, tiff, tif
imageEnabled
boolean
True - Cropped image will be returned False - No image will be returned
{
"status": "success",
"message": "",
"result": [
{
"ListVerifiedFields": {
"pFieldMaps": [
{
"wLCID": 0,
"FieldType": 0,
"wFieldType": 0,
"Field_MRZ": "P",
"Field_Visual": null,
"Matrix": null
},
{
"wLCID": 0,
"FieldType": 1,
"wFieldType": 1,
"Field_MRZ": "PAK",
"Field_Visual": null,
"Matrix": null
},
{
"wLCID": 0,
"FieldType": 2,
"wFieldType": 2,
"Field_MRZ": "BJ9152173",
"Field_Visual": null,
"Matrix": null
},
{
"wLCID": 0,
"FieldType": 3,
"wFieldType": 3,
"Field_MRZ": "3/6/2023",
"Field_Visual": null,
"Matrix": null
},
{
"wLCID": 0,
"FieldType": 4,
"wFieldType": 4,
"Field_MRZ": null,
"Field_Visual": "3/7/2018",
"Matrix": null
},
{
"wLCID": 0,
"FieldType": 5,
"wFieldType": 5,
"Field_MRZ": "1/16/1985",
"Field_Visual": null,
"Matrix": null
},
{
"wLCID": 0,
"FieldType": 6,
"wFieldType": 6,
"Field_MRZ": null,
"Field_Visual": "KARACHI, PAK",
"Matrix": null
},
{
"wLCID": 0,
"FieldType": 7,
"wFieldType": 7,
"Field_MRZ": "4220179672171",
"Field_Visual": null,
"Matrix": null
},
{
"wLCID": 0,
"FieldType": 8,
"wFieldType": 8,
"Field_MRZ": "REHMAN",
"Field_Visual": null,
"Matrix": null
},
{
"wLCID": 0,
"FieldType": 9,
"wFieldType": 9,
"Field_MRZ": "FAHAD",
"Field_Visual": null,
"Matrix": null
},
{
"wLCID": 0,
"FieldType": 11,
"wFieldType": 11,
"Field_MRZ": null,
"Field_Visual": "PAKISTANI",
"Matrix": null
},
{
"wLCID": 0,
"FieldType": 12,
"wFieldType": 12,
"Field_MRZ": "M",
"Field_Visual": null,
"Matrix": null
},
{
"wLCID": 0,
"FieldType": 24,
"wFieldType": 24,
"Field_MRZ": null,
"Field_Visual": "PAKISTAN",
"Matrix": null
},
{
"wLCID": 0,
"FieldType": 25,
"wFieldType": 25,
"Field_MRZ": "REHMAN FAHAD",
"Field_Visual": null,
"Matrix": null
},
{
"wLCID": 0,
"FieldType": 26,
"wFieldType": 26,
"Field_MRZ": "PAK",
"Field_Visual": null,
"Matrix": null
},
{
"wLCID": 0,
"FieldType": 36,
"wFieldType": 36,
"Field_MRZ": "4220179672171",
"Field_Visual": null,
"Matrix": null
},
{
"wLCID": 0,
"FieldType": 38,
"wFieldType": 38,
"Field_MRZ": "Pakistan",
"Field_Visual": null,
"Matrix": null
},
{
"wLCID": 0,
"FieldType": 51,
"wFieldType": 51,
"Field_MRZ": "P<PAKREHMAN<<FAHAD<<<<<<<<<<<<<<<<<<<<<<<<<<^BJ91521738PAK8501167M23030604220179672171<54",
"Field_Visual": null,
"Matrix": null
},
{
"wLCID": 0,
"FieldType": 80,
"wFieldType": 80,
"Field_MRZ": "8",
"Field_Visual": null,
"Matrix": null
},
{
"wLCID": 0,
"FieldType": 81,
"wFieldType": 81,
"Field_MRZ": "7",
"Field_Visual": null,
"Matrix": null
},
{
"wLCID": 0,
"FieldType": 82,
"wFieldType": 82,
"Field_MRZ": "0",
"Field_Visual": null,
"Matrix": null
},
{
"wLCID": 0,
"FieldType": 84,
"wFieldType": 84,
"Field_MRZ": "4",
"Field_Visual": null,
"Matrix": null
},
{
"wLCID": 0,
"FieldType": 129,
"wFieldType": 129,
"Field_MRZ": null,
"Field_Visual": "KHALID REHMAN",
"Matrix": null
},
{
"wLCID": 0,
"FieldType": 164,
"wFieldType": 164,
"Field_MRZ": null,
"Field_Visual": "71201075793",
"Matrix": null
},
{
"wLCID": 0,
"FieldType": 165,
"wFieldType": 165,
"Field_MRZ": null,
"Field_Visual": "F0351095",
"Matrix": null
},
{
"wLCID": 0,
"FieldType": 172,
"wFieldType": 172,
"Field_MRZ": "P<PAKREHMAN<<FAHAD<<<<<<<<<<<<<<<<<<<<<<<<<<^BJ91521738PAK8501167M23030604220179672171<54",
"Field_Visual": null,
"Matrix": null
},
{
"wLCID": 0,
"FieldType": 185,
"wFieldType": 185,
"Field_MRZ": "35",
"Field_Visual": null,
"Matrix": null
},
{
"wLCID": 0,
"FieldType": 195,
"wFieldType": 195,
"Field_MRZ": "5",
"Field_Visual": null,
"Matrix": null
},
{
"wLCID": 0,
"FieldType": 364,
"wFieldType": 364,
"Field_MRZ": "33",
"Field_Visual": null,
"Matrix": null
}
]
}
}
]
}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
}Last updated
Was this helpful?