FaceAuthenticator (Deprecated)
Importing SDK
To use FaceAuthenticator, you can either remotely import the .js
file or download it locally.
Remotely
Include the .js
file directly from the CDN:
You can retrieve the class from the SDK using the following code:
Locally
Download the .js
file and import it as an ES6 module:
Construction
In the builder, the SDK receives a single parameter with the settings:
Supported parameters
* Advanced capture consists of using more complex and not-so-stable APIs in browsers that support them (e.g. ImageCapture)
Example
CaptureStage
CaptureStage allows the client to configure the stages. To do this, we offer the CaptureStage
object, where you can set the following parameters:
Example CaptureStage
Initialization
initialize(): Promise<void>
initialize(): Promise<void>
The SDK has a separate method of initialization, to allow greater control over when it occurs.
During this initialization, the SDK will initialize its internal variables and download the resources it needs to run.
[!] You must call this method before using other SDK methods.
[!] The initialization of the SDK can take a few seconds. We recommend that you call this function as early as possible in your flow so that opening the SDK is smooth for the user.
Example
Utilization
Opening and taking selfies
capture(container: HTMLElement, stages, {personData?: PersonData, totalAttempts?: Number}): Promise<Result>
Method used to load the SDK onto the screen and perform selfie capture.
It will initialize the video stream (requesting permissions if needed) and load it into the container.
Parameters
¹ If not specified, automatic capture is used.
² If not specified, a default value of 30 seconds is used.
Example
Return
The return consists of an object with the following fields:
Close SDK
close(): Promise<void>
close(): Promise<void>
The method used to remove the SDK on the screen.
De-initialize the SDK
dispose(): Promise<void>
dispose(): Promise<void>
The method used to remove the SDK on the screen.
Will de-initialize the video stream and clear the SDK's internal variables
Complete Example
Soon.
Last updated