---
description: >-
  This method is used to find if there's multiple Biometrid Ids that match the
  the faces sent on the request.
---

# Find Multiple Id by Face

## Find-by-Multiple

<mark style="color:green;">`POST`</mark> `Https://api.biometrid.com/api/1.0/users/find-by-multiple`

Find multiple Biometrid Ids by faces present on photo.

#### Headers

| Name               | Type   | Description                                                                                                                                             |
| ------------------ | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Content-type       | string | Request content type (This is not required to be set. Referenced only to show how we expect data to be sent). { "Content-Type": "multipart/form-data" } |
| x-biometrid-key    | string | <p>Application Client Key<br></p>                                                                                                                       |
| x-biometrid-secret | string | Application Client Secret                                                                                                                               |

#### Request Body

| Name     | Type    | Description                                                                                                      |
| -------- | ------- | ---------------------------------------------------------------------------------------------------------------- |
| liveness | boolean | Optional liveness state flag. For now, just implemented on the biometrid SDK.                                    |
| photo    | object  | Image file containing user's face for biometric analysis. File format: jpeg, png or jpg. Maximum file size 1 Mb. |

{% tabs %}
{% tab title="200 Success 200 types" %}
{% code title="HTTP/1.1 200 OK" %}
```javascript
// Find Id by Face
    {
      "status": true,
      "data": {
        "message": "FACE_RECOGNIZED_WITH_SUCCESS"
        "verified": true,
        "usersFound" [
          {
              "userId": '5be3000bd3adgd3e152724f2',
              "confidence": '0.78'
          },
          {
              "userId": '5be3000bd3adgd3e15263123',
              "confidence": '0.83'
          }
        ]
      }
  }
// Find Id by Face failed.
  {
      "status": false,
      "data": {
          "message": "FACE_ENROLLMENT_FAILED",
          "reason": "No faces found on 'photo'"
        }
  }
```
{% endcode %}
{% endtab %}

{% tab title="400 Bad Request types" %}
{% code title="HTTP/1.1 400 Bad Request" %}
```javascript
//No photo file detected on request. Not sent or invalid format
    {
        "status": false,
        "data": {
            "message": "NO_FILE_OR_INVALID_FORMAT"
        }
    }
    
// Missing Headers
 {
    "status": false,
    "data": {
        "message": "AUTHENTICATION_HEADERS_MISSING"
    }
}
```
{% endcode %}
{% endtab %}

{% tab title="401 Invalid Headers." %}
{% code title="HTTP/1.1 401 Unauthorized" %}
```javascript
{
    "status": false,
    "data": {
        "message": "INVALID_AUTHENTICATION_HEADERS"
    }
}
```
{% endcode %}
{% endtab %}

{% tab title="402 Payment Required - Request Limit Reached for Client Plan." %}
{% code title="HTTP/1.1 402 Payment Required" %}
```javascript
{
    "status": false,
    "data": {
        "message": "REQUEST_LIMIT_REACHED"
    }
}
```
{% endcode %}
{% endtab %}

{% tab title="404 Not Found request types" %}
{% code title="HTTP/1.1 404 Not Found" %}
```javascript
// No active engine configuration for this provider.
    {
        "status": false,
        "data": {
            "message": "NO_FACE_ENGINE_CONFIGURATION_AVAILABLE"
        }
    }

//Client not found by given key.
    {
        "status": false,
        "data": {
            "message": "CLIENT_NOT_FOUND/CHECK_AUTHENTICATION_HEADERS"
        }
    }
 
```
{% endcode %}
{% endtab %}
{% endtabs %}

{% code title="Example (JSON)" %}
```javascript
{
    "photo": face.jpeg
    "liveness": true
}
```
{% endcode %}



### Success 200 <a href="#success-200" id="success-200"></a>

| Field      | Type    | Description                                                                               |
| ---------- | ------- | ----------------------------------------------------------------------------------------- |
| status     | Boolean | Response status.                                                                          |
| data       | Object  | Response main data.                                                                       |
| message    | String  | Message regarding process status.                                                         |
| verified   | Boolean | If present, indicates the status for the verification process.                            |
| usersFound | Array   | Array containing a pair of userId/confidence for each enrolled user present on the photo. |
| userId     | String  | Biometrid Id return by the process if face match an already enrolled user.                |
| confidence | String  | Confidence returned by the engine regarding the face verification. (between 0-1)          |

