# Versions ## Version 7 `POST` `https://okaydocdemo.innov8tif.com/ekyc/api/ekyc/v7/doc-verify/mykad` #### Request Body | Name | Type | Description | | ---------------------------------------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | contentSubstitution | boolean |

Default is False.
Set True to detect content substitution checking.

Note: Depreceated

| | idBrightnessDetection | boolean |

Default is False.
Set True to detect the brightness of the id image.

| | idBlurDetection | boolean |

Default is False.
Set True to detect the blurriness of id image

| | ghostPhotoColorDetection | boolean |

Default is False.
Set True to do ghost photo color detection.

| | screenDetection | boolean |

Default is False.
Set True to do screen detection.

| | hologram | boolean |

Default is False.
Set True to do hologram detection.

| | colorMode | boolean |

Default is True.
Set False to disable color checking.

| | icTypeCheck | boolean |

Default is True.
Set False to disable IC type checking.

| | photoSubstitutionCheck | boolean |

Default is True.
Set False to disable photo substitution checking.

| | microprintCheck | boolean |

Default is True.
Set False to disable microprint checking.

| | fontCheck | boolean |

Default is True.
Set False to disable font checking.

| | landmarkCheck | boolean |

Default is True.
Set False to disable landmark checking.

| | apiKey\* | string | To be assigned by Innov8tif | | idImageBase64Image\* | string |

Front id card image in base64. Refer to the link below for image requirement.

| | otherDocList | array |

"otherDocList": \[ { "base64Image": "", "type": "with\_flash" } ]

Note: To capture flash image for hologram detection purpose. It increase the chances to detect the hologram from OkayDoc.

| {% tabs %} {% tab title="200 Cropped/returned images from API can be in base64 instead of imageURL based on requirement." %} ``` { "status": "success", "messageCode": "api.success", "message": "", "id": "848a9a59-3a20-4688-b560-c23f8da7caa7", "methodList": [ { "method": "landmark", "label": "Landmark Analysis Result", "componentList": [ { "code": "l-mykad-header", "label": "Kad Pengenalan Header", "value": "34.4195", "imageUrl": "/public/image/v2/848a9a59-3a20-4688-b560-c23f8da7caa7?type=l-mykad-header", "refImageUrl": null }, { "code": "l-mykad-logo", "label": "MyKad Logo", "value": "95.5827", "imageUrl": "/public/image/v2/848a9a59-3a20-4688-b560-c23f8da7caa7?type=l-mykad-logo", "refImageUrl": null }, { "code": "l-my-flag-logo", "label": "Malaysia Flag", "value": "96.8136", "imageUrl": "/public/image/v2/848a9a59-3a20-4688-b560-c23f8da7caa7?type=l-my-flag-logo", "refImageUrl": null }, { "code": "l-chip", "label": "Chip", "value": "75.511", "imageUrl": "/public/image/v2/848a9a59-3a20-4688-b560-c23f8da7caa7?type=l-chip", "refImageUrl": null }, { "code": "l-hibiscus", "label": "Hibiscus", "value": "68.65390000000001", "imageUrl": "/public/image/v2/848a9a59-3a20-4688-b560-c23f8da7caa7?type=l-hibiscus", "refImageUrl": null }, { "code": "l-msc", "label": "MSC", "value": "93.5061", "imageUrl": "/public/image/v2/848a9a59-3a20-4688-b560-c23f8da7caa7?type=l-msc", "refImageUrl": null } ] }, { "method": "font", "label": "MyKad Font Checking Result", "componentList": [ { "code": "f-id-no", "label": "ID No", "value": "Pass", "imageUrl": "/public/image/v2/848a9a59-3a20-4688-b560-c23f8da7caa7?type=f-id-no", "refImageUrl": "/public/image/v2/848a9a59-3a20-4688-b560-c23f8da7caa7?type=f-id-no-ref" } ] }, { "method": "microprint", "label": "Microprint Score", "componentList": [ { "code": "microprint", "label": "Microprint", "value": "12", "imageUrl": "/public/image/v2/848a9a59-3a20-4688-b560-c23f8da7caa7?type=microprint", "refImageUrl": null } ] }, { "method": "hologram", "label": "Hologram", "componentList": [ { "code": "hologram", "label": "Hologram", "value": "Fail,Fail", "imageUrl": "/public/image/v2/848a9a59-3a20-4688-b560-c23f8da7caa7?type=hologram", "refImageUrl": null } ] }, { "method": "substitution", "label": "Ghost Photo Comparison", "componentList": [ { "code": "substitution", "label": "Substitution Score", "value": "Pass", "imageUrl": null, "refImageUrl": null } ] }, { "method": "docType", "label": "MyKad Type", "componentList": [ { "code": "docType", "label": "IC Type", "value": "New IC", "imageUrl": null, "refImageUrl": null } ] }, { "method": "colorMode", "label": "Color Mode", "componentList": [ { "code": "colorMode", "label": "Color", "value": "Pass", "imageUrl": null, "refImageUrl": null } ] }, { "method": "screen", "label": "Screen Detection", "componentList": [ { "code": "screen", "label": "Screen Detection", "value": "Pass", "imageUrl": null, "refImageUrl": null } ] }, { "method": "holocolor", "label": "Ghost Photo Color Detection", "componentList": [ { "code": "holocolor", "label": "Ghost Photo Color Detection", "value": "Pass", "imageUrl": null, "refImageUrl": null } ] }, { "method": "idBlurDetection", "label": "ID Blur Detection", "componentList": [ { "code": "idBlurDetection", "label": "ID Blur Detection", "value": "Pass", "imageUrl": null, "refImageUrl": null } ] }, { "method": "idBrightnessDetc", "label": "ID Brightness Detection", "componentList": [ { "code": "idBrightnessDetc", "label": "ID Brightness Detection", "value": "Pass", "imageUrl": null, "refImageUrl": null } ] }, { "method": "faceBrightnessDetc", "label": "Face Brightness Detection", "componentList": [ { "code": "faceBrightnessDetc", "label": "Face Brightness Detection", "value": "Pass", "imageUrl": null, "refImageUrl": null } ] }, { "method": "contentSubstitution", "label": "Content Substitution", "componentList": [ { "code": "contentSubstitution", "label": "Content Substitution", "value": "Pass", "imageUrl": "/public/image/v2/848a9a59-3a20-4688-b560-c23f8da7caa7?type=contentSubstitution", "refImageUrl": null } ] } ], "outputImageList": [ { "tag": "holoFace", "imageUrl": "/public/image/v2/848a9a59-3a20-4688-b560-c23f8da7caa7?type=holoFace" }, { "tag": "idFace", "imageUrl": "/public/image/v2/848a9a59-3a20-4688-b560-c23f8da7caa7?type=idFace" } ] } ``` {% endtab %} {% endtabs %} #### Postman Collection {% file src="/files/8KUj7joklq3o2rA82rWk" %} OkayDoc MyKad Front v7 {% endfile %} ## Version 7-1 `POST` `https://okaydocdemo.innov8tif.com/ekyc/api/ekyc/v7-1/doc-verify/mykad` Added "Islamic field" tampering check #### Request Body | Name | Type | Description | | ---------------------------------------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | idBrightnessDetection | boolean |

Default is False.
Set True to detect the brightness of the id image.

| | idBlurDetection | boolean |

Default is False.
Set True to detect the blurriness of id image.

| | ghostPhotoColorDetection | boolean |

Default is False.
Set True to do ghost photo color detection.

| | screenDetection | boolean |

Default is False.
Set True to do screen detection.

| | hologram | boolean |

Default is False.
Set True to do hologram detection.

| | colorMode | boolean |

Default is True.
Set False to disable color checking.

| | icTypeCheck | boolean |

Default is True.
Set False to disable IC type checking.

| | photoSubstitutionCheck | boolean |

Default is True.
Set False to disable photo substitution checking.

| | microprintCheck | boolean |

Default is True.
Set False to disable microprint checking.

| | fontCheck | boolean |

Default is True.
Set False to disable font checking.

| | landmarkCheck | boolean |

Default is True.
Set False to disable landmark checking.

| | islamFieldTamperingDetection | boolean |

Default is False.
Set True to detect tampering in the religion field of the id image.

| | qualityCheckDetection | boolean |

Default is False.
Set True to check image quality of the ID image.

| | apiKey\* | string | To be assigned by Innov8tif. | | idImageBase64Image\* | string |

Front id card image in base64. Refer to the link below for image requirement.

| | otherDocList | array |

"otherDocList": \[ { "base64Image": "", "type": "with\_flash" } ]

Note: To capture flash image for hologram detection purpose. It increase the chances to detect the hologram from OkayDoc.

| {% tabs %} {% tab title="200: OK Cropped/returned images from API can be in base64 instead of imageURL based on requirement." %} ```javascript { "status": "success", "messageCode": "api.success", "message": "", "id": "e2c876a5-ccec-410f-afe8-ad16dd6344ae", "methodList": [ { "method": "landmark", "label": "Landmark Analysis Result", "componentList": [ { "code": "l-mykad-header", "label": "Kad Pengenalan Header", "value": "70.3362", "score": null, "imageBase64": null, "refImageBase64": null }, { "code": "l-mykad-logo", "label": "MyKad Logo", "value": "90.6956", "score": null, "imageBase64": null, "refImageBase64": null }, { "code": "l-my-flag-logo", "label": "Malaysia Flag", "value": "84.7683", "score": null, "imageBase64": null, "refImageBase64": null }, { "code": "l-chip", "label": "Chip", "value": "61.5383", "score": null, "imageBase64": null, "refImageBase64": null }, { "code": "l-hibiscus", "label": "Hibiscus", "value": "0", "score": null, "imageBase64": null, "refImageBase64": null }, { "code": "l-msc", "label": "MSC", "value": "93.1155", "score": null, "imageBase64": null, "refImageBase64": null } ] }, { "method": "font", "label": "MyKad Font Checking Result", "componentList": [ { "code": "f-id-no", "label": "ID No", "value": "Pass", "score": null, "imageBase64": null, "refImageBase64": null } ] }, { "method": "hologram", "label": "Hologram", "componentList": [ { "code": "hologram", "label": "Hologram", "value": "Fail", "score": null, "imageBase64": null, "refImageBase64": null } ] }, { "method": "docType", "label": "MyKad Type", "componentList": [ { "code": "docType", "label": "IC Type", "value": "Old IC", "score": null, "imageBase64": null, "refImageBase64": null } ] }, { "method": "colorMode", "label": "Color Mode", "componentList": [ { "code": "colorMode", "label": "Color", "value": "Pass", "score": null, "imageBase64": null, "refImageBase64": null } ] }, { "method": "screen", "label": "Screen Detection", "componentList": [ { "code": "screen", "label": "Screen Detection", "value": "Fail", "score": null, "imageBase64": null, "refImageBase64": null } ] }, { "method": "idBlurDetection", "label": "ID Blur Detection", "componentList": [ { "code": "idBlurDetection", "label": "ID Blur Detection", "value": "Pass", "score": null, "imageBase64": null, "refImageBase64": null } ] }, { "method": "idBrightnessDetc", "label": "ID Brightness Detection", "componentList": [ { "code": "idBrightnessDetc", "label": "ID Brightness Detection", "value": "Pass", "score": null, "imageBase64": null, "refImageBase64": null } ] }, { "method": "faceBrightnessDetc", "label": "Face Brightness Detection", "componentList": [ { "code": "faceBrightnessDetc", "label": "Face Brightness Detection", "value": "Pass", "score": null, "imageBase64": null, "refImageBase64": null } ] }, { "method": "islamTamperingDetc", "label": "Islam Field Tampering Detection", "componentList": [ { "code": "islamTamperingDetc", "label": "Islam Field Tampering Detection", "value": "Fail", "score": null, "imageBase64": null, "refImageBase64": null } ] } ], "outputImageList": null } ``` {% endtab %} {% endtabs %} #### Postman Collection {% file src="/files/5ksaMHB3F3rScwz9VMvh" %} OkayDoc MyKad Front v7-1 {% endfile %} ## Version 6 `POST` `https://okaydocdemo.innov8tif.com/ekyc/api/ekyc/v6/doc-verify/mykad` #### Request Body | Name | Type | Description | | ---------------------------------------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | caseNo | string | Reference code given by user | | livenessFaceBase64Image | string | Selfie image in base64 | | idBrightnessDetection | boolean |

Default is False.
Set True to detect the brightness of the id image.

| | idBlurDetection | boolean |

Default is False.
Set True to detect the blurriness of id image

| | faceBrightnessDetection | boolean |

Default is False.
Set True to detect the brightness of the face image(livenessFaceBase64Image); If livenessFaceBase64Image is not given, idImageBase64Image will be used instead.

| | ghostPhotoColorDetection | boolean |

Default is False.
Set True to do ghost photo color detection.

| | screenDetection | boolean |

Default is False.
Set True to do screen detection.

| | hologram | boolean |

Default is False.
Set True to do hologram detection.

| | colorMode | boolean |

Default is False.
Set True to do color checking.

| | icTypeCheck | boolean |

Default is False.
Set True to do IC type checking.

| | photoSubstitutionCheck | boolean |

Default is False.
Set True to do photo substitution checking.

| | microprintCheck | boolean |

Default is False.
Set True to do microprint checking.

| | fontCheck | boolean |

Default is False.
Set True to do font checking.

| | landmarkCheck | boolean |

Default is False.
Set True to do landmark checking.

| | apiKey\* | string | To be assigned by Innov8tif | | idImageBase64Image\* | string | Front id card image in base64 | | idNumber | string | Id card number as shown on id card. If this value is provided, higher chance of getting higher score for font checking. | | otherDocList | array | Type can be: high quality, with flash, without flash, with no specific order. At least one of the listed field above is required. | {% tabs %} {% tab title="200 Cropped/returned images from API can be in base64 instead of imageURL based on requirement." %} ``` { "status": "success", "messageCode": "api.success", "message": "", "id": "14d4ca15-63d7-4159-92eb-25bb2977e0e5", "methodList": [ { "method": "landmark", "label": "Landmark Analysis Result", "componentList": [ { "code": "l-mykad-header", "label": "Kad Pengenalan Header", "value": "34.4541", "imageUrl": "/public/image/v2/14d4ca15-63d7-4159-92eb-25bb2977e0e5?type=l-mykad-header", "refImageUrl": null }, { "code": "l-mykad-logo", "label": "MyKad Logo", "value": "95.68870000000001", "imageUrl": "/public/image/v2/14d4ca15-63d7-4159-92eb-25bb2977e0e5?type=l-mykad-logo", "refImageUrl": null }, { "code": "l-my-flag-logo", "label": "Malaysia Flag", "value": "95.82770000000001", "imageUrl": "/public/image/v2/14d4ca15-63d7-4159-92eb-25bb2977e0e5?type=l-my-flag-logo", "refImageUrl": null }, { "code": "l-chip", "label": "Chip", "value": "72.1268", "imageUrl": "/public/image/v2/14d4ca15-63d7-4159-92eb-25bb2977e0e5?type=l-chip", "refImageUrl": null }, { "code": "l-hibiscus", "label": "Hibiscus", "value": "69.985", "imageUrl": "/public/image/v2/14d4ca15-63d7-4159-92eb-25bb2977e0e5?type=l-hibiscus", "refImageUrl": null }, { "code": "l-msc", "label": "MSC", "value": "93.8832", "imageUrl": "/public/image/v2/14d4ca15-63d7-4159-92eb-25bb2977e0e5?type=l-msc", "refImageUrl": null } ] }, { "method": "font", "label": "MyKad Font Checking Result", "componentList": [ { "code": "f-id-no", "label": "ID No", "value": "Pass", "imageUrl": "/public/image/v2/14d4ca15-63d7-4159-92eb-25bb2977e0e5?type=f-id-no", "refImageUrl": "/public/image/v2/14d4ca15-63d7-4159-92eb-25bb2977e0e5?type=f-id-no-ref" } ] }, { "method": "microprint", "label": "Microprint Score", "componentList": [ { "code": "microprint", "label": "Microprint", "value": "12", "imageUrl": "/public/image/v2/14d4ca15-63d7-4159-92eb-25bb2977e0e5?type=microprint", "refImageUrl": null } ] }, { "method": "hologram", "label": "Hologram", "componentList": [ { "code": "hologram", "label": "Hologram", "value": "Fail,Fail", "imageUrl": "/public/image/v2/14d4ca15-63d7-4159-92eb-25bb2977e0e5?type=hologram", "refImageUrl": null } ] }, { "method": "substitution", "label": "Ghost Photo Comparison", "componentList": [ { "code": "substitution", "label": "Substitution Score", "value": "0", "imageUrl": null, "refImageUrl": null } ] }, { "method": "docType", "label": "MyKad Type", "componentList": [ { "code": "docType", "label": "IC Type", "value": "New IC", "imageUrl": null, "refImageUrl": null } ] }, { "method": "colorMode", "label": "Color Mode", "componentList": [ { "code": "colorMode", "label": "Color", "value": "Pass", "imageUrl": null, "refImageUrl": null } ] }, { "method": "screen", "label": "Screen Detection", "componentList": [ { "code": "screen", "label": "Screen Detection", "value": "Pass", "imageUrl": null, "refImageUrl": null } ] }, { "method": "holocolor", "label": "Ghost Photo Color Detection", "componentList": [ { "code": "holocolor", "label": "Ghost Photo Color Detection", "value": "Pass", "imageUrl": null, "refImageUrl": null } ] }, { "method": "idBlurDetection", "label": "ID Blur Detection", "componentList": [ { "code": "idBlurDetection", "label": "ID Blur Detection", "value": "Pass", "imageUrl": null, "refImageUrl": null } ] }, { "method": "idBrightnessDetc", "label": "ID Brightness Detection", "componentList": [ { "code": "idBrightnessDetc", "label": "ID Brightness Detection", "value": "Pass", "imageUrl": null, "refImageUrl": null } ] }, { "method": "faceBrightnessDetc", "label": "Face Brightness Detection", "componentList": [ { "code": "faceBrightnessDetc", "label": "Face Brightness Detection", "value": "Pass", "imageUrl": null, "refImageUrl": null } ] } ], "outputImageList": [ { "tag": "holoFace", "imageUrl": "/public/image/v2/14d4ca15-63d7-4159-92eb-25bb2977e0e5?type=holoFace" }, { "tag": "idFace", "imageUrl": "/public/image/v2/14d4ca15-63d7-4159-92eb-25bb2977e0e5?type=idFace" } } ``` {% endtab %} {% endtabs %} #### Postman Collection {% file src="/files/NYMLkgCI3rlzhLsc3hKg" %} OkayDoc MyKad Front v6 {% endfile %} ## Version 5.1 (Deprecated) This version will no longer be maintained starting 1st August 2021. `POST` `https://okaydocdemo.innov8tif.com/ekyc/api/ekyc/v5-1/doc-verify/mykad` #### Request Body | Name | Type | Description | | ---------------------------------------------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------- | | caseNo | string | Reference code given by user | | ghostPhotoColorDetection | string |

Default as False.
Set True to do ghost photo color detection.

| | screenDetection | string |

Default as False.
Set True to do screen detection.

| | edgeDetection | string |

Default as False.
Set True to do edge detection.

| | hologram | string |

Default as False.
Set True to do hologram detection.

| | colorMode | string |

Default as False.
Set True to do color checking.

| | icTypeCheck | string |

Default as False.
Set True to do IC type checking.

| | photoSubstitutionCheck | string |

Default as False.
Set True to do photo substitution checking.

| | microprintCheck | string |

Default as False.
Set True to do microprint checking.

| | fontCheck | string |

Default as False.
Set True to do font checking.

| | landmarkCheck | string |

Default as False.
Set True to do landmark checking.

| | apiKey\* | string | To be assigned by Innov8tif | | idImageBase64Image\* | string | Front id card image in base64 | | idNumber | string | Id card number as shown on id card. If this value is provided, higher chance of getting higher score for font checking. | | otherDocList | array | Type can be: high quality, with flash, without flash, with no specific order. At least one of the listed field above is required. | {% tabs %} {% tab title="200 " %} ``` { "status": "success", "messageCode": "api.success", "message": "", "id": "f5a2b235-3e05-45dd-9ca2-0afe4476a0d6", "methodList": [ { "method": "landmark", "label": "Landmark Analysis Result", "componentList": [ { "code": "l-mykad-header", "label": "Kad Pengenalan Header", "value": "62.883500000000005", "imageUrl": "/public/image/v2/xxxxxxxxxxxxxxxxxx?type=l-mykad-header", "refImageUrl": null }, { "code": "l-mykad-logo", "label": "MyKad Logo", "value": "86.7302", "imageUrl": "/public/image/v2/xxxxxxxxxxxxxxxxx?type=l-mykad-logo", "refImageUrl": null }, { "code": "l-my-flag-logo", "label": "Malaysia Flag", "value": "93.38260000000001", "imageUrl": "/public/image/v2/xxxxxxxxxxxxxxxxx?type=l-my-flag-logo", "refImageUrl": null }, { "code": "l-chip", "label": "Chip", "value": "80.6771", "imageUrl": "/public/image/v2/xxxxxxxxxxxxxxxxx?type=l-chip", "refImageUrl": null }, { "code": "l-hibiscus", "label": "Hibiscus", "value": "74.3468", "imageUrl": "/public/image/v2/xxxxxxxxxxxxxxxxx?type=l-hibiscus", "refImageUrl": null }, { "code": "l-msc", "label": "MSC", "value": "89.17439999999999", "imageUrl": "/public/image/v2/xxxxxxxxxxxxxxxxxxxx?type=l-msc", "refImageUrl": null } ] }, { "method": "belowImageText", "label": "Text Below IC Face", "componentList": [ { "code": "belowImageText", "label": "Text Below IC Face", "value": " None ", "imageUrl": "/public/image/v2/xxxxxxxxxxxxxxxxxx?type=belowImageText", "refImageUrl": null } ] }, { "method": "font", "label": "MyKad Font Checking Result", "componentList": [ { "code": "f-id-no", "label": "ID No", "value": "Pass", "imageUrl": "/public/image/v2/xxxxxxxxxxxxxxx?type=f-id-no", "refImageUrl": "/public/image/v2/xxxxxxxxxxxxxxxxxxx?type=f-id-no-ref" } ] }, { "method": "microprint", "label": "Microprint Score", "componentList": [ { "code": "microprint", "label": "Microprint", "value": "9", "imageUrl": "/public/image/v2/xxxxxxxxxxxxxx?type=microprint", "refImageUrl": null } ] }, { "method": "hologram", "label": "Hologram", "componentList": [ { "code": "hologram", "label": "Hologram", "value": "Hologram Visible,Hologram Visible", "imageUrl": "/public/image/v2/xxxxxxxxxxxxxxx?type=hologram", "refImageUrl": null } ] }, { "method": "substitution", "label": "Ghost Photo Comparison", "componentList": [ { "code": "substitution", "label": "Substitution Score", "value": "86.63142", "imageUrl": null, "refImageUrl": null } ] }, { "method": "docType", "label": "MyKad Type", "componentList": [ { "code": "docType", "label": "IC Type", "value": "New IC", "imageUrl": null, "refImageUrl": null } ] }, { "method": "colorMode", "label": "Color Mode", "componentList": [ { "code": "colorMode", "label": "Color", "value": "Colored Image", "imageUrl": null, "refImageUrl": null } ] }, { "method": "edge", "label": "Edge Detection", "componentList": [ { "code": "edge", "label": "Edge Detection", "value": "Edge Not Detected,Edge Not Detected", "imageUrl": null, "refImageUrl": null } ] }, { "method": "screen", "label": "Screen Detection", "componentList": [ { "code": "screenDetection", "label": "Screen Detection", "value": "Cautious", "imageUrl": null, "refImageUrl": null } ] }, { "method": "ghostPhotoColorDetection", "label": "Ghost Photo Color Detection", "componentList": [ { "code": "ghostPhotoColorDetection", "label": "Ghost Photo Color Detection", "value": "Pass", "imageUrl": null, "refImageUrl": null } ] } ], "outputImageList": [ { "tag": "holoFace", "imageUrl": "/public/image/v2/xxxxxxxxxxxxx?type=holoFace" }, { "tag": "idFace", "imageUrl": "/public/image/v2/xxxxxxxxxxxxxx?type=idFace" } ] } ``` {% endtab %} {% tab title="400: Bad Request " %} ```javascript { // Response } ``` {% endtab %} {% tab title="500: Internal Server Error " %} ```javascript { // Response } ``` {% endtab %} {% endtabs %} #### Postman Collection {% file src="/files/LFSeg3LaZvk0o7jOe7MD" %} OkayDoc MyKad Front v5.1 {% endfile %} ## Version 5 (Deprecated) This version will no longer be maintained starting 1st August 2021. `POST` `https://okaydocdemo.innov8tif.com/ekyc/api/ekyc/v5/doc-verify/mykad` #### Request Body | Name | Type | Description | | ---------------------------------------------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------- | | caseNo | string | Reference code given by user | | apiKey\* | string | To be assigned by Innov8tif | | idImageBase64Image\* | string | Front id card image in base64 | | idNumber | string | Id card number as shown on id card. If this value is provided, higher chance of getting higher score for font checking. | | otherDocList | array | Type can be: high quality, with flash, without flash, without specific order. At least one of the listed field above is required. | | landmarkCheck | string |

Default as Fault.
Set true to do landmark checking.

| | fontCheck | string |

Default as Fault.
Set true to do font checking.

| | microprintCheck | string |

Default as Fault.
Set true to do microprint checking.

| | photoSubstitutionCheck | string |

Default as Fault.
Set true to do photo substitution checking.

| | icTypeCheck | string |

Default as Fault.
Set true to do ic type checking.

| | colorMode | string |

Default as Fault.
Set true to do color checking.

| | hologram | string |

Default as Fault.
Set true to do hologram checking.

| | edgeDetection | string |

Default as Fault.
Set true to do edge detection

| {% tabs %} {% tab title="200 " %} ``` { "status": "success", "messageCode": "api.success", "message": "", "id": "5f5d2f2d-ae72-456c-ab67-e1118d3b3f2f", "methodList": [ { "method": "landmark", "label": "Landmark Analysis Result", "componentList": [ { "code": "l-mykad-header", "label": "Kad Pengenalan Header", "value": "76.7508", "imageUrl": "/public/image/v2/5f5d2f2d-ae72-456c-ab67-e1118d3b3f2f?type=l-mykad-header", "refImageUrl": null }, { "code": "l-mykad-logo", "label": "MyKad Logo", "value": "69.0792", "imageUrl": "/public/image/v2/5f5d2f2d-ae72-456c-ab67-e1118d3b3f2f?type=l-mykad-logo", "refImageUrl": null }, { "code": "l-my-flag-logo", "label": "Malaysia Flag", "value": "83.2025", "imageUrl": "/public/image/v2/5f5d2f2d-ae72-456c-ab67-e1118d3b3f2f?type=l-my-flag-logo", "refImageUrl": null }, { "code": "l-chip", "label": "Chip", "value": "54.8358", "imageUrl": "/public/image/v2/5f5d2f2d-ae72-456c-ab67-e1118d3b3f2f?type=l-chip", "refImageUrl": null }, { "code": "l-hibiscus", "label": "Hibiscus", "value": "57.7256", "imageUrl": "/public/image/v2/5f5d2f2d-ae72-456c-ab67-e1118d3b3f2f?type=l-hibiscus", "refImageUrl": null }, { "code": "l-msc", "label": "MSC", "value": "83.07050000000001", "imageUrl": "/public/image/v2/5f5d2f2d-ae72-456c-ab67-e1118d3b3f2f?type=l-msc", "refImageUrl": null } ] }, { "method": "belowImageText", "label": "Text Below IC Face", "componentList": [ { "code": "belowImageText", "label": "Text Below IC Face", "value": " None ", "imageUrl": "/public/image/v2/5f5d2f2d-ae72-456c-ab67-e1118d3b3f2f?type=belowImageText", "refImageUrl": null } ] }, { "method": "font", "label": "MyKad Font Checking Result", "componentList": [ { "code": "f-id-no", "label": "ID No", "value": "0.6689989566802979", "imageUrl": "/public/image/v2/5f5d2f2d-ae72-456c-ab67-e1118d3b3f2f?type=f-id-no", "refImageUrl": "/public/image/v2/5f5d2f2d-ae72-456c-ab67-e1118d3b3f2f?type=f-id-no-ref" } ] }, { "method": "microprint", "label": "Microprint Score", "componentList": [ { "code": "microprint", "label": "Microprint", "value": "1", "imageUrl": "/public/image/v2/5f5d2f2d-ae72-456c-ab67-e1118d3b3f2f?type=microprint", "refImageUrl": null } ] }, { "method": "hologram", "label": "Hologram", "componentList": [ { "code": "hologram", "label": "Hologram", "value": "0", "imageUrl": null, "refImageUrl": null } ] }, { "method": "substitution", "label": "Ghost Photo Comparison", "componentList": [ { "code": "substitution", "label": "Substitution Score", "value": "71.4388", "imageUrl": null, "refImageUrl": null } ] }, { "method": "docType", "label": "MyKad Type", "componentList": [ { "code": "docType", "label": "IC Type", "value": "New IC", "imageUrl": null, "refImageUrl": null } ] }, { "method": "colorMode", "label": "Color Mode", "componentList": [ { "code": "colorMode", "label": "Color", "value": "Colored Image", "imageUrl": null, "refImageUrl": null } ] }, { "method": "edge", "label": "Edge Detection", "componentList": [ { "code": "edge", "label": "Edge Detection", "value": "0", "imageUrl": null, "refImageUrl": null } ] } ], "outputImageList": [ { "tag": "holoFace", "imageUrl": "/public/image/v2/5f5d2f2d-ae72-456c-ab67-e1118d3b3f2f?type=holoFace" }, { "tag": "idFace", "imageUrl": "/public/image/v2/5f5d2f2d-ae72-456c-ab67-e1118d3b3f2f?type=idFace" } ] } ``` {% endtab %} {% tab title="400: Bad Request " %} ```javascript { // Response } ``` {% endtab %} {% tab title="500: Internal Server Error " %} ```javascript { // Response } ``` {% endtab %} {% endtabs %} #### Postman Collection {% file src="/files/509sNaYjKXEtlV9QKlPB" %} OkayDoc MyKad Front v5 {% endfile %} ## Version 3 (Deprecated) This version will no longer be maintained starting 1st August 2021. ## `POST` `https://okaydocdemo.innov8tif.com/ekyc/api/ekyc/v3/doc-verify/mykad` #### Request Body | Name | Type | Description | | ---------------------------------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------- | | caseNo | string | Reference code given by user | | apiKey\* | string | To be assigned by Innov8tif | | idImageBase64Image\* | string | Front id card image in base64 | | idNumber | string | Id card number as shown on id card. If this value is provided, higher chance of getting higher score for font checking. | | otherDocList | array | Type can be: high quality, with flash, without flash, without specific order. At least one of the listed fields above is required. | | landmarkCheck | string |

Default as False.
Set true to do landmark checking .

| | fontCheck | string |

Default as False.
Set true to do font checking.

| | microprintCheck | string |

Default as False.
Set true to do microprint checking.

| | photoSubstitutionCheck | string |

Default as False.
Set true to do photo substitution checking.

| | icTypeCheck | string |

Default as False.
Set true to do ic type checking.

| | colorMode | string |

Default as False.
Set true to do color checking.

| {% tabs %} {% tab title="200 " %} ``` { "status": "success", "messageCode": "api.success", "message": "", "methodList": [{ "method": "landmark", "label": "Landmark Analysis Result", "componentList": [{ "code": "l-mykad-header", "label": "MyKad Header(Kad Pengenalan)", "value": "0.79320114851", "imageUrl": "/public/image/v2/d569a1a1-9ed2-42ea-ba8a-3f59ccd26db6?type=l-mykad-header", "refImageUrl": null }, { "code": "l-mykad-logo", "label": "MyKad Logo", "value": "0.727208554745", "imageUrl": "/public/image/v2/d569a1a1-9ed2-42ea-ba8a-3f59ccd26db6?type=l-mykad-logo", "refImageUrl": null }, { "code": "l-my-flag-logo", "label": "Malaysia Flag", "value": "0.71590679884", "imageUrl": "/public/image/v2/d569a1a1-9ed2-42ea-ba8a-3f59ccd26db6?type=l-my-flag-logo", "refImageUrl": null }, { "code": "l-chip", "label": "Chip", "value": "0.784151494503", "imageUrl": "/public/image/v2/d569a1a1-9ed2-42ea-ba8a-3f59ccd26db6?type=l-chip", "refImageUrl": null }, { "code": "l-hibiscus", "label": "Hibiscus", "value": "0.771929860115", "imageUrl": "/public/image/v2/d569a1a1-9ed2-42ea-ba8a-3f59ccd26db6?type=l-hibiscus", "refImageUrl": null }, { "code": "l-msc", "label": "MSC", "value": "0.899240195751", "imageUrl": "/public/image/v2/d569a1a1-9ed2-42ea-ba8a-3f59ccd26db6?type=l-msc", "refImageUrl": null }] }, { "method": "belowImageText", "label": "Text Below IC Face", "componentList": [{ "code": "belowImageText", "label": "Text Below IC Face", "value": "WAROANeOARA", "imageUrl": "/public/image/v2/d569a1a1-9ed2-42ea-ba8a-3f59ccd26db6?type=belowImageText", "refImageUrl": null }] }, { "method": "font", "label": "MyKad Front Checking Result", "componentList": [{ "code": "f-id-no", "label": "ID No", "value": "0.706493735313", "imageUrl": "/public/image/v2/d569a1a1-9ed2-42ea-ba8a-3f59ccd26db6?type=f-id-no", "refImageUrl": "/public/image/v2/d569a1a1-9ed2-42ea-ba8a-3f59ccd26db6?type=f-id-no-ref" }] }, { "method": "microprint", "label": "Microprint Score", "componentList": [{ "code": "microprint", "label": "Microprint", "value": "1", "imageUrl": "/public/image/v2/d569a1a1-9ed2-42ea-ba8a-3f59ccd26db6?type=microprint", "refImageUrl": null }] }, { "method": "substitution", "label": "Substitution Checking", "componentList": [{ "code": "substitution", "label": "Substitution Score", "value": "79.86243", "imageUrl": null, "refImageUrl": null }] }, { "method": "docType", "label": "MyKad Type", "componentList": [{ "code": "docType", "label": "IC Type", "value": "New IC", "imageUrl": null, "refImageUrl": null }] }, { "method": "colorMode", "label": "Color Mode", "componentList": [{ "code": "colorMode", "label": "Color", "value": "Colored Image", "imageUrl": null, "refImageUrl": null }] }], "outputImageList": [{ "tag": "holoFace", "imageUrl": "/public/image/v2/d569a1a1-9ed2-42ea-ba8a-3f59ccd26db6?type=holoFace" }, { "tag": "idFace", "imageUrl": "/public/image/v2/d569a1a1-9ed2-42ea-ba8a-3f59ccd26db6?type=idFace" }] } ``` {% endtab %} {% tab title="400: Bad Request " %} ```javascript { // Response } ``` {% endtab %} {% tab title="500: Internal Server Error " %} ```javascript { // Response } ``` {% endtab %} {% endtabs %} #### Postman Collection {% file src="/files/2OR1S6tgfnjTXW6biPYB" %} OkayDoc MyKad Front v3 {% endfile %} --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://api2-ekycapis.innov8tif.com/okaydoc/okaydoc-all/supported-documents/malaysia/mys-mykad-front/versions.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.