Malaysian Cards

Currently Supported Malaysian Cards include:

1. MyKad

2. MyTentera

3. MyKas

4. MyPR

Note: The RELIGION field is optional on Malaysian ID cards, meaning it may or may not be printed on the card. As a result, this field may also be present or absent in the response.

MyKad

Request

Request

{
  "operations": ["ocr"],
  "payload": {
    "partnerTrxId": "random-uuid",
    "groupId": "random-uuid",
    "idType": "ID_CARD",
    "country": "MYS",
    "idSubtype": "MyKad",
    "idFrontSideImage": "Base64 encoded image of ID front side"
  },
  "userConsent": {
    "userIP": "0.0.0.0",
    "country": "MYS",
    "obtained": true,
    "obtainedAt": "1680700959"
  }
}

Success Response

HTTP Status Code: 200

Success JSON Response

{
  "transactionId": "unique transaction id generated to identify this transaction",
  "partnerTrxId": "partner transaction id submitted by customer in request",
  "groupId": "partner group id submitted by customer in request",
  "imageQualityResult": {
      "statusCode": 5000
  },
  "card":{
     "country": "MALAYSIA",
     "type": "MyKad",
     "isoAlpha3CountryCode": "MYS",
     "isoAlpha2CountryCode": "MY"
  },
  "ocrResult": {
     "idNumber": "Id Number from the card",
     "name": "Name from id card",
     "address": "Address from id card",
     "dob": "Date of birth in YYYYMMDD format",
     "citizenship": "Citizenship from id card",
     "gender": "Gender from id card (M/F/O)",
     "religion": "Religion from id card",
     "address1": "address1",
     "address2": "address2",
     "zipCode": "Zip Code",
     "city": "City",
     "state": "State"
  }
}

IdNumber with '*' at the end

Note: Some MyKad cards have an * at the end of the ID number. This asterisk indicates that the ID number does not match the cardholder’s date of birth. Instead, the first six digits, which typically represent the date of birth, correspond to the date of application for the MyKad.

HTTP Status Code: 200

IdNumber with '*' - JSON Response

{
    "transactionId": "eee3452d-22de-4fd9-bcd6-fe4dbe1d2161",
    "partnerTrxId": "45a247eb-9071-4ae0-a2e8-fd91c9a9d737",
    "groupId": "9c0afec4-3951-4dd3-bd40-16703f45c82a",
    "imageQualityResult": {
        "statusCode": 5000
    },
    "card": {
        "country": "MALAYSIA",
        "type": "MyKad",
        "isoAlpha3CountryCode": "MYS",
        "isoAlpha2CountryCode": "MY"
    },
    "ocrResult": {
        "idNumber": "98xxxx-10-5115*",
        "name": "Name from id card",
        "address": "Address from id card",
        "dob": "Date of birth in YYYYMMDD format",
        "citizenship": "Citizenship from id card",
        "gender": "Gender from id card (M/F/O)",
        "religion": "Religion from id card",
    }
}

Error 5023 - IdNumber Doesn't contain a valid DOB

Note: In some cases, glare or other obstructions on MyKad cards may prevent proper extraction of the ID number, which in turn affects the extraction of the date of birth. If the ID number is occluded or not extracted correctly, the following error message will be returned.

HTTP Status Code: 400

Error 5023 - JSON Response

{
    "transactionId": "b0499f89-14e5-414a-bcda-011bf58690bd",
    "partnerTrxId": "7a3734a7-6a9c-45f3-8e7b-4d06c57905c8",
    "groupId": "1634dc4d-a2f2-4a4f-9a29-8b0ea480fa8f",
    "errors": [
        {
            "message": "Bad Quality Image , Id Number Extraction Failed",
            "code": 5023,
            "operations": [
                "ocr"
            ]
        }
    ],
    "imageQualityResult": {
        "statusCode": 5000
    },
}

Error 5026 - Extraction failed for the below ocr field. Please make sure the fields are properly visible on the card.

Note: This error is raised only for the critical fields of MyKad cards. For other fields, no error will be thrown; instead, the response will contain EXTRACTION_ERROR.

Critical Fields for MyKad cards are:

1. IdNumber

2. Name

3. DOB

4. Address

HTTP Status Code: 400

Error 5026 - Critical field extraction failed

{
    "transactionId": "6263ef65-dfe1-4396-b2cb-0b2e2adef004",
    "partnerTrxId": "b976cba6-30f4-49bc-8c89-7c9acd86d77b",
    "groupId": "aaaaaaaa",
    "errors": [
        {
            "message": "Extraction failed for the below ocr field. Please make sure the fields are properly visible on the card.",
            "code": 5026,
            "fieldName": "idNumber",  // citizenship was not mentioned as it is non critical field
            "operations": [
                "ocr"
            ]
        }
    ],
    "imageQualityResult": {
        "statusCode": 5000
    },
    "card": {
        "country": "MALAYSIA",
        "type": "MyKad",
        "isoAlpha3CountryCode": "MYS",
        "isoAlpha2CountryCode": "MY"
    },
    "ocrResult": {
        "idNumber": "EXTRACTION_ERROR", // Critical Field
        "name": "Albert",
        "address": "xyz abc xyz abc",
        "dob": "YYYYMMDD",
        "citizenship": "EXTRACTION_ERROR", // Non critical Field
        "gender": "M",
        "religion": "Religion"
    }
}

HTTP Status Code: 200

Success response - Extraction failed only for non critical field

{
    "transactionId": "1373c0d1-5b35-4d0a-9287-ca7a12c3dd54",
    "partnerTrxId": "8938b90f-ef71-41c4-b088-bebf96480fd4",
    "groupId": "aaaaaaaa",
    "imageQualityResult": {
        "statusCode": 5000
    },
    "card": {
        "country": "MALAYSIA",
        "type": "MyKad",
        "isoAlpha3CountryCode": "MYS",
        "isoAlpha2CountryCode": "MY"
    },
    "ocrResult": {
        "idNumber": "98xxxx-10-xxxx",
        "name": "Albert",
        "address": "xyz abc xyz abc",
        "dob": "YYYYMMDD",
        "citizenship": "EXTRACTION_ERROR", // Non critical field
        "gender": "M",
        "religion": "ISLAM"
    }
}

MyTentera

Request

Request

{
  "operations": ["ocr"],
  "payload": {
    "partnerTrxId": "random-uuid",
    "groupId": "random-uuid",
    "idType": "ID_CARD",
    "country": "MYS",
    "idSubtype": "MyTentera",
    "idFrontSideImage": "Base64 encoded image of ID front side"
  },
  "userConsent": {
    "userIP": "0.0.0.0",
    "country": "MYS",
    "obtained": true,
    "obtainedAt": "1680700959"
  }
}

Success Response

HTTP Status Code: 200

Success JSON Response

{
  "transactionId": "unique transaction id generated to identify this transaction",
  "partnerTrxId": "partner transaction id submitted by customer in request",
  "groupId": "partner group id submitted by customer in request",
  "imageQualityResult": {
    "statusCode": 5000
  },
  "card": {
    "country": "MALAYSIA",
    "type": "MyTentera",
    "isoAlpha3CountryCode": "MYS",
    "isoAlpha2CountryCode": "MY"
  },
  "ocrResult": {
    "idNumber": "ID-Number",
    "name": "Name",
    "address": "ADDRESS",
    "dob": "YYYYMMDD",
    "gender": "Gender from id card (M/F/O)",
    "religion": "Religion",
    "militaryId": "Military-ID",
    "militaryRank": "Military-RANK",
    "militaryDivision": "Military-DIVISION"
  }
}

Error 5023 - IdNumber Doesn't contain a valid DOB

Note: In some cases, glare or other obstructions on MyTentera cards may prevent proper extraction of the ID number, which in turn affects the extraction of the date of birth. If the ID number is occluded or not extracted correctly, the following error message will be returned.

HTTP Status Code: 400

Error 5023 - JSON Response

{
    "transactionId": "b0499f89-14e5-414a-bcda-011bf58690bd",
    "partnerTrxId": "7a3734a7-6a9c-45f3-8e7b-4d06c57905c8",
    "groupId": "1634dc4d-a2f2-4a4f-9a29-8b0ea480fa8f",
    "errors": [
        {
            "message": "Bad Quality Image , Id Number Extraction Failed",
            "code": 5023,
            "operations": [
                "ocr"
            ]
        }
    ],
    "imageQualityResult": {
        "statusCode": 5000
    },
}

Error 5026 - Extraction failed for the below ocr field. Please make sure the fields are properly visible on the card.

Note: This error is raised only for the critical fields of MyTentera cards. For other fields, no error will be thrown; instead, the response will contain EXTRACTION_ERROR.

Critical Fields for MyTentera cards are:

1. IdNumber

2. Name

3. DOB

4. Address

HTTP Status Code: 400

Error 5026 - Critical field extraction failed

{
  "transactionId": "unique transaction id generated to identify this transaction",
  "partnerTrxId": "partner transaction id submitted by customer in request",
  "groupId": "partner group id submitted by customer in request",
  "errors": [
    {
      "message": "Extraction failed for the below ocr field. Please make sure the fields are properly visible on the card.",
      "code": 5026,
      "fieldName": "idNumber",
      "operations": [
        "ocr"
      ]
    }
  ],
  "imageQualityResult": {
    "statusCode": 5000
  },
  "card": {
    "country": "MALAYSIA",
    "type": "MyTentera",
    "isoAlpha3CountryCode": "MYS",
    "isoAlpha2CountryCode": "MY"
  },
  "ocrResult": {
    "idNumber": "EXTRACTION_ERROR", // Critical Field
    "name": "Name",
    "address": "ADDRESS",
    "dob": "YYYYMMDD",
    "gender": "M",
    "religion": "EXTRACTION_ERROR", // Non Critical Field
    "militaryId": "Military-ID",
    "militaryRank": "Military-RANK",
    "militaryDivision": "Military-DIVISION"
  }
}

HTTP Status Code: 200

Success response - Extraction failed only for non critical field

{
  "transactionId": "unique transaction id generated to identify this transaction",
  "partnerTrxId": "partner transaction id submitted by customer in request",
  "groupId": "partner group id submitted by customer in request",
  "imageQualityResult": {
    "statusCode": 5000
  },
  "card": {
    "country": "MALAYSIA",
    "type": "MyTentera",
    "isoAlpha3CountryCode": "MYS",
    "isoAlpha2CountryCode": "MY"
  },
  "ocrResult": {
    "idNumber": "ID-Number",
    "name": "Name",
    "address": "ADDRESS",
    "dob": "YYYYMMDD",
    "gender": "M",
    "religion": "EXTRACTION_ERROR", // Non Critical Field
    "militaryId": "Military-ID",
    "militaryRank": "Military-RANK",
    "militaryDivision": "Military-DIVISION"
  }
}

MyKas

Request

Request

{
  "operations": ["ocr"],
  "payload": {
    "partnerTrxId": "random-uuid",
    "groupId": "random-uuid",
    "idType": "ID_CARD",
    "country": "MYS",
    "idSubtype": "MyKas",
    "idFrontSideImage": "Base64 encoded image of ID front side"
  },
  "userConsent": {
    "userIP": "0.0.0.0",
    "country": "MYS",
    "obtained": true,
    "obtainedAt": "1680700959"
  }
}

Success Response

HTTP Status Code: 200

Success JSON Response

{
  "transactionId": "unique transaction id generated to identify this transaction",
  "partnerTrxId": "partner transaction id submitted by customer in request",
  "groupId": "partner group id submitted by customer in request",
  "imageQualityResult": {
     "statusCode": 5000
  },
  "card":{
     "country": "MALAYSIA",
     "type": "MyKas",
     "isoAlpha3CountryCode": "MYS",
     "isoAlpha2CountryCode": "MY"
  },
  "ocrResult": {
     "idNumber": "Id-Number",
     "name": "NAME",
     "address": "ADDRESS",
     "dob": "YYYYMMDD",
     "dateOfExpiry": "DateOfExpiry",
     "citizenship": "Citizenship",
     "gender": "Gender from id card (M/F/O)",
     "religion": "Religion"
  }
}

Error 5023 - IdNumber Doesn't contain a valid DOB

Note: In some cases, glare or other obstructions on MyKas cards may prevent proper extraction of the ID number, which in turn affects the extraction of the date of birth. If the ID number is occluded or not extracted correctly, the following error message will be returned.

HTTP Status Code: 400

Error 5203 - JSON Response

{
    "transactionId": "b0499f89-14e5-414a-bcda-011bf58690bd",
    "partnerTrxId": "7a3734a7-6a9c-45f3-8e7b-4d06c57905c8",
    "groupId": "1634dc4d-a2f2-4a4f-9a29-8b0ea480fa8f",
    "errors": [
        {
            "message": "Bad Quality Image , Id Number Extraction Failed",
            "code": 5023,
            "operations": [
                "ocr"
            ]
        }
    ],
    "imageQualityResult": {
        "statusCode": 5000
    },
}

Error 5026 - Extraction failed for the below ocr field. Please make sure the fields are properly visible on the card.

Note: This error is raised only for the critical fields of MyKas cards. For other fields, no error will be thrown; instead, the response will contain EXTRACTION_ERROR.

Critical Fields for MyKas cards are:

1. IdNumber

2. Name

3. DOB

4. Address

HTTP Status Code: 400

Error 5026 - Critical field extraction failed

{
  "transactionId": "unique transaction id generated to identify this transaction",
  "partnerTrxId": "partner transaction id submitted by customer in request",
  "groupId": "partner group id submitted by customer in request",
  "errors": [
    {
      "message": "Extraction failed for the below ocr field. Please make sure the fields are properly visible on the card.",
      "code": 5026,
      "fieldName": "idNumber",
      "operations": [
        "ocr"
      ]
    }
  ],
  "imageQualityResult": {
    "statusCode": 5000
  },
  "card":{
     "country": "MALAYSIA",
     "type": "MyKas",
     "isoAlpha3CountryCode": "MYS",
     "isoAlpha2CountryCode": "MY"
  },
  "ocrResult": {
     "idNumber": "EXTRACTION_ERROR", // Critical Field
     "name": "NAME",
     "address": "ADDRESS",
     "dob": "YYYYMMDD",
     "dateOfExpiry": "DateOfExpiry",
     "citizenship": "Citizenship",
     "gender": "Gender from id card (M/F/O)",
     "religion": "EXTRACTION_ERROR" // Non Critical Field
  }
}

HTTP Status Code: 200

Success response - Extraction failed only for non critical field

{
  "transactionId": "unique transaction id generated to identify this transaction",
  "partnerTrxId": "partner transaction id submitted by customer in request",
  "groupId": "partner group id submitted by customer in request",
  "imageQualityResult": {
    "statusCode": 5000
  },
  "card":{
     "country": "MALAYSIA",
     "type": "MyKas",
     "isoAlpha3CountryCode": "MYS",
     "isoAlpha2CountryCode": "MY"
  },
  "ocrResult": {
     "idNumber": "Id-Number",
     "name": "NAME",
     "address": "ADDRESS",
     "dob": "YYYYMMDD",
     "dateOfExpiry": "DateOfExpiry",
     "citizenship": "Citizenship",
     "gender": "Gender from id card (M/F/O)",
     "religion": "EXTRACTION_ERROR" // Non Critical Field
  }
}

MyPR

Request

Request

{
  "operations": ["ocr"],
  "payload": {
    "partnerTrxId": "random-uuid",
    "groupId": "random-uuid",
    "idType": "ID_CARD",
    "country": "MYS",
    "idSubtype": "MyPR",
    "idFrontSideImage": "Base64 encoded image of ID front side"
  },
  "userConsent": {
    "userIP": "0.0.0.0",
    "country": "MYS",
    "obtained": true,
    "obtainedAt": "1680700959"
  }
}

Success Response

HTTP Status Code: 200

Success JSON Response

{
  "transactionId": "unique transaction id generated to identify this transaction",
  "partnerTrxId": "partner transaction id submitted by customer in request",
  "groupId": "partner group id submitted by customer in request",
  "imageQualityResult": {
    "statusCode": 5000
  },
  "card":{
     "country": "MALAYSIA",
     "type": "MyPR",
     "isoAlpha3CountryCode": "MYS",
     "isoAlpha2CountryCode": "MY"
  },
  "ocrResult": {
     "idNumber": "Id-Number",
     "name": "NAME",
     "address": "ADDRESS",
     "dob": "YYYYMMDD",
     "citizenship": "Citizenship",
     "gender": "Gender from id card (M/F/O)",
     "religion": "Religion"
  }
}

Error 5023 - IdNumber Doesn't contain a valid DOB

Note: In some cases, glare or other obstructions on MyPR cards may prevent proper extraction of the ID number, which in turn affects the extraction of the date of birth. If the ID number is occluded or not extracted correctly, the following error message will be returned.

HTTP Status Code: 400

Error 5023 - JSON Response

{
    "transactionId": "b0499f89-14e5-414a-bcda-011bf58690bd",
    "partnerTrxId": "7a3734a7-6a9c-45f3-8e7b-4d06c57905c8",
    "groupId": "1634dc4d-a2f2-4a4f-9a29-8b0ea480fa8f",
    "errors": [
        {
            "message": "Bad Quality Image , Id Number Extraction Failed",
            "code": 5023,
            "operations": [
                "ocr"
            ]
        }
    ],
    "imageQualityResult": {
        "statusCode": 5000
    },
}

Error 5026 - Extraction failed for the below ocr field. Please make sure the fields are properly visible on the card.

Note: This error is raised only for the critical fields of MyPR cards. For other fields, no error will be thrown; instead, the response will contain EXTRACTION_ERROR.

Critical Fields for MyPR cards are:

1. IdNumber

2. Name

3. DOB

4. Address

HTTP Status Code: 400

Error 5026 - Critical field extraction failed

{
  "transactionId": "unique transaction id generated to identify this transaction",
  "partnerTrxId": "partner transaction id submitted by customer in request",
  "groupId": "partner group id submitted by customer in request",
  "errors": [
    {
      "message": "Extraction failed for the below ocr field. Please make sure the fields are properly visible on the card.",
      "code": 5026,
      "fieldName": "idNumber",
      "operations": [
        "ocr"
      ]
    }
  ],
  "imageQualityResult": {
    "statusCode": 5000
  },
  "card":{
     "country": "MALAYSIA",
     "type": "MyPR",
     "isoAlpha3CountryCode": "MYS",
     "isoAlpha2CountryCode": "MY"
  },
  "ocrResult": {
     "idNumber": "EXTRACTION_ERROR", // Critical Field
     "name": "NAME",
     "address": "ADDRESS",
     "dob": "YYYYMMDD",
     "citizenship": "Citizenship",
     "gender": "Gender from id card (M/F/O)",
     "religion": "EXTRACTION_ERROR" // Non Critical Field
  }
}

HTTP Status Code: 200

Success response - Extraction failed only for non critical field

{
  "transactionId": "unique transaction id generated to identify this transaction",
  "partnerTrxId": "partner transaction id submitted by customer in request",
  "groupId": "partner group id submitted by customer in request",
  "imageQualityResult": {
    "statusCode": 5000
  },
  "card":{
     "country": "MALAYSIA",
     "type": "MyPR",
     "isoAlpha3CountryCode": "MYS",
     "isoAlpha2CountryCode": "MY"
  },
  "ocrResult": {
     "idNumber": "Id-Number",
     "name": "NAME",
     "address": "ADDRESS",
     "dob": "YYYYMMDD",
     "citizenship": "Citizenship",
     "gender": "Gender from id card (M/F/O)",
     "religion": "EXTRACTION_ERROR" // Non Critical Field
  }
}