> For the complete documentation index, see [llms.txt](https://docs.caf.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.caf.io/caf-api/connect/transactions/services/facematch.md).

# Facematch

Comparison of the document photo and the selfie.

**Section**: `facematch`

**Required files:** `selfie and document image containing a picture`

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

| Attribute    | Type    | Description                                                                                            |
| ------------ | ------- | ------------------------------------------------------------------------------------------------------ |
| statusCode   | String  | Query status ([details](/caf-api/connect/transactions/background-check/data-structure.md#status-code)) |
| confidence   | Number  | Level of similarity in the compared images                                                             |
| identical    | Boolean | Confirmation of similarity                                                                             |
| ageRange     | String  | Approximate age range (optional)                                                                       |
| gender       | String  | `Male` or `Female` (optional)                                                                          |
| {% endtab %} |         |                                                                                                        |

{% tab title="Example" %}

```json
{
  "facematch": {
    "statusCode": "01",
    "confidence": 0.90068,
    "identical": true,
    "ageRange": "16 - 22",
    "gender": "Male"
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                          | Description                                                                                                         |
| ----------------------------- | ------------------------------------------------------------------------------------------------------------------- |
| facematch\_has\_selfie\_photo | The rule checks whether the submission contains a selfie or not. What triggers the rule is the absence of a selfie. |
| facematch\_is\_equal          | Compare the similarity of the document to the selfie.                                                               |
| liveness\_manual\_revision    | This rule sends the selfie for manual anti-spoofing verification.                                                   |
| {% endtab %}                  |                                                                                                                     |
| {% endtabs %}                 |                                                                                                                     |

{% hint style="info" %}
**Note about the "gender" field:** The value returned in this field is the result of an automated estimate made by artificial intelligence models based on analysis of the image submitted. This classification does not necessarily reflect the gender identity with which the person identifies. Therefore, it is only an attribute inferred by the system, without any value judgment or intention to define the individual's personal identity.
{% 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.caf.io/caf-api/connect/transactions/services/facematch.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
