2. Biometric

There are two primary functions within this class. The first one is verifyFace and the second is verifyLiveness.

2.1. verifyFace

This function performs 1:1 (One-on-One) face verification using a selfie photo or selfie video against a reference face image.

Declaration

(async) verifyFace(referenceFaceImage, facePhoto, faceVideo) → {Promise.<*>}

Here are the input and output parameters defined against this function.

Type (In/Out)NameDescription
String - [In]referenceFaceImageThis can be a file path, base64 content, URL, or cache reference face image against which the target face over the picture or video must be verified.
String - [In]facePhotoThis parameter is a face image that can be a file path, base64 content or URL, or cache reference mapped to the referenceFaceImage for verification purposes.
String - [In]faceVideoThis parameter is a face video which can be a file path, base64 content, or URL mapped to the referenceFaceImage for verification purposes. The function will use BLANK value if the parameter is left out during execution.
Promise.<*> - [Out]N/AThe entire verification object is streamed into resp.data named parameter and returned.

2.2. verifyLiveness

This function enables users to perform standalone liveness checks on selfie photos or videos.

Declaration

(async) verifyLiveness(facePhoto, faceVideo) → {Promise.<*>}

Here are the input and output parameters defined against this function.

Type (In/Out)NameDescription
String - [In]facePhotoThis parameter is a face image which can be a file path, base64 content or URL, or cache reference mapped to the faceVideo for verification purposes. The function will use the BLANK value if the parameter is left out during execution.
String - [In]faceVideoThis parameter is a face video which can be a file path, base64 content, or URL mapped to the facePhoto for verification purposes. The function will use BLANK value if the parameter is left out during execution.
Promise.<*> - [Out]N/AThe entire verification object is streamed into resp.data named parameter and returned.