FaceAuth Result - ARGOS Identity

A Webhook is triggered when the AddOn faceAuth is submitted and the final result (auth_status) is determined.
The Webhook is sent to the Webhook URL registered in the existing ID check project. To register a Webhook, refer to this guide.
The Webhook trigger is “faceAuth”.

faceauth-webhook-sample.json

{
  "webhook_trigger": "faceAuth", 
  "data": {
    "Submission_id": "{String}",
    "Auth_Status": "{String}",
    "Create_Time": "{String}",
    "Auth_User_id": "{String}",
    "Auth_cf1": "{String}",
    "Auth_cf2": "{String}",
    "Auth_cf3": "{String}",
    "Token_id" : "{String}",
    "reference": {
      "userid": "{String}",
      "email": "{String}",
      "cf": {
        "cf1": "{String}",
        "cf2": "{String}",
        "cf3": "{String}"
      }
    },
    "Authentication_id": "{String}"
  }
}

faceAuth is compared with approved submissions from previously submitted ID checks

target: Parameters used in the query string when making a FaceAuth request
reference: Previously submitted ID check submission that serves as the comparison target for faceAuth

string

Webhook trigger type - faceAuth indicates this is a faceAuth webhook

string

Unique ID for each faceAuth submission [authId]

object

Webhook payload data

Show properties

string

Unique ID of the specific submission that serves as the target for faceAuth comparison

string

Indicates the final result of faceAuth. Returns approved (success) or rejected (failure)

string

Date and time when faceAuth was submitted (UTC+0)

string

User_id parameter optionally added when creating the target Submission_id

Used as authUserId in FaceAuth URL parameters

string

Custom field #1 of the target

Used as authCf1 in FaceAuth URL parameters

string

Custom field #2 of the target

Used as authCf2 in FaceAuth URL parameters

string

Custom field #3 of the target

Used as authCf3 in FaceAuth URL parameters

string

Token Id used in the target

Used as token in FaceAuth URL parameters

object

Reference submission that serves as the comparison target for faceAuth

Show properties

string

Reference Submission_id’s userid that serves as the comparison target for faceAuth

string

Email of the reference Submission_id that serves as the comparison target for faceAuth

object

Custom fields of the reference Submission_id that serves as the comparison target for faceAuth

Show properties

string

cf1 of the reference

string

cf2 of the reference

string

cf3 of the reference

Getting Started

FaceAuth Getting Started

FaceAuth further verifies identity by comparing the selfie of a user approved in the ID check process with the selfie captured during FaceAuth. This page covers the two delivery methods (URL / API), the FaceAuth URL query string structure, and the request parameter definitions.

POST/Face-auth

An API that creates a FaceAuth submission by comparing the face image you send against the reference image of an approved KYC submission.

GET/Face-auth (List)

An API that lists FaceAuth submissions in order of most recent creation time, with cursor-based pagination and a date range filter.

​Related documents

Getting Started

FaceAuth Getting Started

POST/Face-auth

GET/Face-auth (List)

Related documents