UBubble
Face authentications

Retrieve a face authentication

This endpoint allows you to get the detailed results of a face authentication.

get/v2/face-authentications/{face_authentication_id}

Request

Path parameters

face_authentication_idstring required

Face authentication unique identifier.

Example:fav_tkoi5db4hryu5cei5vwoabr7we

ID of the face authentication

Response

Face authentication retrieved

idstring

Face authentication unique identifier.

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

Status of the verification.

risk_labelsRiskLabel[]

Risk assessment labels

user_journey_idstring

User journey unique identifier.

applicant_idstring

Applicant unique identifier.

webhook_urlstring uri
created_onstring date-time required

UTC Date time when the resource was created

modified_onstring date-time required

UTC Date time when the resource was modified

Example response

{
  "id": "fav_tkoi5db4hryu5cei5vwoabr7we",
  "user_journey_id": "usj_tkoi5db4hryu5cei5vwoabr7we",
  "applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr7we",
  "created_on": "2017-07-21T17:32:28Z",
  "modified_on": "2017-07-21T17:40:32Z"
}

Changes

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