> 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-1.md).

# Face matching

The Face Matching API allows you to compare two user-submitted face images to determine their similarity. This endpoint processes the images, runs biometric validation checks, and returns a response indicating whether the faces match, along with a similarity score and confidence level.

## Create a new user

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

**Headers**

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

**Body**

| Name          | Type   | Description           |
| ------------- | ------ | --------------------- |
| source\_image | string | source image - base64 |
| target\_image | string | Target Image - base64 |

**Response**

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

````json
```json
{
    "status": true,
    "message": "Face match successful",
    "data": {
         "status": true, 
         "similarity": 89
         
    }
}
```
````

{% endtab %}

{% tab title="400" %}

```json
{
  "status": false
  "message": "Face does not match"
}
```

{% endtab %}
{% endtabs %}