Centralized OkayID
OkayID is used to perform OCR extraction and identify the document type.
Overview
The user will need to provide the input (input 2 in the flow chart) to be able to test the API. The main purpose of this API is to perform OCR and extract the data from the ID card. It will output the extracted data for the user to check on the extracted information.
The API will also return cropped ID cards from the submitted image and cropped portraits from the ID card. Users will also need to follow a set of rules that can be found here to make sure the result is accurate.
Steps:
User will need to use the JourneyId gotten from the previous API (Create JourneyId)
Place the JourneyId and the content for the respective data in the API Method by following the Example.
The parameter descriptions can be found in the API Method after expansion.
The average processing time is about 5 to 10 seconds.
Important Note
Please take note that ^ will be part of the response from OkayID API.
^ indicates a NEW LINE.
e.g. Name from Malaysia - MyKad
Basic Validation Rule
Malaysia
MyKad, MyKas,MyTentera, MyPR, MyKid
ID Number
2
Must be 12 digits
Malaysia
MyKad, MyKas,MyTentera, MyPR, MyKid
Name
25
1) Numeric is not allow 2) Special Character ONLY allow /.@'^()
Malaysia
MyKad, MyKas,MyTentera, MyPR, MyKid
DOB
5
1) Day from 0 - 31 2) Month from 0 - 12 3) Between Year from 1900 - 2100
API Method
POST https://ekycportaldemo.innov8tif.com/api/ekyc/okayid
Request Body
docTypeEnabled
boolean
Set to True - document type will be returned
backImage
string
Back id card image in base64
cambodia
boolean
Set to True if it is Cambodia ID Card
faceImageEnabled
boolean
Set to True - Cropped face image will be returned
imageEnabled
boolean
Set to True - Cropped document image will be returned
imageFormat
string
Set to JPG, JPEG, PNG, BMP, GIF, TIFF, TIF depending of the image format OR leave it blank if not sure
base64ImageString*
string
Front id card/passport image in base64
journeyId*
string
Retrieve from 'Create JourneyID' API
{
"status": "success",
"message": "",
"result": [
{
"ListVerifiedFields": {
"pFieldMaps": [
{
"wLCID": 0,
"FieldType": 1,
"wFieldType": 1,
"Field_MRZ": null,
"Field_Visual": "MYS",
"Field_Barcode": null,
"Matrix": [
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
]
},
{
"wLCID": 0,
"FieldType": 2,
"wFieldType": 2,
"Field_MRZ": null,
"Field_Visual": "861200556488",
"Field_Barcode": null,
"Matrix": [
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
]
},
{
"wLCID": 1086,
"FieldType": 71172108,
"wFieldType": 12,
"Field_MRZ": null,
"Field_Visual": "PEREMPUAN",
"Field_Barcode": null,
"Matrix": [
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
]
},
{
"wLCID": 0,
"FieldType": 12,
"wFieldType": 12,
"Field_MRZ": null,
"Field_Visual": "F",
"Field_Barcode": null,
"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",
"Field_Barcode": null,
"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",
"Field_Barcode": null,
"Matrix": [
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
]
},
{
"wLCID": 0,
"FieldType": 38,
"wFieldType": 38,
"Field_MRZ": null,
"Field_Visual": "Malaysia",
"Field_Barcode": null,
"Matrix": [
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
]
},
{
"wLCID": 0,
"FieldType": 57,
"wFieldType": 57,
"Field_MRZ": null,
"Field_Visual": "8612005564880202",
"Field_Barcode": null,
"Matrix": [
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
]
},
{
"wLCID": 0,
"FieldType": 433,
"wFieldType": 433,
"Field_MRZ": null,
"Field_Visual": "WARGANEGARA",
"Field_Barcode": null,
"Matrix": [
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
]
}
]
}
}
],
"documentType": "Malaysia - Id Card #2"
}Input Example
{
"journeyId":"7851b4e3-df09-4ab6-8091-xxxxxxxxxx",
"base64ImageString": "",
"backImage": "",
"imageFormat":"",
"imageEnabled":false,
"faceImageEnabled":false,
"docTypeEnabled":true
"cambodia":false
}Postman Collection
Last updated
Was this helpful?