CHcheckout
Face Authentication

Create a face authentication

<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 a face authentication for an applicant you've previously verified using the Identity Verification solution.

Ensure you use your Face Authentication configuration ID.

post/face-authentications

Request

Request body

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

applicant_idstring required

The applicant's unique identifier.

user_journey_idstring required

Your configuration ID.

status'approved' | 'capture_in_progress' | 'checks_in_progress' | 'created' | 'declined' | 'inconclusive' | 'pending' | 'refused' | 'retry_required' required

The face authentication status.

risk_labelsIdvRiskLabel[] required

One or more codes that provide more information about risks associated with the verification.

idstring required

The face authentication's unique identifier.

Example request

{
  "created_on": "2025-07-21T17:32:28.0000000+00:00",
  "modified_on": "2025-07-21T17:40:32.0000000+00:00",
  "applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr7we",
  "user_journey_id": "usj_tkoi5db4hryu5cei5vwoabr7we",
  "response_codes": [
    {
      "summary": "document_front_not_captured"
    }
  ],
  "face": {
    "image_signed_url": "https://storage-b.ubble.ai/ubble-ai/NDYOOVHGZPAQ/a54b3393-f02a-47c9-a9c5-2f6ee73560e1/bb603e2f-5de9-40f2-9631-8285a33c24c0/live_face/bb603e2f-5de9-40f2-9631-8285a33c24c0-1679921946714.png?response-content-type=image%2Fpng&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=V9jgOdpOdeVSFTkA4ZsG%2F20230327%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20230327T163223Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=2b7d87fec4f11f0df949da7beade2519cf1a51ce70fe9cc1cf0470d73f5340e4"
  },
  "id": "fav_mtta050yudd54y5iqb5ijh8jtvz"
}

Response

Face authentication 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

applicant_idstring required

The applicant's unique identifier.

user_journey_idstring

Your configuration ID.

status'approved' | 'capture_in_progress' | 'checks_in_progress' | 'created' | 'declined' | 'inconclusive' | 'pending' | 'refused' | 'retry_required' required

The face authentication status.

risk_labelsIdvRiskLabel[] required

One or more codes that provide more information about risks associated with the verification.

idstring required

The face authentication's unique identifier.

Example response

{
  "created_on": "2025-07-21T17:32:28.0000000+00:00",
  "modified_on": "2025-07-21T17:40:32.0000000+00:00",
  "applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr7we",
  "user_journey_id": "usj_tkoi5db4hryu5cei5vwoabr7we",
  "face": {
    "image_signed_url": "https://storage-b.ubble.ai/ubble-ai/NDYOOVHGZPAQ/a54b3393-f02a-47c9-a9c5-2f6ee73560e1/bb603e2f-5de9-40f2-9631-8285a33c24c0/live_face/bb603e2f-5de9-40f2-9631-8285a33c24c0-1679921946714.png?response-content-type=image%2Fpng&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=V9jgOdpOdeVSFTkA4ZsG%2F20230327%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20230327T163223Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=2b7d87fec4f11f0df949da7beade2519cf1a51ce70fe9cc1cf0470d73f5340e4"
  },
  "response_codes": [
    {
      "summary": "document_front_not_captured"
    }
  ],
  "id": "fav_mtta050yudd54y5iqb5ijh8jtvz"
}

Changes

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