Sample Input

Please make sure to follow the version respectively here. On the last table's column, there is a "Endpoint Version" link to follow the "version": "X" for each doctype. Please use the latest version for each doctype.

Input Example for MyKas

Request Code Block
{
    "journeyId":"7851b4e3-df09-4ab6-8091-xxxxxxxx",
    "type":"nonpassport",
    "idImageBase64Image": "",
    "version": "2",
    "docType":"mykas"
}

If the ID card is Malaysia's MyKad, additional parameters can be added as below.

Input Example for MyKad (OkayDoc Version 7)

Request Code Block
```postman_json
{
    "journeyId":"",
    "type":"nonpassport",
    "idImageBase64Image": "",
    "version": "7",
    "docType":"mykad",
    "landmarkCheck":true,
    "fontCheck":true,
    "microprintCheck":true,
    "photoSubstitutionCheck":true,
    "icTypeCheck":true,
    "colorMode":true,
    "hologram":true,
    "screenDetection":true,
    "ghostPhotoColorDetection":true,
    "idBlurDetection":true,
    "idBrightnessDetection":true,
    "otherDocList": [
 
        {
            "base64Image": "",
            "type": "with_flash"
        }
    ]
}
```

Input Example for MyKad (OkayDoc Version 7-1)

```postman_json
{
    "journeyId":"87988a23-a465-4042-a2f1-4d6294d13a92",
    "type":"nonpassport",
    "idImageBase64Image": "",
    "version": "7-1",
    "docType":"mykad",
    "landmarkCheck": true,
    "fontCheck": true,
    "microprintCheck": false,
    "photoSubstitutionCheck": true,
    "icTypeCheck": true,
    "colorMode": true,
    "hologram": false,
    "screenDetection": true,
    "ghostPhotoColorDetection": true,
    "islamFieldTamperingDetection":"true",
    "qualityCheckDetection":"false"    
}
```

Input Example for Cambodia ID

{
    "journeyId":"",
    "type":"nonpassport",
    "idImageBase64Image": "/9j/4QaMRXhpZgAATU0AKgAAAAgA..........",
    "version": "2",
    "docType":"khIdFront",
    "landmarkCheck": true,
    "idBlurDetection": true,
    "idBrightnessDetection": true,
    "colorMode": true,
    "screenDetection": true,
    "hologram": true,
    "photoSubstitutionCheck": true,
    "fontCheck": true,
    "idTamper": true
}

If the document is Cambodia's ID card, additional parameters can be added.

Lists of ID Documents that supported flash-image as a secondary image

  • MyKad Front

  • Cambodia ID Front

  • Indonesia eKTP Front

  • Hong Kong ID Front

  • China ID Front

  • Philippines Driving License

  • Singapore ID Front

  • Malaysia Driving License

  • Philippines SSS

  • Philippines UMID

Add second "with flash" image
    "otherDocList": [
        {
            "base64Image": "",
            "type": "with_flash"
        }
    ],

User will need add the chunk of code block above into the request parameter to submit second image to improve the passing rate of the Hologram Detection (requires light to increase the visibility)

Full example of image with flash (Cambodia ID Front)

{
    "journeyId":"",
    "type":"nonpassport",
    "idImageBase64Image": "/9j/4QaMRXhpZgAATU0AKgAAAAgA..........",
    "version": "2",
    "docType":"khIdFront",
    "landmarkCheck": true,
    "idBlurDetection": true,
    "idBrightnessDetection": true,
    "colorMode": true,
    "screenDetection": true,
    "hologram": true,
    "photoSubstitutionCheck": true,
    "fontCheck":true,
    "idTamper": true,
    "otherDocList": [
        {
            "base64Image": "",
            "type": "with_flash"
        }
    ],
}

Last updated