> For the complete documentation index, see [llms.txt](https://developer.myidentitypass.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.myidentitypass.com/products/biometric/face-1/face-authentication.md).

# Face Enrollment

## Enrol User

<mark style="color:green;">`POST`</mark> `https://api.myidentitypay.com/api/v2/biometrics/merchant/user/enroll`

This endpoint allows you to enrol users

#### Query Parameters

| Name                                          | Type   | Description                                                           |
| --------------------------------------------- | ------ | --------------------------------------------------------------------- |
| last\_name<mark style="color:red;">\*</mark>  | string | User's last name                                                      |
| first\_name<mark style="color:red;">\*</mark> | string | User's first name                                                     |
| face\_image<mark style="color:red;">\*</mark> | string | image url of user's face(use the best practices to genrate the image) |
| email<mark style="color:red;">\*</mark>       | string | User's Email address                                                  |

#### Headers

| Name                                        | Type   | Description                 |
| ------------------------------------------- | ------ | --------------------------- |
| X-Api-Key<mark style="color:red;">\*</mark> | string | \<your merchant secret key> |
| app-id<mark style="color:red;">\*</mark>    | String | \<your app id>              |

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

```
{
    "status": true,
    "detail": "User Enrollment Successful"
}
```

{% endtab %}
{% endtabs %}
