# Versions

## Version 2

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

#### Request Body

| Name                                                 | Type   | Description                                                              |
| ---------------------------------------------------- | ------ | ------------------------------------------------------------------------ |
| photoSubstitutionCheck                               | string | <p>Default is True.<br>To enable/disable photo substitution check</p>    |
| hologram                                             | string | <p>Default is True.<br>To enable/disable hologram detection</p>          |
| screenDetection                                      | string | <p>Default is True.<br>To enable/disable screen detection</p>            |
| colorMode                                            | string | <p>Default is True.<br>To enable/disable color detection.</p>            |
| idBrightnessDetection                                | string | <p>Default is True.<br>To enable/disable id brightness detection</p>     |
| idBlurDetection                                      | string | <p>Default is True.<br>To enable/disable id blurriness detection</p>     |
| landmarkCheck                                        | string | <p>Default is True.<br>To enable/disable landmark check</p>              |
| caseNo                                               | string | Reference code given by user                                             |
| 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                                            |
| otherDocList                                         | string | second image as "flash image"                                            |
| idTamper                                             | string | <p>Default is False.</p><p>To enable/disable the ID Tamper detection</p> |

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

```
{
    "status": "success",
    "messageCode": "api.success",
    "message": "",
    "id": "c03e4ecb-81aa-4416-83b2-e7a225e7b101",
    "methodList": [
        {
            "method": "landmark",
            "label": "Landmark Analysis Result",
            "componentList": [
                {
                    "code": "l-kh-id-front-landmark1",
                    "label": "Landmark 1",
                    "value": "97.12206721305847",
                    "imageUrl": "/public/image/v2/c03e4ecb-81aa-4416-83b2-e7a225e7b101?type=l-kh-id-front-landmark1",
                    "refImageUrl": null
                },
                {
                    "code": "l-kh-id-front-landmark2",
                    "label": "Landmark 2",
                    "value": "94.71385478973389",
                    "imageUrl": "/public/image/v2/c03e4ecb-81aa-4416-83b2-e7a225e7b101?type=l-kh-id-front-landmark2",
                    "refImageUrl": null
                },
                {
                    "code": "l-kh-id-front-landmark3",
                    "label": "Landmark 3",
                    "value": "97.7009654045105",
                    "imageUrl": "/public/image/v2/c03e4ecb-81aa-4416-83b2-e7a225e7b101?type=l-kh-id-front-landmark3",
                    "refImageUrl": null
                },
                {
                    "code": "l-kh-id-front-landmark4",
                    "label": "Landmark 4",
                    "value": "97.96249270439148",
                    "imageUrl": "/public/image/v2/c03e4ecb-81aa-4416-83b2-e7a225e7b101?type=l-kh-id-front-landmark4",
                    "refImageUrl": null
                },
                {
                    "code": "l-kh-id-front-landmark5",
                    "label": "Landmark 5",
                    "value": "93.39374303817749",
                    "imageUrl": "/public/image/v2/c03e4ecb-81aa-4416-83b2-e7a225e7b101?type=l-kh-id-front-landmark5",
                    "refImageUrl": null
                },
                {
                    "code": "l-kh-id-front-landmark6",
                    "label": "Landmark 6",
                    "value": "98.3284592628479",
                    "imageUrl": "/public/image/v2/c03e4ecb-81aa-4416-83b2-e7a225e7b101?type=l-kh-id-front-landmark6",
                    "refImageUrl": null
                },
                {
                    "code": "l-kh-id-front-landmark7",
                    "label": "Landmark 7",
                    "value": "98.90614151954651",
                    "imageUrl": "/public/image/v2/c03e4ecb-81aa-4416-83b2-e7a225e7b101?type=l-kh-id-front-landmark7",
                    "refImageUrl": null
                }
            ]
        },
        {
            "method": "idBlurDetection",
            "label": "ID Blur Detection",
            "componentList": [
                {
                    "code": "idBlurDetection",
                    "label": "ID Blur Detection",
                    "value": "Pass",
                    "imageUrl": null,
                    "refImageUrl": null
                }
            ]
        },
        {
            "method": "idBrightnessDetc",
            "label": "ID Brightness Detection",
            "componentList": [
                {
                    "code": "idBrightnessDetc",
                    "label": "ID Brightness Detection",
                    "value": "Pass",
                    "imageUrl": null,
                    "refImageUrl": null
                }
            ]
        },
        {
            "method": "colorMode",
            "label": "Color Mode",
            "componentList": [
                {
                    "code": "colorMode",
                    "label": "Color Mode",
                    "value": "Pass",
                    "imageUrl": null,
                    "refImageUrl": null
                }
            ]
        },
        {
            "method": "screen",
            "label": "Screen Detection",
            "componentList": [
                {
                    "code": "screen",
                    "label": "Screen Detection",
                    "value": "Pass",
                    "imageUrl": null,
                    "refImageUrl": null
                }
            ]
        },
        {
            "method": "hologram",
            "label": "Hologram",
            "componentList": [
                {
                    "code": "hologram",
                    "label": "Hologram",
                    "value": "Fail",
                    "imageUrl": "/public/image/v2/c03e4ecb-81aa-4416-83b2-e7a225e7b101?type=hologram",
                    "refImageUrl": null
                }
            ]
        },
        {
            "method": "substitution",
            "label": "Substitution Checking",
            "componentList": [
                {
                    "code": "substitution",
                    "label": "Substitution Checking",
                    "value": "Pass",
                    "imageUrl": null,
                    "refImageUrl": null
                }
            ]
        },
        {
            "method": "idTamper",
            "label": "ID Tamper Detection",
            "componentList": [
                {
                    "code": "idTamper",
                    "label": "ID Tamper Detection",
                    "value": "Pass",
                    "imageUrl": null,
                    "refImageUrl": null
                }
            ]
        }
    ],
    "outputImageList": [
        {
            "tag": "cropId",
            "imageUrl": "/public/image/v2/c03e4ecb-81aa-4416-83b2-e7a225e7b101?type=cropId"
        }
    ]}
```

{% endtab %}

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

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

{% endtab %}

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

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

{% endtab %}
{% endtabs %}

#### Postman Collection

{% file src="<https://1723857616-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoP1M8bTYgFFHHnAdjjta%2Fuploads%2Fnois8fPJXmqXwUj1MLws%2FOkayDoc%20KH%20ID%20Card%20Front%20v2.postman_collection.rar?alt=media&token=218d9596-e13d-48f3-943b-dd26b829f32a>" %}
OkayDoc KH ID Card Front v2
{% endfile %}

## Version 1

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

#### Request Body

| Name                                                 | Type   | Description                   |
| ---------------------------------------------------- | ------ | ----------------------------- |
| caseNo                                               | string | Reference code given by user  |
| 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 " %}

```
{
    "status": "success",
    "messageCode": "api.success",
    "message": "",
    "id": "428d562f-a350-421c-883d-e766a26bde33",
    "methodList": [
        {
            "method": "landmark",
            "label": "Landmark Analysis Result",
            "componentList": [
                {
                    "code": "l-kh-id-front-landmark1",
                    "label": "Landmark 1",
                    "value": "96.24505639076233",
                    "imageUrl": "/public/image/v2/xxxxxxxxxxxx?type=l-kh-id-front-landmark1",
                    "refImageUrl": null
                },
                {
                    "code": "l-kh-id-front-landmark2",
                    "label": "Landmark 2",
                    "value": "95.7434356212616",
                    "imageUrl": "/public/image/v2/xxxxxxxxxxxxx?type=l-kh-id-front-landmark2",
                    "refImageUrl": null
                },
                {
                    "code": "l-kh-id-front-landmark3",
                    "label": "Landmark 3",
                    "value": "95.41226029396057",
                    "imageUrl": "/public/image/v2/xxxxxxxxxxxxxx?type=l-kh-id-front-landmark3",
                    "refImageUrl": null
                },
                {
                    "code": "l-kh-id-front-landmark4",
                    "label": "Landmark 4",
                    "value": "94.89492177963257",
                    "imageUrl": "/public/image/v2/xxxxxxxxxxxxx?type=l-kh-id-front-landmark4",
                    "refImageUrl": null
                },
                {
                    "code": "l-kh-id-front-landmark5",
                    "label": "Landmark 5",
                    "value": "94.56592202186584",
                    "imageUrl": "/public/image/v2/xxxxxxxxxxxxxx?type=l-kh-id-front-landmark5",
                    "refImageUrl": null
                },
                {
                    "code": "l-kh-id-front-landmark6",
                    "label": "Landmark 6",
                    "value": "95.46042084693909",
                    "imageUrl": "/public/image/v2/xxxxxxxxxxxxx?type=l-kh-id-front-landmark6",
                    "refImageUrl": null
                },
                {
                    "code": "l-kh-id-front-landmark7",
                    "label": "Landmark 7",
                    "value": "95.25001645088196",
                    "imageUrl": "/public/image/v2/xxxxxxxxxxxxxxx?type=l-kh-id-front-landmark7",
                    "refImageUrl": null
                }
            ]
        }
    ],
    "outputImageList": [
        {
            "tag": "cropId",
            "imageUrl": "/public/image/v2/428d562f-a350-421c-883d-e766a26bde33?type=cropId"
        }
    ]
}
```

{% endtab %}

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

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

{% endtab %}

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

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

{% endtab %}
{% endtabs %}

#### Postman Collection

{% file src="<https://1723857616-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoP1M8bTYgFFHHnAdjjta%2Fuploads%2FvRtPbAKTD6nHsYBnHU6V%2FOkayDoc%20KH%20ID%20front.postman_collection.rar?alt=media&token=53af4606-04c9-41e9-ae06-f06b240f9135>" %}
OkayDoc KH ID Card Front
{% endfile %}