Face Object

(Facial recognition)

AttributeDescription

auditTrailImageId

The id of the image of the user that performs facial recognition in case a manual review is needed for security and auditing purposes. See Download a resource for details on how to download the image.

matchLevel

Five accuracy settings are defined from 1 to 5 with accuracy lower or equal to 1 being the worst and greater or equal to 5 being the best.

  • 1: we do not recommend using this level, which is intended for really bad ID photos only.

  • 2: still a relatively high false acceptance rate, should be the lowest acceptable level when using photo scans.

  • 3: moderate accuracy level.

  • 4: quite OK.

  • 5: the identity can be seen as approved.

match

The facial recognition matches the id photo of the document. If available, the id photo from the chip is taken, otherwise the id photo from the optical scanning is taken. It will always be true at this level; the process doesnโ€™t continue if face doesnโ€™t match all the documents provided. Unless you enable the feature to return the data for an incomplete session, in that case, if a face object exists, it could be false.

oneToNVerificationId

1:N face match verification id. It's essential to store this unique ID in your system alongside the user's record, facilitating future searches for users with the same ID. Please be aware that this attribute is available only when oneToNVerification is enabled. This feature requires a specific permission, otherwise, it is disregarded

oneToNVerificationMatch

Indicates if there was a match with a previously onboarded selfie. Please be aware that this attribute is available only when oneToNVerification is enabled. This feature requires a specific permission, otherwise, it is disregarded

Last updated