Malaysian Cards

Currently Supported Malaysian Cards include:

1. MyKad

2. MyTentera

3. MyKas

4. MyPR

MyKad

Request

Sample Request for Front Side

{
  "operations": ["idVerification"],
  "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"
  }
}

Sample Request for Front Side and Back Side

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

Success Response

HTTP Status Code: 200

Success JSON Response for Front Side Only

{
    "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": {
        "front": {
            "statusCode": 5000
        }
    },
    "card": {
        "country": "MALAYSIA",
        "type": "MyKad",
        "isoAlpha3CountryCode": "MYS",
        "isoAlpha2CountryCode": "MY"
    },
    "idVerificationResult": {
        "front": {
            "statusCode": 5000
        }
    }
}

Success JSON Response for Front Side and Back Side

{
    "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": {
        "front": {
            "statusCode": 5000
        },
        "back": {
            "statusCode": 5000
        }
    },
    "card": {
        "country": "MALAYSIA",
        "type": "MyKad",
        "isoAlpha3CountryCode": "MYS",
        "isoAlpha2CountryCode": "MY"
    },
    "idVerificationResult": {
        "front": {
            "statusCode": 5000
        },
        "back": {
            "statusCode": 5000
        }
    }
}

Forged Card Response

HTTP Status Code: 400

Forged Card 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",
  "errors": [
      {
        "message": "The card appears to be forged.",
        "code": 5024,
        "operations": [
            "idVerification"
        ]
      }
  ],
  "imageQualityResult": {
    "front": {
      "statusCode": 5000
    }
  }
}

Landmark Response

HTTP Status Code: 200

Landmark Card 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",
    "errors": [
        {
            "message": "The card failed the idVerification",
            "code": 5025,
            "operations": [
                "idVerification"
            ]
        }
    ],
    "imageQualityResult": {
        "front": {
            "statusCode": 5000
        }
    }
}

Spoof Response

HTTP Status Code: 400

Spoof Card 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",
  "errors": [
      {
            "message": "Spoof check failed. Image submitted is either B&W or Photocopy",
            "code": 5602,
            "operations": [
                "idVerification"
            ]
        },
        {
            "message": "Spoof check failed. Image submitted is Recaptured",
            "code": 5601,
            "operations": [
                "idVerification"
            ]
        },
        {
            "message": "Spoof check failed. Image submitted is color reprint",
            "code": 5603,
            "operations": [
                "idVerification"
            ]
        }
  ],
  "imageQualityResult": {
    "front": {
      "statusCode": 5000
    }
  }
}

MyTentera

Note:

• There are two versions of MyTentera cards: an old version and a new version. The old version does not have a ghost image.

• The ghost image is considered an optional landmark—if detected, it will be included in the response; otherwise, it will be omitted without triggering any IDV failure.

Request

Sample Request for Front Side

{
  "operations": ["idVerification"],
  "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"
  }
}

Sample Request for Front Side and Back Side

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

Success Response

HTTP Status Code: 200

Success JSON Response for Front Side Only

{
    "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": {
        "front": {
            "statusCode": 5000
        }
    },
    "card": {
        "country": "MALAYSIA",
        "type": "MyTentera",
        "isoAlpha3CountryCode": "MYS",
        "isoAlpha2CountryCode": "MY"
    },
    "idVerificationResult": {
        "front": {
            "statusCode": 5000
        }
    }
}

Success JSON Response for Front Side and Back Side

{
    "transactionId": "a67331e2-9f4d-417a-9289-6ed1af79f567",
    "partnerTrxId": "28415b48-9b69-4311-81bc-6b593ce6490f",
    "groupId": "c6547fe1-0694-4d8a-b9bc-dfa1aee13057",
    "imageQualityResult": {
        "front": {
            "statusCode": 5000
        },
        "back": {
            "statusCode": 5000
        }
    },
    "card": {
        "country": "MALAYSIA",
        "type": "MyTentera",
        "isoAlpha3CountryCode": "MYS",
        "isoAlpha2CountryCode": "MY"
    },
    "idVerificationResult": {
        "front": {
            "statusCode": 5000
        },
        "back": {
            "statusCode": 5000
        }
    }
}

Landmark Response

HTTP Status Code: 200

Landmark Card 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",
  "errors": [
      {
        "message": "The card failed the idVerification",
        "code": 5025,
        "operations": [
            "idVerification"
        ]
      }
  ],
  "imageQualityResult": {
    "front": {
      "statusCode": 5000
    }
  }
}

Spoof Response

HTTP Status Code: 400

Spoof Card 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",
  "errors": [
       {
          "message": "Spoof check failed. Image submitted is either B&W or Photocopy",
          "code": 5602,
          "operations": [
              "idVerification"
          ]
       },
       {
          "message": "Spoof check failed. Image submitted is Recaptured",
          "code": 5601,
          "operations": [
              "idVerification"
          ]
       },
       {
            "message": "Spoof check failed. Image submitted is color reprint",
            "code": 5603,
            "operations": [
                "idVerification"
            ]
        }
  ],
  "imageQualityResult": {
    "front": {
      "statusCode": 5000
    }
  }
}

MyKas

Request

Sample Request for Front Side

{
  "operations": ["idVerification"],
  "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"
  }
}

Sample Request for Front Side and Back Side

{
  "operations": ["idVerification"],
  "payload": {
    "partnerTrxId": "random-uuid",
    "groupId": "random-uuid",
    "idType": "ID_CARD",
    "country": "MYS",
    "idSubtype": "MyKas",
    "idFrontSideImage": "Base64 encoded image of ID front side",
    "idBackSideImage": "Base64 encoded image of ID back side" //if enabled
  },
  "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": {
        "front": {
            "statusCode": 5000
        }
    },
    "card": {
        "country": "MALAYSIA",
        "type": "MyKas",
        "isoAlpha3CountryCode": "MYS",
        "isoAlpha2CountryCode": "MY"
    },
    "idVerificationResult": {
        "front": {
            "statusCode": 5000
        }
    }
}

Sample Request for Front Side and Back Side

{
   "transactionId": "0f24d08f-273a-40d9-88d4-4f56895303b1",
    "partnerTrxId": "10d3469b-6aa1-4dc4-8b49-7031446fd222",
    "groupId": "5a16a0c5-61d8-4c2c-8a45-4d7d242a01db",
    "imageQualityResult": {
        "front": {
            "statusCode": 5000
        },
        "back": {
            "statusCode": 5000
        }
    },
    "card": {
        "country": "MALAYSIA",
        "type": "MyKas",
        "isoAlpha3CountryCode": "MYS",
        "isoAlpha2CountryCode": "MY"
    },
    "idVerificationResult": {
        "front": {
            "statusCode": 5000
        },
        "back": {
            "statusCode": 5000
        }
    }
}

Landmark Response

HTTP Status Code: 200

Landmark Card 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",
  "errors": [
      {
        "message": "The card failed the idVerification",
        "code": 5025,
        "operations": [
            "idVerification"
        ]
      }
  ],
  "imageQualityResult": {
    "front": {
      "statusCode": 5000
    }
  }
}

Spoof Response

HTTP Status Code: 400

Spoof Card 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",
  "errors": [
        {
            "message": "Spoof check failed. Image submitted is either B&W or Photocopy",
            "code": 5602,
            "operations": [
                "idVerification"
            ]
        },
        {
            "message": "Spoof check failed. Image submitted is Recaptured",
            "code": 5601,
            "operations": [
                "idVerification"
            ]
        },
        {
            "message": "Spoof check failed. Image submitted is color reprint",
            "code": 5603,
            "operations": [
                "idVerification"
            ]
        }
  ],
  "imageQualityResult": {
    "front": {
      "statusCode": 5000
    }
  }
}

MyPR

Request

Sample Request for Front Side

{
  "operations": ["idVerification"],
  "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"
  }
}

Sample Request for Front Side and Back Side

{
  "operations": ["idVerification"],
  "payload": {
    "partnerTrxId": "random-uuid",
    "groupId": "random-uuid",
    "idType": "ID_CARD",
    "country": "MYS",
    "idSubtype": "MyPR",
    "idFrontSideImage": "Base64 encoded image of ID front side",
    "idBackSideImage": "Base64 encoded image of ID back side" //if enabled
  },
  "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": {
        "front": {
            "statusCode": 5000
        }
    },
    "card": {
        "country": "MALAYSIA",
        "type": "MyPR",
        "isoAlpha3CountryCode": "MYS",
        "isoAlpha2CountryCode": "MY"
    },
    "idVerificationResult": {
        "front": {
            "statusCode": 5000
        }
    }
}

Sample Request for Front Side and Back Side

{
    "transactionId": "a601c0ef-f07a-41f4-8a40-66a12069a27b",
    "partnerTrxId": "311ef43a-4f5d-4775-9610-e27ba981be7a",
    "groupId": "1059f8ba-16c0-479c-a94a-d98b2ef55ed9",
    "imageQualityResult": {
        "front": {
            "statusCode": 5000
        },
        "back": {
            "statusCode": 5000
        }
    },
    "card": {
        "country": "MALAYSIA",
        "type": "MyPR",
        "isoAlpha3CountryCode": "MYS",
        "isoAlpha2CountryCode": "MY"
    },
    "idVerificationResult": {
        "front": {
            "statusCode": 5000
        },
        "back": {
            "statusCode": 5000
        }
    }
}

Landmark Response

HTTP Status Code: 200

Landmark Card 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",
  "errors": [
      {
        "message": "The card failed the idVerification",
        "code": 5025,
        "operations": [
            "idVerification"
        ]
      }
  ],
  "imageQualityResult": {
    "front": {
      "statusCode": 5000
    }
  }
}

Spoof Response

HTTP Status Code: 400

Spoof Card 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",
  "errors": [
      {
            "message": "Spoof check failed. Image submitted is either B&W or Photocopy",
            "code": 5602,
            "operations": [
                "idVerification"
            ]
        },
        {
            "message": "Spoof check failed. Image submitted is Recaptured",
            "code": 5601,
            "operations": [
                "idVerification"
            ]
        },
        {
            "message": "Spoof check failed. Image submitted is color reprint",
            "code": 5603,
            "operations": [
                "idVerification"
            ]
        }
  ],
  "imageQualityResult": {
    "front": {
      "statusCode": 5000
    }
  }
}