Face Activity Parameters
Face Activities
Face Quality Assessment
Perform a face quality assessment to ensure that the captured face image meets the threshold values as defined in the input parameters.
| Parameter | Description | Type | Default |
|---|---|---|---|
| Face Key | The name of the process variable containing the name of the face being captured. | STRING | face1 |
Confirm Face Image
Prompts the user to confirm that the captured face image is acceptable before progressing to the next step of the ID&V flow.
| Parameter | Description | Type | Default |
|---|---|---|---|
| List of Screens | The list of screens to be presented to the user during the capture process. Possible values include: capture, instructions, and preview. | LIST_STRING | [ "capture", "instructions", "preview" ] |
| Starting Component ID | The name of the capture step to be sent to the UI. | STRING | face-capture |
| UI Component ID | The name of the screen used in the capture UI. | STRING | preview |
Beta
Confirm Face Image v2
Prompts the user to confirm that the captured face image is acceptable before progressing to the next step of the ID&V flow.
| Parameter | Description | Type | Default |
|---|---|---|---|
| Allow Retake | Set whether retaking the selfie image is available. When true, a retake button will appear on the confirmation screen, allowing the user to retake the selfie image. | BOOLEAN | ${false} |
| List of Screens | The list of screens to be presented to the user during the capture process. Possible values include: capture, instructions, and preview. | LIST_STRING | [ "capture", "instructions", "preview" ] |
| Starting Component ID | The name of the capture step to be sent to the UI. | STRING | face-capture |
| UI Component ID | The name of the screen used in the capture UI. | STRING | preview |
Face Template Generation
Generate a face template using DaonFace v5.
| Parameter | Description | Type | Default |
|---|---|---|---|
| Face Key | The name of the process variable containing the name of the face being captured. | STRING | face1 |
Early Access
Facev7 Template Generation - v1
Generate a face template using DaonFace v7.
| Parameter | Description | Type | Default |
|---|---|---|---|
| Face Key | The name of the process variable containing the name of the face being captured. | STRING | face1 |
Capture Face Image
This activity prompts the end user to capture a face image.
| Parameter | Description | Type | Default |
|---|---|---|---|
| Camera Height | The height of the camera set during capture. | INTEGER | ${720} |
| Camera Width | The width of the camera set during capture. | INTEGER | ${1280} |
| Face Image Format | The format of the image to be captured. | STRING | jpeg |
| Face Key | The identifier of the Face. | STRING | face1 |
| List of Screens | The list of screens to be presented to the user during the capture process. Possible values include: instructions, capture, and preview. | LIST_STRINGS | ["instructions", "capture", "preview"], |
| Starting Component ID | The name of the capture step to be sent to the UI | STRING | face-capture |
| Timeout in Seconds | Camera timeout in seconds. | INTEGER | ${60} |
| UI Component ID | The name of the screen used in the capture UI. | STRING | instructions |
Capture Face Image v2
This activity prompts the end-user to capture a face image.
| Parameter | Description | Type | Default |
|---|---|---|---|
| Advanced configuration | A JSON formatted block where users can provide additional configurations for face capture. | String | {"lastPassedFrameDelayInMilliseconds":150} |
| Camera Height | The height of the camera set during capture. | INTEGER | ${720} |
| Camera Width | The width of the camera set during capture. | INTEGER | ${1280} |
| Face Image Format | The format of the image to be captured. | STRING | jpeg |
| Face Key | The identifier of the Face. | STRING | face1 |
| List of Screens | The list of screens to be presented to the user during the capture process. Possible values include: instructions, capture, and preview. | LIST_STRINGS | ["instructions", "capture", "preview"], |
| Starting Component ID | The name of the capture step to be sent to the UI | STRING | face-capture |
| Timeout in Seconds | Camera timeout in seconds. | INTEGER | ${60} |
| UI Component ID | The name of the screen used in the capture UI. | STRING | instructions |
| Use Native Capture | BOOLEAN | ${false} |
Capture Face Image v2.1
This activity prompts the end-user to capture a face image.
| Parameter | Description | Type | Default |
|---|---|---|---|
| Advanced configuration | A JSON formatted block where users can provide additional configurations for face capture. | String | {"lastPassedFrameDelayInMilliseconds":150} |
| Camera Height | The height of the camera set during capture. | INTEGER | ${720} |
| Camera Width | The width of the camera set during capture. | INTEGER | ${1280} |
| Face Image Format | The format of the image to be captured. | STRING | jpeg |
| Face Key | The identifier of the Face. | STRING | face1 |
| List of Screens | The list of screens to be presented to the user during the capture process. Possible values include: instructions, capture, and preview. | LIST_STRINGS | ["instructions", "capture", "preview"], |
| Starting Component ID | The name of the capture step to be sent to the UI | STRING | face-capture |
| Timeout in Seconds | Camera timeout in seconds. | INTEGER | ${60} |
| UI Component ID | The name of the screen used in the capture UI. | STRING | instructions |
| Use Native Capture | BOOLEAN | ${false} |
Early Access
Capture Face Image v2.1 - Back Camera
This activity prompts the end-user to capture a face image using the back-facing camera by default.
| Parameter | Description | Type | Default |
|---|---|---|---|
| Advanced configuration | A JSON formatted block where users can provide additional configurations for face capture. | String | {"lastPassedFrameDelayInMilliseconds":150} |
| Camera Height | The height of the camera set during capture. | INTEGER | ${720} |
| Camera Width | The width of the camera set during capture. | INTEGER | ${1280} |
| Face Key | The identifier of the Face. | STRING | face1 |
| List of Screens | The list of screens to be presented to the user during the capture process. Possible values include: instructions, capture, and preview. | LIST_STRINGS | ["instructions", "capture"], |
| Starting Component ID | The name of the capture step to be sent to the UI | STRING | face-capture-v2 |
| Timeout in Seconds | Camera timeout in seconds. | INTEGER | ${60} |
| UI Component ID | The name of the screen used in the capture UI. | STRING | instructions |
| Use Native Capture | If enabled, face capture will be handled natively. | BOOLEAN | ${false} |
Document to Face Matching v2
This activity will check to determine that a live captured face image matches
Error navigation screen
| Parameter | Description | Type | Default |
|---|---|---|---|
| Document Key | The identifier of the document. | STRING | doc1 |
| The screen to navigate to when an error occurs | STRING_LIST | [instructions] | |
| Exception on Max Attempts Exceeded | If the maxAttempts is exceeded, should exceedFailedLivenessCount exception be thrown | BOOLEAN | ${true} |
| Face Key | The identifier of the face. | STRING | face1 |
| Face Match Threshold | The threshold value which determines if a face is considered a match. | DOUBLE | ${0.339689} |
| Internal Face Match Threshold | The internal face matching threshold determines whether v4 of the face matching algorithm will be used alongside the v3 algorithm. If the result of the match against the v3 is higher than the internal threshold, a v4 template is generated. The v4 score will then be compared to the face matching threshold. | DOUBLE | ${0.29408} |
| Max Attempts | The number of failed attempts of face liveness before the exceedFailedLivenessCount exception is thrown. | INTEGER | ${3} |
Deprecated
Face Liveness Assessment v1.42
This activity will show a live camera preview and perform an in-the-moment passive liveness detection to determine that the face is real and not a captured image from a screen or mask.
| Parameter | Description | Type | Default |
|---|---|---|---|
| Error navigation screen | The screen to navigate after an error occurs. | STRING | preview |
| Exception on Max Attempts Exceeded | If the maxAttempts is exceeded, should exceedFailedLivenessCount exception be thrown. | BOOLEAN | ${true} |
| Face Key | The identifier of the face. | STRING | face1 |
| Liveness Threshold | The threshold value which determines if a face is considered to be a live face. | DOUBLE | ${0.5} |
| Max Attempts | The number of failed attempts of face liveness before the exceedFailedLivenessCount exception is thrown. | INTEGER | ${3} |
| Pipeline | The name of the pipeline. | STRING | iris |
Face Liveness Assessment v1.47
This activity will show a live camera preview and perform an in-the-moment passive liveness detection to determine that the face is real and not a captured image from a screen or mask.
| Parameter | Description | Type | Default |
|---|---|---|---|
| Error navigation screen | The screen to navigate after an error occurs. | STRING | preview |
| Exception on Max Attempts Exceeded | If the maxAttempts is exceeded, should exceedFailedLivenessCount exception be thrown. | BOOLEAN | ${true} |
| Face Key | The identifier of the face. | STRING | face1 |
| Liveness Threshold | The threshold value which determines if a face is considered to be a live face. | DOUBLE | ${0.5} |
| Max Attempts | The number of failed attempts of face liveness before the exceedFailedLivenessCount exception is thrown. | INTEGER | ${3} |
| Pipeline | The name of the pipeline. | STRING | pad-r-1 |
Early Access
xFace Liveness Assessment v1.49
This activity will show a live camera preview and perform an in-the-moment passive liveness detection to determine that the face is real and not a captured image from a screen or mask.
| Parameter | Description | Type | Default |
|---|---|---|---|
| Error navigation screen | The screen to navigate after an error occurs. | STRING | preview |
| Exception on Max Attempts Exceeded | If the maxAttempts is exceeded, should exceedFailedLivenessCount exception be thrown. | boolean | ${true} |
| Face Key | The identifier of the face. | string | face1 |
| Max Attempts | The number of failed attempts of face liveness before the exceedFailedLivenessCount exception is thrown. | integer | ${3} |
| Pipeline and Calibrations | Contains the pipeline name and calibration | map<string,string> | <pad-r-1,REGULAR> |
| Pipeline and Thresholds | Contains the pipeline name and threshold | map<string,double> | <pad-r-1,0.5> |
Early Access
Facev7 Match Document to Face - v1
Performs a document to face match using DaonFace v7.
| Parameter | Description | Type | Default |
|---|---|---|---|
| Document Key | The identifier of the document. | STRING | doc1 |
| Error navigation screen | The screen to navigate to when an error occurs | STRING_LIST | [instructions] |
| Exception on Max Attempts Exceeded | If the maxAttempts is exceeded, should exceedFailedLivenessCount exception be thrown | BOOLEAN | ${true} |
| Face Key | The identifier of the face. | STRING | face1 |
| Face Match Threshold | The threshold value which determines if a face is considered a match. | DOUBLE | ${0.337601} |
| Internal Face Match Threshold | The internal face matching threshold determines whether v4 of the face matching algorithm will be used alongside the v3 algorithm. If the result of the match against the v3 is higher than the internal threshold, a v4 template is generated. The v4 score will then be compared to the face matching threshold. | DOUBLE | ${0.28968} |
| Max Attempts | The number of failed attempts of face liveness before the exceedFailedLivenessCount exception is thrown. | INTEGER | ${3} |
Watchlist Match
The Watchlist Match activity is used to check whether the current end-user undergoing the ID&V process matches with any member of a selected watchlist.
| Parameter | Description | Type | Default |
|---|---|---|---|
| Face Key | A unique identifier used to identify the face captured during the Process Instance. | STRING | ${face1} |
| Max Candidates | The maximum number of match candidates to return after comparing the face image to the list of watchlist members. | INTEGER | ${10} |
| Watchlist | A drop-down list of all watchlists created by the tenant in TrustX. The end-user will be matched against the selected watchlist. Only one watchlist is supported per Watchlist Match activity. Note: This parameter is required. |
STRING | |
| Max Attempts | The number of failed attempts of face liveness before the exceedFailedLivenessCount exception is thrown. | INTEGER | ${3} |
| Watchlist Threshold | Threshold value used by the algorithm to determine how strict or relaxed the face matching will be. | DOUBLE | ${0.205245} |
| URL Template | The template of the URL. | STRING | /api/idlive-face-v1-36/check_liveness |
Add Face Watchlist Member
This activity is used to add the current captured identity to a chosen watchlist.
| Parameter | Description | Type | Default |
|---|---|---|---|
| Represents the email associated with the user completing the Process Instance. This is derived from the Process Definition Token. | STRING | {{processvar._initVars.email}} | |
| Expire After | An ISO formatted date that defines when the watchlist member will expire. This field is optional. | STRING | |
| External ID | A unique identifier used to identify the Process Instance associated with the watchlist. | STRING | {{processvar._initVars.extId}} |
| Face Key | A unique identifier used to identify the face captured during the Process Instance. | STRING | ${face1} |
| First Name | Represents the first name associated with the user completing the Process Instance. This is derived from the Process Definition Token. | STRING | {{processvar._initVars.firstName}} |
| Last Name | Represents the last name associated with the user completing the Process Instance. This is derived from the Process Definition Token. | STRING | {{processvar._initVars.lastName}} |
| Other Attributes | Additional parameters to be included when creating the new watchlist. This is expressed as a list of key-value pairs. For example: {"Middle Name":"John"} |
STRING | {} |
| Phone Number | Represents the phone number associated with the user completing the Process Instance. This is derived from the Process Definition Token. | STRING | {{processvar._initVars.phoneNumber}} |
| Watchlist | A drop-down list of all watchlists created by the tenant in TrustX. The end-user will be matched against the selected watchlist. Only one watchlist is supported per Watchlist Match activity. Note: This parameter is required. |
STRING |
Deprecated
Capture Face Plus Image
Face Capture Plus does not support developer mode. If the browser developer tools console is open during development and testing, it will not be possible to perform face capture.
| Parameter | Description | Type | Default |
|---|---|---|---|
| Capture Liveness Threshold | The threshold value used to determine the strictness of the Face Plus check. The default value is 0.5. | DOUBLE | ${0.5} |
| Exception on Max Attempts Exceeded | Determines whether to throw an exception if the maximum number of capture attempts are exceeded. This is enabled by default. | BOOLEAN | ${true} |
| Face Key | The unique identifier of the captured face image. | STRING | face1 |
| List of Screens | The list of screens to be shown to the end-user. | STRING_LIST | {instructions, capture} |
| Max Attempts | The maximum number of attempts allowed. | INTEGER | ${3} |
| Payload Size | Contains the encrypted image of the face. Possible values include "normal" and "small". A small payload means faster but less secure processing. | STRING | normal |
| Starting component ID | The unique identifier of the activity. | STRING | face-capture-plus |
| Timeout (in seconds) | The amount of time before a timeout will occur. This value is represented in seconds. | INTEGER | ${60} |
| UI Component Id | The name of the screen used in the capture UI. | STRING | instructions |
Capture Face Plus Image v2
Face Capture Plus does not support developer mode. If the browser developer tools console is open during development and testing, it will not be possible to perform face capture.
| Parameter | Description | Type | Default |
|---|---|---|---|
| Capture Liveness Threshold | The threshold value used to determine the strictness of the Face Plus check. The default value is 0.5. | DOUBLE | ${0.5} |
| Exception on Max Attempts Exceeded | Determines whether to throw an exception if the maximum number of capture attempts are exceeded. This is enabled by default. | BOOLEAN | ${true} |
| Face Key | The unique identifier of the captured face image. | STRING | face1 |
| List of Screens | The list of screens to be shown to the end-user. | STRING_LIST | {instructions, capture} |
| Max Attempts | The maximum number of attempts allowed. | INTEGER | ${3} |
| Payload Size | Contains the encrypted image of the face. Possible values include "normal" and "small". A small payload means faster but less secure processing. | STRING | normal |
| Starting component ID | The unique identifier of the activity. | STRING | face-capture-plus-v2 |
| Timeout (in seconds) | The amount of time before a timeout will occur. This value is represented in seconds. | INTEGER | ${60} |
| UI Component Id | The name of the screen used in the capture UI. | STRING | instructions |
Early Access
Capture xFace IAD v2.3.1 Image
| Parameter | Description | Type | Default |
|---|---|---|---|
| Capture Liveness Threshold | The threshold value used to determine the strictness of the Face Plus check. The default value is 0.5. | double | ${0.5} |
| Exception on Max Attempts Exceeded | Determines whether to throw an exception if the maximum number of capture attempts are exceeded. This is enabled by default. | boolean | ${true} |
| Face Key | The unique identifier of the captured face image. | string | face1 |
| List of Screens | The list of screens to be shown to the end-user. | list[string] | [instructions, capture] |
| Max Attempts | The maximum number of attempts allowed. | integer | ${3} |
| Payload Size | Contains the encrypted image of the face. Possible values include "normal" and "small". A small payload means faster but less secure processing. | string | normal |
| Starting component ID | The unique identifier of the activity. | string | face-capture-plus-v2 |
| Timeout (in seconds) | The amount of time before a timeout will occur. This value is represented in seconds. | integer | ${60} |
| UI Component ID | The name of the screen used in the capture UI. | string | instructions |
External Source Face Upload v1
This enables users to upload an external source face to compare against a live face image. When executed, it will generate a pre-signed URL and store it under the output variable.
| Parameter | Description | Type | Default |
|---|---|---|---|
| Face Key | The unique identifier of the uploaded external face image. | STRING | xface1 |
| Image Format | The file type of the image to be uploaded. Currently only jpeg is supported. | STRING | jpeg |
| Output Variable | The variable where the Upload URL will be stored. This will be available to cloud functions or other activities (e.g. external pages) | STRING | {faceKey}_uploadURL |
External Source Face Match v1
This activity is used to match a live face image captured during a Process Instance with an external source uploaded using the 'External Source Face Upload v1' activity.
| Parameter | Description | Type | Default |
|---|---|---|---|
| Error navigation screen | The screen that will be shown in case of an error. | STRING | instructions |
| Exception on Max Attempts Exceeded | Determines whether to throw an exception if the maximum number of capture attempts are exceeded. This is enabled by default. | BOOLEAN | ${true} |
| External Face Key | The unique identifier of the uploaded external face image. | STRING | xface1 |
| Face Match Thresholds | Sets the face match threshold. | DOUBLE | ${0.285022850229} |
| Internal Face Match Thresholds | The internal face matching threshold determines whether v4 of the face matching algorithm will be used alongside the v3 algorithm. If the result of the match against the v3 is higher than the internal threshold, a v4 template is generated. The v4 score will then be compared to the face matching threshold. | DOUBLE | ${0.2764227642276423} |
| Live Face Key | The unique identifier of the face captured during the Process Instance. | STRING | face1 |
| Max Attempts | The number of match attempts allowed before an error is thrown. | INTEGER | ${3} |
Early Access
External Source Face Match v2
This activity is used to match a live face image captured during a Process Instance with an external source uploaded using the 'External Source Face Upload v1' activity.
| Parameter | Description | Type | Default |
|---|---|---|---|
| Error navigation screen | The screen that will be shown in case of an error. | STRING | instructions |
| Exception on Max Attempts Exceeded | Determines whether to throw an exception if the maximum number of capture attempts are exceeded. This is enabled by default. | BOOLEAN | ${true} |
| External Face Key | The unique identifier of the uploaded external face image. | STRING | externalFace1 |
| Face Match Thresholds | Sets the face match threshold. | DOUBLE | ${0.3010674949749498} |
| Internal Face Match Thresholds | The internal face matching threshold determines whether v4 of the face matching algorithm will be used alongside the v3 algorithm. If the result of the match against the v3 is higher than the internal threshold, a v4 template is generated. The v4 score will then be compared to the face matching threshold. | DOUBLE | ${0.28968} |
| Live Face Key | The unique identifier of the face captured during the Process Instance. | STRING | face1 |
| Max Attempts | The number of match attempts allowed before an error is thrown. | INTEGER | ${3} |
On This Page
Face Activity ParametersFace ActivitiesFace Quality AssessmentConfirm Face Image Beta
Confirm Face Image v2Face Template Generation Early Access
Facev7 Template Generation - v1Capture Face ImageCapture Face Image v2Capture Face Image v2.1 Early Access
Capture Face Image v2.1 - Back CameraDocument to Face Matching v2 Deprecated
Face Liveness Assessment v1.42Face Liveness Assessment v1.47 Early Access
xFace Liveness Assessment v1.49 Early Access
Facev7 Match Document to Face - v1Watchlist MatchAdd Face Watchlist Member Deprecated
Capture Face Plus ImageCapture Face Plus Image v2 Early Access
Capture xFace IAD v2.3.1 ImageExternal Source Face Upload v1External Source Face Match v1 Early Access
External Source Face Match v2