> For the complete documentation index, see [llms.txt](https://pruvly.gitbook.io/pruvly/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://pruvly.gitbook.io/pruvly/document-engine/document-check-3.md).

# Face Liveness

The Face Liveness API analyzes a user-submitted face image to determine whether it is a live capture or a spoof attempt. This endpoint processes the image, runs liveness detection checks, and returns a response indicating the liveness status along with a confidence score.

## Face Liveness

<mark style="color:green;">`POST`</mark> {{BASE-URL}}/verification/external/face/liveness

**Headers**

| Name         | Value                       |
| ------------ | --------------------------- |
| Content-Type | `application/json`          |
| api-key      | \<api key from your portal> |

**Body**

| Name  | Type   | Description         |
| ----- | ------ | ------------------- |
| image | string | face image - base64 |

**Response**

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

````json
```json
{
    "status": true,
    "message": "Livenss detection successful",
    "data": {
         "status": true, 
         "liveness_score": 92.3
    }
}
```
````

{% endtab %}

{% tab title="400" %}

```json
{
  "status": false
  "message": "Could not detect face"
}
```

{% endtab %}
{% endtabs %}