> For the complete documentation index, see [llms.txt](https://api2-ekycapis.innov8tif.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://api2-ekycapis.innov8tif.com/okaydoc/okaydoc-all/supported-documents/singapore/sg-nric-pr-front/versions.md).

# Versions

## Version 2-1

<mark style="color:green;">`POST`</mark> `https://okaydocdemo.innov8tif.com/ekyc/api/ekyc/v2-1/doc-verify/sg-id-card-front`

#### Request Body

| Name                                                 | Type   | Description                                                                             |
| ---------------------------------------------------- | ------ | --------------------------------------------------------------------------------------- |
| caseNo                                               | string | Reference code given by user                                                            |
| otherDocList                                         | string | This parameter is needed for illumination detection and optical variable ink detection. |
| apiKey<mark style="color:red;">\*</mark>             | string | To be assigned by Innov8tif                                                             |
| idImageBase64Image<mark style="color:red;">\*</mark> | string | Front id card image in base64                                                           |

{% tabs %}
{% tab title="200 doctype value for PR: PR NRIC
doctype value for NRIC: SG NRIC" %}

```
{
    "status": "success",
    "messageCode": "api.success",
    "message": "",
    "id": "333e1c8f-4360-4b94-8d83-060c4f67ab25",
    "methodList": [
        {
            "method": "landmark",
            "label": "Landmark Analysis Result",
            "componentList": [
                {
                    "code": "l-sg-lic-coatofarm",
                    "label": "Coat of Arms",
                    "value": "91.04602932929993",
                    "imageUrl": "/public/image/v2/333e1c8f-4360-4b94-8d83-060c4f67ab25?type=l-sg-lic-coatofarm",
                    "refImageUrl": null
                },
                {
                    "code": "l-sg-lic-lionhead",
                    "label": "Lion Head Symbol",
                    "value": "0",
                    "imageUrl": "/public/image/v2/333e1c8f-4360-4b94-8d83-060c4f67ab25?type=l-sg-lic-lionhead",
                    "refImageUrl": null
                },
                {
                    "code": "l-sg-lic-republic",
                    "label": "Republic of Singapore",
                    "value": "90.98642468452454",
                    "imageUrl": "/public/image/v2/333e1c8f-4360-4b94-8d83-060c4f67ab25?type=l-sg-lic-republic",
                    "refImageUrl": null
                }
            ]
        },
        {
            "method": "illuminationLevel",
            "label": "Illumination Level",
            "componentList": [
                {
                    "code": "illuminationLevel",
                    "label": "Illumination Level",
                    "value": "Fail",
                    "imageUrl": "/public/image/v2/333e1c8f-4360-4b94-8d83-060c4f67ab25?type=illuminationLevel",
                    "refImageUrl": null
                }
            ]
        },
        {
            "method": "headerColorDiff",
            "label": "Header Color Difference",
            "componentList": [
                {
                    "code": "headerColorDiff",
                    "label": "Header Color Difference",
                    "value": "Fail",
                    "imageUrl": "/public/image/v2/333e1c8f-4360-4b94-8d83-060c4f67ab25?type=headerColorDiff",
                    "refImageUrl": null
                }
            ]
        },
        {
            "method": "colorMode",
            "label": "Color Detection",
            "componentList": [
                {
                    "code": "colorMode",
                    "label": "Color Detection",
                    "value": "Pass",
                    "imageUrl": null,
                    "refImageUrl": null
                }
            ]
        },
        {
            "method": "screen",
            "label": "Screen Detection",
            "componentList": [
                {
                    "code": "screen",
                    "label": "Screen Detection",
                    "value": "Cautious",
                    "imageUrl": null,
                    "refImageUrl": null
                }
            ]
        },
        {
            "method": "docType",
            "label": "Document Type",
            "componentList": [
                {
                    "code": "docType",
                    "label": "Document Type",
                    "value": "PR NRIC",
                    "imageUrl": null,
                    "refImageUrl": null
                }
            ]
        }
    ],
    "outputImageList": null
}
```

{% endtab %}

{% tab title="400: Bad Request " %}

```javascript
{
    // Response
}
```

{% endtab %}

{% tab title="500: Internal Server Error " %}

```javascript
{
    // Response
}
```

{% endtab %}
{% endtabs %}

#### Postman Collection

{% file src="/files/HqeYhXhhCuOocp71i4CE" %}
OkayDoc SG ID Card Front v2-1
{% endfile %}

## Version 2

<mark style="color:green;">`POST`</mark> `https://okaydocdemo.innov8tif.com/ekyc/api/ekyc/v2/doc-verify/sg-id-card-front`

#### Request Body

| Name                                                 | Type   | Description                                                                             |
| ---------------------------------------------------- | ------ | --------------------------------------------------------------------------------------- |
| caseNo                                               | string | Reference code given by user                                                            |
| otherDocList                                         | string | This parameter is needed for illumination detection and optical variable ink detection. |
| apiKey<mark style="color:red;">\*</mark>             | string | To be assigned by Innov8tif                                                             |
| idImageBase64Image<mark style="color:red;">\*</mark> | string | Front id card image in base64                                                           |

{% tabs %}
{% tab title="200 " %}
{% code title="JSON" %}

```
{
    "status": "success",
    "messageCode": "api.success",
    "message": "",
    "id": "49d26d8a-2cb6-4c80-96a1-8bfcf7977126",
    "methodList": [
        {
            "method": "landmark",
            "label": "Landmark Analysis Result",
            "componentList": [
                {
                    "code": "l-sg-lic-coatofarm",
                    "label": "Coat of Arms",
                    "value": "72.79978394508362",
                    "imageUrl": "/public/image/v2/49d26d8a-2cb6-4c80-96a1-8bfcf7977126?type=l-sg-lic-coatofarm",
                    "refImageUrl": null
                },
                {
                    "code": "l-sg-lic-lionhead",
                    "label": "Lion Head Symbol",
                    "value": "90.22381901741028",
                    "imageUrl": "/public/image/v2/49d26d8a-2cb6-4c80-96a1-8bfcf7977126?type=l-sg-lic-lionhead",
                    "refImageUrl": null
                },
                {
                    "code": "l-sg-lic-republic",
                    "label": "Republic of Singapore",
                    "value": "32.84326791763306",
                    "imageUrl": "/public/image/v2/49d26d8a-2cb6-4c80-96a1-8bfcf7977126?type=l-sg-lic-republic",
                    "refImageUrl": null
                }
            ]
        },
        {
            "method": "illuminationLevel",
            "label": "Illumination Level",
            "componentList": [
                {
                    "code": "illuminationLevel",
                    "label": "Illumination Level",
                    "value": "Fail",
                    "imageUrl": "/public/image/v2/49d26d8a-2cb6-4c80-96a1-8bfcf7977126?type=illuminationLevel",
                    "refImageUrl": null
                }
            ]
        },
        {
            "method": "headerColorDiff",
            "label": "Header Color Difference",
            "componentList": [
                {
                    "code": "headerColorDiff",
                    "label": "Header Color Difference",
                    "value": "Fail",
                    "imageUrl": "/public/image/v2/49d26d8a-2cb6-4c80-96a1-8bfcf7977126?type=headerColorDiff",
                    "refImageUrl": null
                }
            ]
        },
        {
            "method": "colorMode",
            "label": "Color Detection",
            "componentList": [
                {
                    "code": "colorMode",
                    "label": "Color Detection",
                    "value": "Pass",
                    "imageUrl": null,
                    "refImageUrl": null
                }
            ]
        },
        {
            "method": "screen",
            "label": "Screen Detection",
            "componentList": [
                {
                    "code": "screen",
                    "label": "Screen Detection",
                    "value": "Cautious",
                    "imageUrl": null,
                    "refImageUrl": null
                }
            ]
        }
    ],
    "outputImageList": null
}
```

{% endcode %}
{% endtab %}

{% tab title="400: Bad Request " %}

```javascript
{
    // Response
}
```

{% endtab %}

{% tab title="500: Internal Server Error " %}

```javascript
{
    // Response
}
```

{% endtab %}
{% endtabs %}

#### Postman Collection

{% file src="/files/UQY5Hq4OsJuBkI02FURR" %}
OkayDoc SG ID Card Front v2
{% endfile %}

## Version 1

<mark style="color:green;">`POST`</mark> `https://okaydocdemo.innov8tif.com/ekyc/api/ekyc/v1/doc-verify/sg-id-card-front`

#### Request Body

| Name                                                 | Type   | Description                                                                             |
| ---------------------------------------------------- | ------ | --------------------------------------------------------------------------------------- |
| caseNo                                               | string | Reference code given by user                                                            |
| otherDocList                                         | string | This parameter is needed for illumination detection and optical variable ink detection. |
| apiKey<mark style="color:red;">\*</mark>             | string | To be assigned by Innov8tif                                                             |
| idImageBase64Image<mark style="color:red;">\*</mark> | string | Front id card image in base64                                                           |

{% tabs %}
{% tab title="200 " %}
{% code title="JSON" %}

```
{
    "status": "success",
    "messageCode": "api.success",
    "message": "",
    "id": "ac4bdb9e-ccf8-4b60-bd18-3c6f1fb1fe4b",
    "methodList": [
        {
            "method": "landmark",
            "label": "Landmark Analysis Result",
            "componentList": [
                {
                    "code": "l-sg-lic-coatofarm",
                    "label": "Coat of Arms",
                    "value": "72.79978394508362",
                    "imageUrl": "/public/image/v2/xxxxxxxxxxxxx?type=l-sg-lic-coatofarm",
                    "refImageUrl": null
                },
                {
                    "code": "l-sg-lic-lionhead",
                    "label": "Lion Head Symbol",
                    "value": "90.22381901741028",
                    "imageUrl": "/public/image/v2/xxxxxxxxxxxxx?type=l-sg-lic-lionhead",
                    "refImageUrl": null
                },
                {
                    "code": "l-sg-lic-republic",
                    "label": "Republic of Singapore",
                    "value": "32.84326791763306",
                    "imageUrl": "/public/image/v2/xxxxxxxxx?type=l-sg-lic-republic",
                    "refImageUrl": null
                }
            ]
        {
            "method": "illuminationLevel",
            "label": "Illumination Level",
            "componentList": [
                {
                    "code": "illuminationLevel",
                    "label": "Illumination Level",
                    "value": " No Difference in Illumination Detected",
                    "imageUrl": null,
                    "refImageUrl": null
                }
            ]
        },
        {
            "method": "headerColorDiff",
            "label": "Header Color Difference",
            "componentList": [
                {
                    "code": "headerColorDiff",
                    "label": "Header Color Difference",
                    "value": " Optical Variable Ink Not Detected",
                    "imageUrl": null,
                    "refImageUrl": null
                }
            ]
        }
    ],
    "outputImageList": null
}
```

{% endcode %}
{% endtab %}

{% tab title="400: Bad Request " %}

```javascript
{
    // Response
}
```

{% endtab %}

{% tab title="500: Internal Server Error " %}

```javascript
{
    // Response
}
```

{% endtab %}
{% endtabs %}

#### Postman Collection

{% file src="/files/xigfo6naqiEAnUROKIfE" %}
OkayDoc SG ID Card Front
{% endfile %}