> 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/web-api/accura-face-match.md).

# Accura Face Match

### IMPORTANT NOTES:

1. Max file upload size is 1 MB. Request to Pre-Processed the images and send to our API
2. User Profile Pic is returned as base64 format.
3. We DO NOT save any User infomation on our server.

<mark style="color:green;">`POST`</mark> `https://api.accurascan.com/v2/api/facematch`

#### Headers

| Name                                      | Type   | Description  |
| ----------------------------------------- | ------ | ------------ |
| Api-Key<mark style="color:red;">\*</mark> | String | Your Api Key |

#### Request Body

| Name                                                                                    | Type   | Description                                                                                                                            |
| --------------------------------------------------------------------------------------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------- |
| source\_file or source\_url or source\_image\_base64<mark style="color:red;">\*</mark>  |        | Upload Source image file (jpg, jpeg, png) or You can use source image url. (jpg, jpeg, png) or You can use source base64 image string. |
| target\_file or target\_url or target\_image\_base64 <mark style="color:red;">\*</mark> | String | Upload Target image file (jpg, jpeg, png) or You can use target image url. (jpg, jpeg, png) or You can use target base64 image string. |

<details>

<summary><em>Postman Collection</em></summary>

{% code overflow="wrap" %}

```json
{"collection":{"info":{"_postman_id":"e5b0defd-e489-4f7c-aca9-9ad734ac0307","name":"Accura Face Match","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json","updatedAt":"2024-08-27T08:22:31.000Z","createdAt":"2024-08-27T08:22:28.000Z","lastUpdatedBy":"20339982","uid":"20339982-e5b0defd-e489-4f7c-aca9-9ad734ac0307"},"item":[{"name":"https://api.accurascan.com/v2/api/facematch","id":"b1682e7e-ef19-473a-a209-970910787d77","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Api-Key","value":"Your Api Key","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"source_file","type":"file","value":null},{"key":"target_file","type":"file","value":null}]},"url":{"raw":"https://api.accurascan.com/v2/api/facematch","protocol":"https","host":["api","accurascan","com"],"path":["v2","api","facematch"]}},"response":[],"uid":"20339982-b1682e7e-ef19-473a-a209-970910787d77"}]}}
```

{% endcode %}

</details>

<figure><img src="/files/3bWqW8VMwvanxpcOxmZk" alt=""><figcaption></figcaption></figure>

<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 %}


---

# 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, and the optional `goal` query parameter:

```
GET https://docs.accurascan.com/language/web-api/accura-face-match.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.