Articles in this section

"Face Domain" Assessment Object

  • Updated

The face domain attributes are recorded inside the "Face Domain" assessment object.

Note

Note that the "Face" object is part of the "Assessment" data object - see Managing Assessments.

V2 Item

Type

Description

score

Mandatory integer

The number of descriptors that were detected for the domain.

Will equal the sum of the descriptors set to true in the domain.

comment

Optional String

A comment on the assessment of the domain

mode

Mandatory String

Records the actual assessment mode. One of:

  • "manual" - the facial descriptors were manually chosen by the user

  • "video" - the facial descriptors were automatically detected using video analysis

  • "photo" - the facial descriptors were automatically detected using photo analysis

initial_mode

Optional String

Records the initial (attempted) assessment mode. One of:

  • "video" - the user tried to perform a video assessment

  • "photo" - the user tried to perform a photo assessment

This attribute is only relevant when "mode" is "manual". If the user starts with an automated video or photo assessment, and that fails, then if the user reverts to manual mode, this field records the failure.

camera

Optional String

Indicates the camera used to perform an assessment. One of:

  • "front" - the front facing (selfie) camera was used

  • "rear" - the rear facing (main) camera was used

Only relevant when "inital_mode" or "mode" is "video" or "photo".

capture_seconds

Optional Integer

The length of time a video assessment ran for (in seconds).

Only relevant when "inital_mode" or "mode" is "video"

frames

Optional Integer

The number of frames (images) assessed.

Only relevant when "inital_mode" or "mode" is "video" or "photo".

frame_errors

Optional Integer

The number of frames that failed to be assessed (e.g. due to the face not being able to be detected).

Only relevant when "inital_mode" or "mode" is "video" or "photo".

descriptors

Mandatory Object containing the 9 boolean facial descriptors

Indicates which descriptors for the domain were detected (those items will have a value of true):

  • Brow lowering

  • Cheek raising

  • Tightening of eyelids

  • Wrinkling of nose

  • Raising of upper lip

  • Pulling at corner lip

  • Horizontal mouth stretch

  • Parting lips

  • Closing eyes

A sample "Face Domain" assessment object is shown below:

"face": {
    "score": 9,
    "comment": null,
    "mode": "video",
    "initial_mode": null,
    "camera": null,
    "capture_seconds": null,
    "frames": null,
    "frame_errors": null,
    "descriptors": {
        "brow_lowering": true,
        "cheek_raising": true,
        "tightening_eyelids": true,
        "wrinkling_nose": true,
        "raising_upper_lip": true,
        "pulling_corner_lip": true,
        "mouth_stretch": true,
        "parting_lips": true,
        "closing_eyes": true
    }
}

Related articles