GET EKYC Result

Retrieve the consolidated eKYC verification result — combining MyKad recognition, face comparison, and verdict — using the requestID from MyKad Recognition.

When to Use

▾

Use this endpoint when:

• You need the final eKYC verdict for a previously initiated session
• Polling for results when no webhook (notify_url) was supplied
• Auditing past eKYC outcomes

note

Prerequisite: Acquire requestID from the MyKad Recognition response.

RM eKYC Sequence Diagram: Click Here

How to Use

▾

Endpoint

POST/v3/service

Step 1: Get the Request ID

▾

Capture requestID from your prior MyKad Recognition call.

Step 2: Send the Query

▾

POST with function: "get-ekyc-result" and the id field set to your requestID.

Step 3: Read the Verdict

▾

The response includes the overall verdict, plus nested faceResult and results objects.

---

Request Parameters

▾

serviceSTRING

EKYC service

Example: "ekyc"

versionSTRING

Currently only support 'v1"

Example: "v1"

functionSTRING

Selected function

Example: "get-ekyc-result"

requestOBJECT

Refer to explanation below

idSTRING

Request ID from mykad recognition response

Example: "62201d48a694817dede84b35"

Response Parameters

▾

idSTRING

EKYC ID

Example: "62201d48a694817dede84b35"

verdictSTRING

Action required. One of: `NONE_REQUIRED`, `ATTENTION_REQUIRED`, `INCONCLUSIVE`, `RESOLVED`

Example: NONE_REQUIRED

statusSTRING

EKYC result status. One of: `SUCCESS`, `MYKAD_NOT_FOUND`, `MYKAD_SINGLE_NOT_FOUND`, `MYKAD_FACE_NOT_FOUND`, `INCOMPLETE`, `OCR_ENGINE_ERROR`, `OCR_ENGINE_CONNECTION`

Example: SUCCESS

faceActionSTRING

Action required for face compare. One of: `NONE_REQUIRED`, `ATTENTION_REQUIRED`, `INCONCLUSIVE`, `RESOLVED`

Example: NONE_REQUIRED

faceCompareRequestIdSTRING

Face Compare Request ID

Example: 62201d51239b18052126e288

faceResultOBJECT

Refer to the Face Result

Example: (Refer to explanation below)

mykadActionSTRING

Action required for MyKad recognition. One of: `NONE_REQUIRED`, `ATTENTION_REQUIRED`, `INCONCLUSIVE`, `RESOLVED`

Example: NONE_REQUIRED

mykadRequestIdSTRING

eKYC session

Example: 62201d48a694817dede84b35

reasonsARRAY

Message from EKYC engine

Example: []

resultsARRAY

Refer to the EKYC Result

Example: (Refer to explanation below)

updatedAtDATETIME

Last update date time

Example: "2022-03-03T01:43:46.155Z"

createdAtDATETIME

Create date time

Example: "2022-03-03T01:43:36.963Z"

Inside Face Result

▾

isSamePersonBOOLEAN

Check result which is same person

Example: false

similarityFLOAT

Similarity of face image and mykad

Example: 0

Inside Results

▾

durationFLOAT

Mykad Recognition Duration

Example: 3.2886

dataOBJECT

Refer to the Results Data

Example: (Refer to explanation below)

facesARRAY

Refer to the Results Faces

Example: (Refer to explanation below)

objectOBJECT

Refer to the Results Object

Example: (Refer to explanation below)

scoresOBJECT

Refer to the Results Scores

Example: (Refer to explanation below)

Inside Results Data

▾

addressOBJECT

Refer to the Address

Example: (Refer to explanation below)

genderSTRING

Gender information of mykad

Example: "MALE"

icSTRING

Mykad ID

Example: "550106-12-5821"

isMuslimBOOLEAN

Is muslim

Example: false

nameSTRING

Name in the mykad

Example: "ROWAN SEBASTIAN ATKINSON"

Inside Address

▾

addressLine1STRING

First line of address

Example: "GDW KAMPUNG BAYANGAN"

addressLine2STRING

Second line of address

Example: "80000 KENINGAU"

addressLine3STRING

Third line of address

Example: "SABAH"

citySTRING

City name

Example: "KENINGAU"

postcodeSTRING

Postcode

Example: "80000"

stateSTRING

State name

Example: "SABAH"

Inside Results Faces

▾

boxesARRAY

Refer to the boxes

Example: []

confidenceFLOAT

Confidence of detected face

Example: 1

Inside Results Object

▾

confidenceFLOAT

Confidence of detected mykad

Example: 0.9609

predictionSTRING

Type of mykad

Example: "ic_1_front"

Inside Results Scores

▾

landmarksFLOAT

Landmark score

Example: 0.5441

ocrFLOAT

OCR score

Example: 0.9033

searcherFLOAT

Mykad searcher score

Example: 0.9

totalFLOAT

Total score

Example: 0.8295