Face Recognition Settings

The Face Recognition settings are defined in JSON format as key-value pairs. The following settings are available:

Setting JSON Key Description
Entity Name SourceEntityName

The name of the entity where the Face Recognition process.

Required only if the Face Recognition process starts from an edit form, to update the business status after the Face Recognition process ends.
  DestinationEntityName Name of the entity that is populated with the data returned by face recognition.
Name SourceLookupDestinationName Name of the SourceEntityName lookup key that points to DestinationEntityName. If they are the same entity, enter the primary key.
File FileAttributeName The name of the file attribute where the first picture that will be used in the Compare Process, is saved (the image from the OCR process).
Maximum number of face recognition attempts MaxRetry

The maximum number of face recognition attempts.

If this number is reached, the user will be redirected according to the specifications in the maskNextStepUrlFail.
Confidence MinimumAcceptedConfidence The minimum confidence value that the Face Recognition process has to generate in order to consider the compare result a success. Value is a number between 0.00 and 1.00.
Redirect in case of success maskNextStepUrlSuccess

Location in the user interface where the user is redirected after a successful face recognition process.

  • entity – Entity name.
  • form – Form name of the above entity.
  • section – Optional parameter for the section name of the above form.

The section can be specified using the name of the section or the section’s number. Example "section": "Personal Data" and "section": "1" are both valid.
Redirect in case of failure maskNextStepUrlFail

Location in the user interface where the user is redirected after the maximum number of failed face recognition attempts is reached (see MaxRetry).

  • entity – Entity name.
  • form – Form name of the above entity.
  • section – Optional parameter for the section name of the above form.

The section can be specified using the name of the section or the section’s number. Example "section": "Current Account" and "section": "4" are both valid.
Business status update in case of success businessStatusSuccess Business workflow status update of the Entity Name if the face recognition process is successful.
Business status update in case of failure businessStatusFail Business workflow status update of the Entity Name if the face recognition process fails.
NOTE  
For Liveness, please see Liveness. In the Settings of the Face Recognition, it is possible to insert a key ''isLiveness'' : true to configure the feature.

Examples

Copy 
{
    "isLiveness": false,
    "DestinationEntityName": "Test1",
    "SourceEntityName": "Test",
    "SourceLookupDestinationName": "Test1id",
    "FileAttributeName": "pictureOcr",    
    "MaxRetry": 5,
    "MinimumAcceptedConfidence": 0.2, 
    "maskNextStepURLSuccess": {"entity":"Test", "form": "FaceResponse" },
    "maskNextStepURLFail": {"entity":"Test", "form": "FaceResponse" },
    "businessStatusSuccess": "Face Recognition Valid",
    "businessStatusFail": "Face Recognition Failed"
}
NOTE   The Result of Face Recognition execution will be saved in the entity: FTOS_DFP_FaceRecognition.