Skip to main content

MyKad Recognition

Extract structured data from a Malaysian MyKad (IC) image — name, IC number, address, gender, and face photo — using OCR and image recognition.

When to Use​

▾

Use this endpoint when you:

  • Onboard a user and want to auto-fill personal details from their IC
  • Need to verify IC authenticity (tamper detection, landmark matching)
  • Initiate an eKYC flow that requires the requestID for Liveness + Face Verification

How to Use​

▾
Endpoint
POST/v3/service

Step 1: Register as a Merchant​

▾

Sign up at the RM Merchant Portal.

Step 2: Get the Signature Algorithm​

▾

Follow the Signature Algorithm guide to sign requests.

Step 3: Verify Your Signature​

▾

Confirm signing using Verify Signature.

Step 4: Send the MyKad Image​

▾

POST a Base64-encoded MyKad image. Optionally include a notify_url to receive the result via webhook callback.

Request Parameters​

▾
serviceSTRINGrequired

Service name. Set to `"ekyc"`.

Example: "ekyc"

versionSTRINGrequired

API version. Currently only `"v1"`.

Example: "v1"

functionSTRINGrequired

Function name. Set to `"id-mykad"`.

Example: "id-mykad"

requestOBJECTrequired

Recognition payload.

notify_urlSTRING

Webhook URL to receive the eKYC result asynchronously.

Example: "https://client-api/rm-ekyc-callback"

query_image_contentSTRINGrequired

MyKad image as Base64-encoded string.

Example: "<base64_image>"

Using `notify_url`

Provide a POST handler at a public URL (e.g., https://client-api/rm-ekyc-callback) and pass it as notify_url. RM will deliver the recognition result to that URL when processing completes.

Response Parameters​

▾
requestIDSTRING

Unique request ID. Use this with [Get MyKad Result](./get-mykad-result) and [Liveness + Face Verification](./liveness-check-with-face-verification).

Example: "62201d48a694817dede84b35"

Last updated on by Aiman Danish