UBubble
Face authentications

Create an attempt

This endpoint allows you to create a new Attempt. It is possible when the face-authentication is in one of the following statuses created, pending, capture_in_progress, retry_required

post/v2/face-authentications/{face_authentication_id}/attempts

Request

Path parameters

face_authentication_idstring required

ID of the face authentication

Request body

redirect_urlstring uri
mobile_handoff_urlstring uri nullable

Optional. URL encoded in the QR code shown when the verification is opened on a desktop, so the end user can continue on their phone through your own flow. Defaults to the verification URL. Accepts https URLs and app deeplinks. Max 512 characters.

Example request

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

Response

Attempt created

idstring
status'pending_redirection' | 'capture_in_progress' | 'checks_in_progress' | 'completed' | 'expired' | 'capture_aborted' | 'capture_refused' | 'checks_inconclusive' | 'terminated'

States of an attempt.

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

redirect_urlstring uri
mobile_handoff_urlstring uri nullable

Optional. URL encoded in the QR code shown when the verification is opened on a desktop, so the end user can continue on their phone through your own flow. Defaults to the verification URL. Accepts https URLs and app deeplinks. Max 512 characters.

Example response

{
  "applicant_session_information": {
    "ip_address": "123:456:789:00",
    "number_of_sessions": 3,
    "user_agent": "Mozilla/5.0 (Linux; Android 8.0.0; SM-G960F Build/R16NW) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/62.0.3202.84 Mobile Safari/537.36"
  },
  "created_on": "2017-07-21T17:32:28Z",
  "modified_on": "2017-07-21T17:40:32Z",
  "phone_number": {
    "country_code": "+33",
    "number": "2068133616"
  },
  "client_information": {
    "pre_selected_residence_country": "US",
    "pre_selected_language": "en-US"
  }
}

Changes

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