CHcheckout
Face Authentication

Create a face authentication attempt

<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.

If you've already created an attempt for this authentication, the authentication status 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.

post/face-authentications/{face_authentication_id}/attempts

Request

Path parameters

face_authentication_idstring required

The face authentication's unique identifier.

Request body

redirect_urlstring uri required

The URL to redirect the applicant to after the attempt.

Example request

{
  "phone_number": {
    "country_code": "+33",
    "number": "5555550102"
  },
  "client_information": {
    "pre_selected_residence_country": "FR",
    "pre_selected_language": "en-US"
  }
}

Response

Face authentication attempt created successfully

created_onstring date-time required

The date and time when the resource was created, in UTC. <br/>Format – yyyy-mm-ddThh:mm:ss.sss

modified_onstring date-time required

The date and time when the resource was modified, in UTC. <br/>Format – yyyy-mm-ddThh:mm:ss.sss

Example response

{
  "created_on": "2025-07-21T17:32:28.0000000+00:00",
  "modified_on": "2025-07-21T17:40:32.0000000+00:00"
}

Changes

No recorded changes to this operation across all 1 revision of this API.