GET EKYC Result

{% raw %}

POST/v3/service

Prerequisite : Acquire requestID from mykad recognition response

• RM eKYC Sequence Diagram

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

Example: (Refer to explanation below)

idString

Request ID from mykad recognition response

Example: "62201d48a694817dede84b35"

Response Parameters

• Current type in Status will be :-

  • "SUCCESS"
    
  • "MYKAD_NOT_FOUND"
    
  • "MYKAD_SINGLE_NOT_FOUND"
    
  • "MYKAD_FACE_NOT_FOUND"
    
  • "INCOMPLETE"
    
  • "OCR_ENGINE_ERROR"
    
  • "OCR_ENGINE_CONNECTION"
    

• Current type in Action will be :-

  • "NONE_REQUIRED"
    
  • "ATTENTION_REQUIRED"
    
  • "INCONCLUSIVE"
    
  • "RESOLVED"
    

idString

EKYC ID

Example: "62201d48a694817dede84b35"

verdictString

Action Required

Example: NONE_REQUIRED

statusString

EKYC result status

Example: SUCCESS

faceActionString

Action Required for Face Compare

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

Example: NONE_REQUIRED

mykadRequestIdString

Detected Landmark

Example: 62201d48a694817dede84b35

reasonsArray

Meesage 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 (parameter)

isSamePersonBoolean

Check result which is same person

Example: false

similarityFloat

Similarity of face image and mykad

Example: 0

Inside Results (parameter)

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 (parameter)

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 (parameter)

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 (parameter)

boxesArray

Refer to the boxes

Example: []

confidenceFloat

Confidence of detected face

Example: 1

Inside Results Object (parameter)

confidenceFloat

Confidence of detected mykad

Example: 0.9609

predictionString

Type of mykad

Example: "ic_1_front"

Inside Results Scores (parameter)

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

{% endraw %}