---
title: "Create a face authentication attempt"
method: POST
path: "/face-authentications/{face_authentication_id}/attempts"
tags: ["Face Authentication"]
---

# Create a face authentication attempt

`POST /face-authentications/{face_authentication_id}/attempts`

## Request

- Base URL: `https://identity-verification.checkout.com`
- URL: `https://identity-verification.checkout.com/face-authentications/{face_authentication_id}/attempts`
- Auth: one of:
  - OAuth 2
    - Client credentials
    - Token URL: `string` scopes: `identity-verification`
  - API key in header `Authorization`
- TypeScript: <https://skmtc.dev/checkout/apis/checkout-com-api-reference/docs/face-authentications/:face_authentication_id/attempts/post.ts> (a function with typed inputs; its response is checked against the schema)

<span style="font-size: 12px; font-weight: 500; color: rgb(0, 0, 0); background-color: rgb(255, 176, 97); border-radius: 4px; padding: 2px 6px" >Beta</span><p></p>
Create an attempt for a [face authentication](https://www.checkout.com/docs/business-operations/manage-identities/authenticate-with-biometrics).

If you've already created an attempt for this authentication, the [authentication status](https://www.checkout.com/docs/developer-resources/codes/identity-verification-codes#Face_Authentication_statuses) must be one of the following:

- `created`
- `pending`
- `capture_in_progress`
- `retry_required`

If you create a new attempt while the status is any other value, you receive a `409 Conflict` response.

## Path parameters

- `face_authentication_id` string, required

## Request body

- FavAttemptRequest
  - `redirect_url` string, uri, required: The URL to redirect the applicant to after the attempt.
  - `phone_number` IdvPhoneNumber: The applicant's mobile phone number, if sharing the attempt URL via SMS.
    - `country_code` string, required: The international [phone country code](https://www.checkout.com/docs/resources/codes/country-codes).
    - `number` string, required: The applicant's mobile number, without the country code.
  - `client_information` FavClientInformation: The applicant's details.
    - `pre_selected_residence_country` string: The applicant's residence country. <br/>Standard – [ISO alpha-2 country code](/developer-resources/codes/country-codes) <br/>Example – `FR`
    - `pre_selected_language` string, IETF BCP 47 language tag: The language you want to use for the user interface. <br/>Format – IETF BCP 47 language tag

## Response `201`

Face authentication attempt created successfully

- FavAttemptResponse
  - `created_on` string, date-time, required: The date and time when the resource was created, in UTC. <br/>Format – `yyyy-mm-ddThh:mm:ss.sss`
  - `modified_on` string, date-time, required: The date and time when the resource was modified, in UTC. <br/>Format – `yyyy-mm-ddThh:mm:ss.sss`

## Other responses

- `404`: Not Found
- `409`: Conflict
- `500`: Internal Server Error

---

[API](https://skmtc.dev/checkout/apis/checkout-com-api-reference.md) - [All operations](https://skmtc.dev/checkout/apis/checkout-com-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/checkout/apis/checkout-com-api-reference/revisions/0f1abdb1c3e9?raw)