faceliveness-ionic v1.0.8
faceliveness-ionic
Plugin Ionic FaceLiveness
Install
npm install faceliveness-ionic
npx cap syncAPI
Configure(...)
Configure(options: ConfigureOptions) => Promise<void>Allows to cofigure the FaceLivenessPlugin.
You only need to call it once, but you must call it before other methods in this class.
| Param | Type |
|---|---|
options | ConfigureOptions |
startSDK(...)
startSDK(options: LivenessStartOptions, callback: GenericCallback) => Promise<string>Start the FaceLiveness SDK.
| Param | Type | Description |
|---|---|---|
options | LivenessStartOptions | Options to start the SDK. |
callback | GenericCallback | Allows you to specify a callback and receive the events or any error that happens. |
Returns: Promise<string>
Interfaces
ConfigureOptions
| Prop | Type | Description | Default |
|---|---|---|---|
mobileToken | string | Token to configure the SDK with. | |
stage | CAFStageValues | Stage that is related to the token. | 'prod' |
filter | FilterValues | Filter to be used. | 'line-drawing' |
useCustomLoadingScreen | boolean | Used to enable a default loading progressbar during loading events. You can set your customized loading screen instead, using the {@link LoadEvent}. | false |
enableScreenshots | boolean | Android Only Used to enable screenshots during the SDK scan. Disabled by default for security reasons. | false |
imageUrlExpirationTime | TimeValues | Used to configure an image URL expiration time. | 'null' |
LivenessStartOptions
| Prop | Type | Description |
|---|---|---|
personId | string | Identification of the person (E.g.: CPF) |
LoadEvent
Simple Load events that hints when there is a loding process happening.
The events following this interface are emmited from the onLoading and onLoaded native callback methods.
| Prop | Type |
|---|---|
type | 'loaded' | 'loading' |
SuccessEvent
Success event emmited by the onSuccess native callback method.
| Prop | Type |
|---|---|
type | 'success' |
data | SuccessData |
SuccessData
| Prop | Type | Description |
|---|---|---|
signedResponse | string | JWT containing the information related to the FaceAuthenticator/FaceLiveness. |
Type Aliases
CAFStageValues
DictionaryValues<typeof CAFStage>
DictionaryValues
Typekeyof Type
FilterValues
DictionaryValues<typeof Filter>
TimeValues
DictionaryValues<typeof Time>
GenericCallback
Callback that allow handling of events that happens during the authentication/liveness process. The error argument will be set when the onCancel and onError native callbacks execute.
(events: LoadEvent | SuccessEvent | null, err?: any): void