MYKAD (Malayasian ID) Card Extraction

4 min

Introduction

This API allows you to extract the data from the MyKad ID card of Malaysia. This will help you to verify the identity of the person through the data obtained.

Sample cURL

curl --request POST \
  --url https://signzy.tech/api/v2/patrons/....patronid.../foreignidentitiesextractions \
  --header 'Accept: */*' \
  --header 'Accept-Language: en-US,en;q=0.8' \
  --header 'Authorization: <Access-Token>' \
  --header 'content-type: application/json' \
  --data '{"task":"myKad","essentials":{"files":["...url of the image of the id card..."]}}'

Parameter	Description
task	The task to be performed. For MyKad extraction, use "myKad".
essentials	The essential parameters required for the extraction.
files	An array of URLs of the image of the ID card.

Sample Response

    {
        "essentials": {
            "files": [
                "...url of the image passed during request..."
            ]
        },
        "id": "...id...",
        "patronId": "...Patron ID...",
        "task": "myKad",
        "result": {
            "address": "...address...",
            "gender": "...gender...",
            "religion": "...religion...",
            "name": "...name...",
            "idNumber": "...ID Number..."
        }
    }

Output Parameter	Description
essentials.files	An array of URLs of the images passed during the request
id	The ID of the request
patronId	The ID of the patron
task	The type of ID verification task that was performed (myKad)
result.address	The address associated with the ID card
result.gender	The gender associated with the ID card
result.religion	The religion associated with the ID card
result.name	The name associated with the ID card
result.idNumber	The ID number associated with the ID card