> For the complete documentation index, see [llms.txt](https://docs.accurascan.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.accurascan.com/language/docker/accura-scan-face-match-face-biometrics.md).

# Accura Scan - Face Match / Face Biometrics

{% embed url="<https://drive.google.com/file/d/1t9vDwGtrfo5vsFQsIo-7403gZM7Hjn_g/view?usp=sharing>" %}

### Steps to Install and Run the FaceMatch Docker

#### Step 1:

Pull AccuraFacematch Docker image using the command `docker pull accurascan/facematch:<latest  tag>`

{% hint style="info" %}
Visit <https://hub.docker.com/r/accurascan/facematch> to check the latest available version of AccuraFaceMatch
{% endhint %}

{% code title="Example:" fullWidth="false" %}

```
docker pull accurascan/facematch:36.0.0
```

{% endcode %}

#### Step 2:

Run the docker by using the command: `sudo docker run -d -it -p port-you-want-accurafacematch-to-run-on:80 --restart=always accurascan/facematch:<latest tag>`

{% code title="Example" overflow="wrap" %}

```
sudo docker run -d -it -p 3001:80 --restart=always accurascan/facematch:36.0.0
```

{% endcode %}

#### Step 3:

{% hint style="info" %}
To generate your Accura Scan license contact <sales@accurascan.com>
{% endhint %}

Upload your license accessing "<mark style="color:blue;">https\://\<yourdomain:port></mark>" using a browser, Example is shown in the image below.

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

#### Step 4:

Use “<mark style="color:blue;">[https://yourdomain:port/api.php](https://docs.accurascan.com/language/docker/https:/yourdomain:port/api.php)</mark>” (POST request) to access the API, an example post request is shown below.

<mark style="color:green;">`POST`</mark> `https://yourdomain:port/api.php`

#### Request Body

> You can either pass image file or an image base64.

| Name                                     | Type           | Description                  |
| ---------------------------------------- | -------------- | ---------------------------- |
| image1<mark style="color:red;">\*</mark> | file           | Upload your image file       |
| image2<mark style="color:red;">\*</mark> | file           | Upload your image file       |
| image1base64                             | text or string | paste your image base64 here |
| image2base64                             | text or string | paste your image base64 here |

{% tabs %}
{% tab title="200: OK An example response is shown in the image below" %}

{% endtab %}
{% endtabs %}

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

{% hint style="info" %}
The preferred threshold is **55%**, meaning that if an image achieves a score above this threshold, the Face Match is considered ***Successful***; otherwise, the Face Match is deemed to have ***Failed***.
{% endhint %}