@regulaforensics/face-sdk 8.3.1105-nightly → 8.3.1107-rc

package/www/types/liveness/enrollment_config.d.ts

@@ -0,0 +1,97 @@
+import { CameraPosition } from '../customization/camera_position'
+import { ScreenOrientation } from '../customization/screen_orientation'
+import { RecordingProcess, LivenessType, LivenessSkipStep } from './liveness_config'
+
+export interface EnrollmentConfig {
+    /**
+     * Defines, whether the logo is visible on the bottom of Liveness UI screens. Defaults to `true`.
+     */
+    copyright?: boolean
+
+    /**
+     * Defines, whether the camera's toolbar switch camera button is available on the Liveness UI. Defaults to `false`.
+     * When set to `true` the CameraToolbarView will contain a button to change current `cameraPosition`.
+     * Only for livenessType = {@link LivenessType.PASSIVE}.
+     */
+    cameraSwitchEnabled?: boolean
+
+    closeButtonEnabled?: boolean
+
+    /**
+     * Defines, whether the camera's toolbar torch button is available on the Liveness UI. Defaults to `true`.
+     * When set to `false` the CameraToolbarView won't contain a button to toggle camera's flashlight.
+     * Only for livenessType = {@link LivenessType.PASSIVE}.
+     */
+    torchButtonEnabled?: boolean
+
+    /**
+     * Enables vibration during Liveness processing. Defaults to `true`.
+     */
+    vibrateOnSteps?: boolean
+
+    /**
+     * Android only.
+     */
+    cameraPositionAndroid?: number
+
+    /**
+     * IOS only.
+     */
+    cameraPositionIOS?: CameraPosition
+
+    /**
+     * Allows you to specify an orientation of the camera view controller.
+     */
+    screenOrientation?: Array<ScreenOrientation>
+
+    /**
+     * Defines whether the liveness request sends a location of a device. Defaults to `true`.
+     * When set to `true` the liveness request to web service will contain the `location`
+     * object within the json `metadata` object.
+     * The location is used only when permissions are granted and the location is available.
+     */
+    locationTrackingEnabled?: boolean
+
+    /**
+     * Prevents screenshots and screen recording while FaceCapture camera screen is displayed.
+     * Defaults to `false`.
+     */
+    preventScreenRecording?: boolean
+
+    /**
+     * The number of attempts to pass the Liveness before completing with error. Defaults to `0`.
+     * When set to `0`  the Liveness will always ask to retry on error.
+     */
+    attemptsCount?: number
+
+    /**
+     * Defines whether the liveness recording video of processing.
+     * Defaults to {@link RecordingProcess.ASYNCHRONOUS_UPLOAD}.
+     */
+    recordingProcess?: RecordingProcess
+
+    /**
+     * Defines whether the liveness processing type. Defaults to {@link LivenessType.ACTIVE}.
+     */
+    livenessType?: LivenessType
+
+    /**
+     * Defines tag that can be used in Liveness processing. Defaults to `null`.
+     */
+    tag?: string
+
+    /**
+     * Defines which steps of the user interface can be omitted. See {@link LivenessSkipStep} enum for details.
+     */
+    skipStep?: Array<LivenessSkipStep>
+
+    metadata?: Record<string, any>
+
+    externalId: string
+
+    groupId?: string
+
+    checkDuplicatesEnabled?: boolean
+
+    duplicatesThreshold?: number
+}

package/www/types/liveness/enrollment_request.d.ts

@@ -0,0 +1,6 @@
+export interface EnrollmentRequest {
+    externalId: string
+    groupId?: string
+    trustedImage?: string
+    trustedImageUrl?: string
+}

package/www/types/liveness/enrollment_response.d.ts

@@ -0,0 +1,9 @@
+import { ErrorResponse } from './error_response'
+
+export class EnrollmentResponse {
+    readonly personId?: string
+    readonly externalId?: string
+    readonly error?: ErrorResponse
+
+    private constructor()
+}

package/www/types/liveness/error_response.d.ts

@@ -0,0 +1,6 @@
+export class ErrorResponse {
+    readonly code: number
+    readonly message: string
+
+    private constructor()
+}

package/www/types/liveness/liveness_config.d.ts

@@ -121,6 +121,7 @@ export enum RecordingProcess {
 export enum LivenessType {
     ACTIVE,
     PASSIVE,
+    PASSIVE_WITH_BLINK,
 }
 
 export enum LivenessSkipStep {

package/www/types/liveness/liveness_exception.d.ts

@@ -18,6 +18,7 @@ export enum LivenessErrorCode {
     PROCESSING_FAILED,
     PROCESSING_FRAME_FAILED,
     APPLICATION_INACTIVE,
+    BAD_FACE_QUALITY,
     CONTEXT_IS_NULL,
     IN_PROGRESS_ALREADY,
     ZOOM_NOT_SUPPORTED,

package/www/types/liveness/liveness_notification.d.ts

@@ -26,6 +26,8 @@ export enum LivenessProcessStatus {
     FAILED,
     RETRY,
     SUCCESS,
+    BLINK,
+    BAD_FACE_QUALITY,
 }
 
 export type LivenessNotificationCompletion = (notification: LivenessNotification) => void

package/www/types/liveness/verification_config.d.ts

@@ -0,0 +1,95 @@
+import { CameraPosition } from '../customization/camera_position'
+import { ScreenOrientation } from '../customization/screen_orientation'
+import { RecordingProcess, LivenessType, LivenessSkipStep } from './liveness_config'
+
+export interface VerificationConfig {
+    /**
+     * Defines, whether the logo is visible on the bottom of Liveness UI screens. Defaults to `true`.
+     */
+    copyright?: boolean
+
+    /**
+     * Defines, whether the camera's toolbar switch camera button is available on the Liveness UI. Defaults to `false`.
+     * When set to `true` the CameraToolbarView will contain a button to change current `cameraPosition`.
+     * Only for livenessType = {@link LivenessType.PASSIVE}.
+     */
+    cameraSwitchEnabled?: boolean
+
+    closeButtonEnabled?: boolean
+
+    /**
+     * Defines, whether the camera's toolbar torch button is available on the Liveness UI. Defaults to `true`.
+     * When set to `false` the CameraToolbarView won't contain a button to toggle camera's flashlight.
+     * Only for livenessType = {@link LivenessType.PASSIVE}.
+     */
+    torchButtonEnabled?: boolean
+
+    /**
+     * Enables vibration during Liveness processing. Defaults to `true`.
+     */
+    vibrateOnSteps?: boolean
+
+    /**
+     * Android only.
+     */
+    cameraPositionAndroid?: number
+
+    /**
+     * IOS only.
+     */
+    cameraPositionIOS?: CameraPosition
+
+    /**
+     * Allows you to specify an orientation of the camera view controller.
+     */
+    screenOrientation?: Array<ScreenOrientation>
+
+    /**
+     * Defines whether the liveness request sends a location of a device. Defaults to `true`.
+     * When set to `true` the liveness request to web service will contain the `location`
+     * object within the json `metadata` object.
+     * The location is used only when permissions are granted and the location is available.
+     */
+    locationTrackingEnabled?: boolean
+
+    /**
+     * Prevents screenshots and screen recording while FaceCapture camera screen is displayed.
+     * Defaults to `false`.
+     */
+    preventScreenRecording?: boolean
+
+    /**
+     * The number of attempts to pass the Liveness before completing with error. Defaults to `0`.
+     * When set to `0`  the Liveness will always ask to retry on error.
+     */
+    attemptsCount?: number
+
+    /**
+     * Defines whether the liveness recording video of processing.
+     * Defaults to {@link RecordingProcess.ASYNCHRONOUS_UPLOAD}.
+     */
+    recordingProcess?: RecordingProcess
+
+    /**
+     * Defines whether the liveness processing type. Defaults to {@link LivenessType.ACTIVE}.
+     */
+    livenessType?: LivenessType
+
+    /**
+     * Defines tag that can be used in Liveness processing. Defaults to `null`.
+     */
+    tag?: string
+
+    /**
+     * Defines which steps of the user interface can be omitted. See {@link LivenessSkipStep} enum for details.
+     */
+    skipStep?: Array<LivenessSkipStep>
+
+    metadata?: Record<string, any>
+
+    personId: string
+
+    groupId?: string
+
+    threshold?: number
+}

package/www/types/liveness/verification_response.d.ts

@@ -0,0 +1,10 @@
+import { VerifyMatchResponse } from './verify_match_response'
+import { ErrorResponse } from './error_response'
+
+export class VerificationResponse {
+    readonly passed?: boolean
+    readonly match?: VerifyMatchResponse
+    readonly error?: ErrorResponse
+
+    private constructor()
+}

package/www/types/liveness/verify_match_response.d.ts

@@ -0,0 +1,6 @@
+export class VerifyMatchResponse {
+    readonly passed?: boolean
+    readonly similarity?: number
+
+    private constructor()
+}