@regulaforensics/face-sdk
    Preparing search index...

    Interface VerificationConfig

    interface VerificationConfig {
        attemptsCount?: number;
        cameraPositionAndroid?: number;
        cameraPositionIOS?: CameraPosition;
        cameraSwitchEnabled?: boolean;
        closeButtonEnabled?: boolean;
        copyright?: boolean;
        groupId?: string;
        livenessType?: LivenessType;
        locationTrackingEnabled?: boolean;
        metadata?: Record<string, any>;
        personId: string;
        preventScreenRecording?: boolean;
        recordingProcess?: RecordingProcess;
        screenOrientation?: ScreenOrientation[];
        skipStep?: LivenessSkipStep[];
        tag?: string;
        threshold?: number;
        torchButtonEnabled?: boolean;
        vibrateOnSteps?: boolean;
    }
    Index
    attemptsCount? cameraPositionAndroid? cameraPositionIOS? cameraSwitchEnabled? closeButtonEnabled? copyright? groupId? livenessType? locationTrackingEnabled? metadata? personId preventScreenRecording? recordingProcess? screenOrientation? skipStep? tag? threshold? torchButtonEnabled? vibrateOnSteps?
    attemptsCount?: number

    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.

    cameraPositionAndroid?: number

    Android only.

    cameraPositionIOS?: CameraPosition

    IOS only.

    cameraSwitchEnabled?: 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 = LivenessType.PASSIVE.

    closeButtonEnabled?: boolean
    copyright?: boolean

    Defines, whether the logo is visible on the bottom of Liveness UI screens. Defaults to true.

    groupId?: string
    livenessType?: LivenessType

    Defines whether the liveness processing type. Defaults to LivenessType.ACTIVE.

    locationTrackingEnabled?: boolean

    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.

    metadata?: Record<string, any>
    personId: string
    preventScreenRecording?: boolean

    Prevents screenshots and screen recording while FaceCapture camera screen is displayed. Defaults to false.

    recordingProcess?: RecordingProcess

    Defines whether the liveness recording video of processing. Defaults to RecordingProcess.ASYNCHRONOUS_UPLOAD.

    screenOrientation?: ScreenOrientation[]

    Allows you to specify an orientation of the camera view controller.

    skipStep?: LivenessSkipStep[]

    Defines which steps of the user interface can be omitted. See LivenessSkipStep enum for details.

    tag?: string

    Defines tag that can be used in Liveness processing. Defaults to null.

    threshold?: number
    torchButtonEnabled?: 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 = LivenessType.PASSIVE.

    vibrateOnSteps?: boolean

    Enables vibration during Liveness processing. Defaults to true.

    Settings
    Member Visibility

    On This Page
    Properties