> For the complete documentation index, see [llms.txt](https://api2-ekycportal.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-ekycportal.innov8tif.com/emas-ekyc-portal/centralized-okayface/version-2-blacklist-face-search.md).

# Version 2 (Blacklist Face Search)

### *<mark style="background-color:green;">\[Available UAT Only]</mark>* Centralized OkayFace Version 2  *(Added Blacklist Face Search Module)*

<mark style="color:green;">`POST`</mark> `https://ekycportaldemo.innov8tif.com/api/ekyc/okayface/v2`&#x20;

*Note: A new scorecard with a blacklist face search feature is required. Please inform Innov8tif about the scorecard updates.*

#### Headers

| Name         | Type   | Description                                                                                                                                                                                                        |
| ------------ | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| livenessMeta | String | <p>The environment the image was taken in. Possible values are <code>IOS</code>, <code>ANDROID</code>, <code>DESKTOP</code> or <code>UNKNOWN</code> (the default).</p><p>e.g. </p><p><em>{"OS":"Desktop"}</em></p> |

#### Request Body

| Name                                                    | Type    | Description                                                                                                    |
| ------------------------------------------------------- | ------- | -------------------------------------------------------------------------------------------------------------- |
| imageIdCardBase64                                       | string  | Uncheck 'imageIdCard' to enable this parameter to be working                                                   |
| imageBestBase64                                         | string  | Uncheck 'imageBest' to enable this parameter to be working                                                     |
| livenessDetection                                       | boolean | Set to True - return liveness score                                                                            |
| imageIdCard <mark style="color:red;">\*</mark>          | object  | Face Image from ID card                                                                                        |
| imageBest <mark style="color:red;">\*</mark>            | object  | Selfie photo                                                                                                   |
| journeyId<mark style="color:red;">\*</mark>             | string  | Retrieve from 'Create JourneyID' API                                                                           |
| 🆕blacklistFaceSearch<mark style="color:red;">\*</mark> | boolean | <p>Enable by verify if a selfie image matches any entries in the blacklist database. <br>(Default: false) </p> |

{% tabs %}
{% tab title="200 -" %}
{% code title="Response Code Block" %}

```json
{
    "status": "success",
    "messageCode": "api.success",
    "imageBestLiveness": {
        "probability": 0.99470514,
        "score": 5.235708,
        "quality": 0.93999994
    },
    "blacklistFaceSearch": {
        "status": "NOT_FOUND", // It can be either FOUND or NOT_FOUND
        "requestId": "d16b2ae4-2b71-4375-9e1b-d0f1a7ea998c"
    },
    "result_idcard": {
        "confidence": 87.76302
    }
}

```

{% endcode %}
{% endtab %}
{% endtabs %}

### Input Example (OkayFace Version 2)

<figure><img src="/files/F2VDwhApJvGJWGr7EsF4" alt=""><figcaption></figcaption></figure>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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-ekycportal.innov8tif.com/emas-ekyc-portal/centralized-okayface/version-2-blacklist-face-search.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.