GET Mykad Result

POST/v3/service

Prerequisite : Acquire requestID from mykad recognition response

Request Parameters

serviceString

EKYC service

Example: "ekyc"

versionString

Currently only support 'v1"

Example: "v1"

functionString

Selected function

Example: "get-mykad-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

Table ID

Example: "60f79b737b03abf23ad65206"

actionString

Action Required

Example: NONE_REQUIRED

clientIdString

Client ID

Example: ""

merchantIdString

Merchant ID

Example: ""

statusString

Recognition Status

Example: SUCCESS

durationFloat

Recognition Duration

Example: 3.3465

objectsObject

Detected Landmark

Example: (Refer to explanation below)

resultsArray

Mykad Recognition Results

Example: (Refer to explanation below)

updatedAtDateTime

Last update date time

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

createdAtDateTime

Create date time

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

Inside Objects (parameter)

dataArray

Refer to the Objects Data

Example: []

durationFloat

Landmark Detection Duration

Example: 0.0165

Inside Objects Data (parameter)

boxesArray

Refer to the boxes

Example: []

confidenceFloat

Confidence of detected landmark

Example: 0.9609

predictionString

Prediction of detected landmark

Example: "hibiscus_logo"

Inside Boxes (parameter)

xInt

x-coordinate of object in the image

Example: 196

yInt

y-coordinate of object in the image

Example: 200

Inside Results (parameter)

durationFloat

Mykad Recognition Duration

Example: 3.2886

colourObject

Refer to the Results Colour

Example: (Refer to explanation below)

dataObject

Refer to the Results Data

Example: (Refer to explanation below)

facesArray

Refer to the Results Faces

Example: (Refer to explanation below)

glareObject

Refer to the Results Glare

Example: (Refer to explanation below)

metaObject

Refer to the Results Meta

Example: (Refer to explanation below)

objectObject

Refer to the Results Object

Example: (Refer to explanation below)

ocrRequestIdsObject

Refer to the Results OcrRequestIds

Example: (Refer to explanation below)

scoresObject

Refer to the Results Scores

Example: (Refer to explanation below)

tamperCheckObject

Refer to the Results TamperCheck

Example: (Refer to explanation below)

Inside Results Colour (parameter)

detectedString

Colour detected

Example: "BLUE"

percentageFloat

Percentage of colour in the image

Example: 0.6008

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

detailsArray

Detailed information of glare

Example: []

presentBoolean

Present of glare

Example: false

Inside Results Meta (parameter)

resizeScaleFloat

Resize scale of mykad in the image

Example: 0

Inside Results Object (parameter)

confidenceFloat

Confidence of detected mykad

Example: 0.9609

predictionString

Type of mykad

Example: "ic_1_front"

Inside Results ocrRequestIds (parameter)

region1String

ID of region 1

Example: "62201d4b4fddc13446bd6d0e"

region2String

ID of region 2

Example: "62201d4b4fddc13446bd6d0f"

region3String

ID of region 3

Example: "62201d4b4fddc13446bd6d10"

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

Inside TamperCheck (parameter)

faceVerificationObject

Refer to the TamperCheck Face Verification Result

Example: (Refer to explanation below)

frontalFaceObject

Refer to the TamperCheck Result

Example: (Refer to explanation below)

physicalObject

Refer to the TamperCheck Physical

Example: (Refer to explanation below)

predictionString

Prediction of tamper check

Example: "ORIGINAL"

region1Object

Refer to the TamperCheck Result

Example: (Refer to explanation below)

region2Object

Refer to the TamperCheck Result

Example: (Refer to explanation below)

region3Object

Refer to the TamperCheck Result

Example: (Refer to explanation below)

Inside TamperCheck Face Verification Response (parameter)

messageString

Message from tamper check response

Example: ""

resultObject

Refer to the Tamper Check Face Verification Result

Example: (Refer to explanation below)

successBoolean

Success status of tamper check

Example: false

Inside TamperCheck Face Verification Result (parameter)

isSamePersonBoolean

Check result which is same person

Example: false

similarityFloat

Similarity of two faces

Example: 0

Inside TamperCheck Response (parameter)

messageString

Message from tamper check response

Example: ""

resultObject

Refer to the Tamper Check Result

Example: (Refer to explanation below)

successBoolean

Success status of tamper check

Example: false

Inside TamperCheck Result (parameter)

alternatedBoolean

Alternated trace of tamper check

Example: false

confidenceFloat

Confidence score of tamperCheck result

Example: 0.9999

predictionString

Prediction of tamper check

Example: "ORIGINAL"

Inside TamperCheck Physical (parameter)

confidenceFloat

Confidence score of tamperCheck physical

Example: 0

predictionString

Prediction of tamper check

Example: "ORIGINAL"

successBoolean

Success status of tamper check physical

Example: false

POSThttps://sb-open.revenuemonster.my/v3/service

No access token

Headers

{}

Body

{
  "service": "ekyc",
  "version": "v1",
  "function": "get-mykad-result",
  "request": {
    "id": "{{request_id}}"
  }
}

Example Request

▾

1curl \
2  --location \
3  --request POST 'https://sb-open.revenuemonster.my/v3/service' \
4  --header 'Content-Type: application/json' \
5  --header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6IjIwMTgtMDMtMTMiLCJ0eXAiOiJKV1QifQ.eyJhdWQiOlsiYXBpX2NsaWVudEBFaGNLQzA5QmRYUm9RMnhwWlc1MEVKTE42dFdBMG82MEx3Il0sImV4cCI6MTYwMzI1NDU2OSwiaWF0IjoxNjAwNjYyNTY5LCJpc3MiOiJodHRwczovL3NiLW9hdXRoLnJldmVudWVtb25zdGVyLm15IiwianRpIjoiRWh3S0VFOUJkWFJvUVdOalpYTnpWRzlyWlc0UTZNenR5b1RFckpzVyIsIm5iZiI6MTYwMDY2MjU2OSwic3ViIjoiRWhRS0NFMWxjbU5vWVc1MEVKWFZ6ZDN3cmFxVE9SSVFDZ1JWYzJWeUVJeUpxSXp2eU1QVmNRIn0.H3G6UDX7sR9EXtTMNs4Q2OHdhUGIhhCfdlAeOpywH4rDuVOcWXXwzF4Imbx8E7I10vFAJpwYZrEkCWCdCCw-WV11y9VT5kP6k75CeS-ZPMOLcKnC5iFT7vEi07r6ovwty9erlcZeXrtrmEIn3rnLva-dxSg3vZ2MyymoNDk-kV7ltXnkoWW4jtXRls6siLhxeY__8kXn2qa0ojVX4Nm6HmzN_vgi-RKSmToMgsdzTF94Y61QVBWhZfolD2-JpHx4qNlklcUdv8HOJ1QHHWpyoJytaJmvr3GJ5G399LbcTLwxB1p2qPg7z4hpoGNu4AP-ybRJVC3P9q9OscQYDNX-dA' \
6  --header 'X-Signature: sha256 Sty3LNcKA8+WlMHtAgIY+y1xbwnzKsN0UdyKaW+yYIgcTkBAtF7G5Lx251qQITURJ4wiXPDODxhs1nFVmBBing==' \
7  --header 'X-Nonce-Str: VYNknZohxwicZMaWbNdBKUrnrxDtaRhN' \
8  --header 'X-Timestamp: 1528450585' \
9  --data-raw '{ "service": "ekyc", "version": "v1", "function": "get-mykad-result", "request": { "id": "62201d48a694817dede84b35" } }'

Example Response▾

1{
2  "item": {
3    "action": "NONE_REQUIRED",
4    "clientId": "1626834435437339931",
5    "createdAt": "2022-03-03T01:43:36.963Z",
6    "duration": 3.9828,
7    "id": "62201d48a694817dede84b35",
8    "merchantId": "4118165203679668885",
9    "objects": {
10      "data": [
11        {
12          "boxes": [
13            {
14              "x": 196,
15              "y": 200
16            },
17            {
18              "x": 332,
19              "y": 274
20            }
21          ],
22          "confidence": 0.9614,
23          "prediction": "hibiscus_logo"
24        },
25        {
26          "boxes": [
27            {
28              "x": 254,
29              "y": 12
30            },
31            {
32              "x": 318,
33              "y": 71
34            }
35          ],
36          "confidence": 0.9608,
37          "prediction": "mykad_logo"
38        },
39        {
40          "boxes": [
41            {
42              "x": 321,
43              "y": 18
44            },
45            {
46              "x": 407,
47              "y": 64
48            }
49          ],
50          "confidence": 0.9603,
51          "prediction": "malaysia_flag"
52        },
53        {
54          "boxes": [
55            {
56              "x": 280,
57              "y": 64
58            },
59            {
60              "x": 409,
61              "y": 239
62            }
63          ],
64          "confidence": 0.9571,
65          "prediction": "face_image"
66        },
67        {
68          "boxes": [
69            {
70              "x": 52,
71              "y": 22
72            },
73            {
74              "x": 225,
75              "y": 60
76            }
77          ],
78          "confidence": 0.9488,
79          "prediction": "front_upper_left_text"
80        },
81        {
82          "boxes": [
83            {
84              "x": 144,
85              "y": 63
86            },
87            {
88              "x": 252,
89              "y": 130
90            }
91          ],
92          "confidence": 0.9438,
93          "prediction": "msc_logo"
94        },
95        {
96          "boxes": [
97            {
98              "x": 0,
99              "y": 5
100            },
101            {
102              "x": 432,
103              "y": 273
104            }
105          ],
106          "confidence": 0.709,
107          "prediction": "ic_1_front"
108        }
109      ],
110      "duration": 1.9634
111    },
112    "results": [
113      {
114        "colour": {
115          "detected": "BLUE",
116          "percentage": 0.6008
117        },
118        "data": {
119          "address": {
120            "addressLine1": "GDW KAMPUNG BAYANGAN",
121            "addressLine2": "80000 KENINGAU",
122            "addressLine3": "SABAH",
123            "city": "KENINGAU",
124            "postcode": "80000",
125            "state": "SABAH"
126          },
127          "gender": "Not found",
128          "ic": "550106-12-5821",
129          "isMuslim": false,
130          "name": "ROWAN SEBASTIAN ATKINSON"
131        },
132        "duration": 1.8658,
133        "faces": [
134          {
135            "boxes": [
136              {
137                "x": 428,
138                "y": 137
139              },
140              {
141                "x": 372,
142                "y": 272
143              }
144            ],
145            "confidence": 1
146          }
147        ],
148        "glare": {
149          "details": [],
150          "present": false
151        },
152        "meta": {
153          "resizeScale": 1.39
154        },
155        "object": {
156          "confidence": 0.709,
157          "prediction": "ic_1_front"
158        },
159        "ocrRequestIds": {
160          "region1": "62201d4b4fddc13446bd6d0e",
161          "region2": "62201d4b4fddc13446bd6d0f",
162          "region3": "62201d4b4fddc13446bd6d10"
163        },
164        "scores": {
165          "landmarks": 0.5442817296300616,
166          "ocr": 0.956196536620458,
167          "searcher": 0.9,
168          "total": 0.840095653250104
169        },
170        "tamperCheck": {
171          "faceVerification": {
172            "message": "Ghost face not found",
173            "result": {
174              "isSamePerson": false,
175              "similarity": 0
176            },
177            "success": false
178          },
179          "frontalFace": {
180            "message": "Success",
181            "result": {
182              "alternated": false,
183              "confidence": 0.9987,
184              "prediction": "ORIGINAL"
185            },
186            "success": true
187          },
188          "physical": {
189            "confidence": 0,
190            "prediction": "",
191            "success": false
192          },
193          "prediction": "ORIGINAL",
194          "region1": {
195            "message": "Success",
196            "result": {
197              "alternated": false,
198              "confidence": 0.9998,
199              "prediction": "ORIGINAL"
200            },
201            "success": true
202          },
203          "region2": {
204            "message": "Success",
205            "result": {
206              "alternated": false,
207              "confidence": 1,
208              "prediction": "ORIGINAL"
209            },
210            "success": true
211          },
212          "region3": {
213            "message": "Success",
214            "result": {
215              "alternated": false,
216              "confidence": 1,
217              "prediction": "ORIGINAL"
218            },
219            "success": true
220          }
221        }
222      }
223    ],
224    "status": "SUCCESS",
225    "updatedAt": "2022-03-03T01:43:40.978Z",
226  }
227}

Prerequisite

Products

Miscellaneous

GET Mykad Result

Request Parameters

Response Parameters

Inside Objects (parameter)

Inside Objects Data (parameter)

Inside Boxes (parameter)

Inside Results (parameter)

Inside Results Colour (parameter)

Inside Results Data (parameter)

Inside Address (parameter)

Inside Results Faces (parameter)

Inside Results Glare (parameter)

Inside Results Meta (parameter)

Inside Results Object (parameter)

Inside Results ocrRequestIds (parameter)

Inside Results Scores (parameter)

Inside TamperCheck (parameter)

Inside TamperCheck Face Verification Response (parameter)

Inside TamperCheck Face Verification Result (parameter)

Inside TamperCheck Response (parameter)

Inside TamperCheck Result (parameter)

Inside TamperCheck Physical (parameter)