# Versions

{% hint style="info" %}
Recommended/Latest version is always placed at the top of the page. (v2 for OkayFace) 
{% endhint %}

## 1:1 Face Verification V2

## 1:1 Face Verification V2

<mark style="color:green;">`POST`</mark> `https://okayfacedemo.innov8tif.com/api/faceid/v2/verify`

#### Headers

| Name         | Type   | Description                             |
| ------------ | ------ | --------------------------------------- |
| livenessMeta | String | The JSON string with device information |

#### Request Body

| Name                                           | Type   | Description                                   |
| ---------------------------------------------- | ------ | --------------------------------------------- |
| apiKey <mark style="color:red;">\*</mark>      | string | To be assigned by Innov8tif                   |
| imageIdCard <mark style="color:red;">\*</mark> | object | Front id card image                           |
| imageBest <mark style="color:red;">\*</mark>   | object | Image that's used to compare with imageIdCard |

{% tabs %}
{% tab title="200 Response without liveness checking" %}

```
{
    "request_id": "1491401591,b0398182-ca04-4f7e-b59a-7c83398cf230",
    "result_idcard": {
        "confidence": 96.46025
    }
}
```

{% endtab %}

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

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

{% endtab %}

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

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

{% endtab %}
{% endtabs %}

#### Postman Collection

{% file src="/files/HFXqUcMgt8RJuXzaXt69" %}
OkayFace V2
{% endfile %}

## ~~1:1 Face Verification V3~~*<mark style="color:orange;">(Deprecated)</mark>*&#x20;

## 1:1 Face Verification V3

<mark style="color:green;">`POST`</mark> `https://okayfacedemo.innov8tif.com/api/faceid/v3/verify`

#### Request Body

| Name                                           | Type   | Description                                                   |
| ---------------------------------------------- | ------ | ------------------------------------------------------------- |
| apiKey <mark style="color:red;">\*</mark>      | string | To be assigned by Innov8tif                                   |
| imageIdCard <mark style="color:red;">\*</mark> | object | Front id card image                                           |
| imageBest <mark style="color:red;">\*</mark>   | string | Encrypted string for liveness face retrieved via liveness SDK |

{% tabs %}
{% tab title="200 Response without liveness checking" %}

```
{
    "request_id": "1491401591,b0398182-ca04-4f7e-b59a-7c83398cf230",
    "result_idcard": {
        "confidence": 96.46025
    }
}
```

{% endtab %}

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

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

{% endtab %}

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

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

{% endtab %}
{% endtabs %}

#### Postman Collection

{% file src="/files/2x4fRR5YgAxjEdck5lUY" %}
OkayFace V3
{% endfile %}

## ~~1:1 Face Verification V4~~*<mark style="color:orange;">(Deprecated)</mark>*

## 1:1 Face Verification V4

<mark style="color:green;">`POST`</mark> `https://okayfacedemo.innov8tif.com/api/faceid/v4/verify`

#### Request Body

| Name                                           | Type   | Description                                             |
| ---------------------------------------------- | ------ | ------------------------------------------------------- |
| apiKey <mark style="color:red;">\*</mark>      | string | To be assigned by Innov8tif                             |
| imageIdCard <mark style="color:red;">\*</mark> | string | Front id card image in base64                           |
| imageBest <mark style="color:red;">\*</mark>   | string | Image in base64 that's used to compare with imageIdCard |

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

```
{"request_id":"8fa0cdcf-5f50-4671-8db1-47145232d200","result_idcard":{"confidence":0.51890767}}
```

{% endtab %}

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

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

{% endtab %}

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

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

{% endtab %}
{% endtabs %}

#### Postman Collection

{% file src="/files/X98vTHOKrInGwRRSvWVp" %}
OkayFace V4
{% endfile %}

## 1:1 Face Verification V2-1

## 1:1 Face Verification With Liveness Detection (Encrypted string is not required)

<mark style="color:green;">`POST`</mark> `https://okayfacedemo.innov8tif.com/api/faceid/v2-1/verify`

#### Request Body

| Name                                           | Type   | Description                 |
| ---------------------------------------------- | ------ | --------------------------- |
| apiKey <mark style="color:red;">\*</mark>      | string | To be assigned by Innov8tif |
| imageIdCard <mark style="color:red;">\*</mark> | object | Front id card image         |
| imageBest <mark style="color:red;">\*</mark>   | object | Selfie photo                |

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

```
{
"imageBestLiveness":
    {
        "probability":2.492201929271687E-7,
        "score":-5.0898823738098145,
        "quality":1.0
    },
"request_id":"TASKAI208003201910300952440191412201",
"result_idcard":
    {
        "confidence":57.86325
    }
}
```

{% endtab %}

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

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

{% endtab %}

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

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

{% endtab %}
{% endtabs %}

#### Postman Collection

{% file src="/files/lU9RcIt63ffcjPyfKueQ" %}
OkayFace v2-1
{% endfile %}

## 1:1 Face Verification V2-2

## 1:1 Face Verification With Liveness Detection

<mark style="color:green;">`POST`</mark> `https://okayfacedemo.innov8tif.com/api/faceid/v2-2/verify`

#### Request Body

| Name                                           | Type   | Description                   |
| ---------------------------------------------- | ------ | ----------------------------- |
| apiKey <mark style="color:red;">\*</mark>      | string | To be assigned by Innov8tif   |
| imageIdCard <mark style="color:red;">\*</mark> | string | Front id card image in base64 |
| imageBest <mark style="color:red;">\*</mark>   | string | Selfie photo in base64        |

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

```
{"imageBestLiveness":{"probability":1.8339830987201822E-8,"score":-6.1092305183410645,"quality":1.0},"request_id":"53b7443b-2cf9-407e-a710-b304a6a569a5","result_idcard":{"confidence":{"imageBestLiveness":{"probability":0.03970755,"score":-3.1856966,"quality":0.7613958},"request_id":"1588554351758433I8E5268147307508","result_idcard":{"confidence":59.11985}}}}
```

{% endtab %}
{% endtabs %}

#### Postman Collection

{% file src="/files/tOzYhEa9lZxvCebAihM0" %}
OkayFace v2-2
{% endfile %}

## ~~1:1 Face Verification V3-1~~*<mark style="color:orange;">(Deprecated)</mark>*

## 1:1 Face Verification With Liveness Detection (Encrypted string is required)

<mark style="color:green;">`POST`</mark>`https://okayfacedemo.innov8tif.com/api/faceid/v3-1/verify`

#### Request Body

| Name                                           | Type   | Description                                                   |
| ---------------------------------------------- | ------ | ------------------------------------------------------------- |
| apiKey <mark style="color:red;">\*</mark>      | string | To be assigned by Innov8tif                                   |
| imageIdCard <mark style="color:red;">\*</mark> | object | Front id card image                                           |
| imageBest <mark style="color:red;">\*</mark>   | string | Encrypted string for liveness face retrieved via liveness SDK |

{% tabs %}
{% tab title="200 Response without liveness checking" %}

```
{"imageBestLiveness":
    {
        "probability":2.492201929271687E-7,
        "score":-5.0898823738098145,
        "quality":1.0
    },
"request_id":"TASKAI208003201910300952440191412201",
"result_idcard":
    {
        "confidence":57.86325
    }
}
```

{% endtab %}
{% endtabs %}

#### Postman Collection&#x20;

N/A

## ~~1:1 Face Verification V4-1~~*<mark style="color:orange;">(Deprecated)</mark>*

## 1:1 Face Verification With Liveness Detection

<mark style="color:green;">`POST`</mark> `https://okayfacedemo.innov8tif.com/api/faceid/v4-1/verify`

#### Request Body

| Name                                           | Type   | Description                   |
| ---------------------------------------------- | ------ | ----------------------------- |
| apiKey <mark style="color:red;">\*</mark>      | string | To be assigned by Innov8tif   |
| imageIdCard <mark style="color:red;">\*</mark> | string | Front id card image in base64 |
| imageBest <mark style="color:red;">\*</mark>   | string | Selfie photo in base64        |

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

```
{"imageBestLiveness":{"probability":1.8339830987201822E-8,"score":-6.1092305183410645,"quality":1.0},"request_id":"53b7443b-2cf9-407e-a710-b304a6a569a5","result_idcard":{"confidence":0.51890767}}
```

{% endtab %}
{% endtabs %}

#### Postman Collection

{% file src="/files/5jZOtmCrB309YfPB1fRM" %}
OkayFace v4-1
{% endfile %}

{% hint style="info" %}
Kindly refer to the page below for the interpretation of the result.
{% endhint %}

{% content-ref url="/spaces/RYsITG7N76MNv67B20iW/pages/mFCL5ybACFd5dpNd2YEk" %}
[Interpretation of Result and Recommended Threshold](https://api2-ekycportal.innov8tif.com/emas-ekyc-portal/centralized-okayface/interpretation-of-result-and-recommended-threshold)
{% endcontent-ref %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://api2-ekycapis.innov8tif.com/okayface/okayface-all/face-verification/versions.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.