@regulaforensics/document-reader
    Preparing search index...

    Class FaceApiParams

    Index
    constructor
    livenessTransactionId? mode proxy? proxyPassword? proxyType? searchParams? serviceTimeout threshold url
    fromJson

    • Parameters

      • Optionaloptions: {
            livenessTransactionId?: string;
            mode?: string;
            proxy?: string;
            proxyPassword?: string;
            proxyType?: number;
            searchParams?: FaceApiSearchParams;
            serviceTimeout?: number;
            threshold?: number;
            url?: string;
        }

      Returns FaceApiParams

    livenessTransactionId?: string

    This parameter allows you to use a liveness transaction id instead of a selfie photo.

    mode: string

    The processing mode: "match" or "match+search".

    "match"
    proxy?: string

    Proxy to use, should be set according to the cURL standart.

    proxyPassword?: string

    Username and password to use for proxy authentication, should be set according to the cURL standart.

    proxyType?: number

    Proxy protocol type, should be set according to the cURL standart.

    searchParams?: FaceApiSearchParams

    A search filter that can be applied if the "match+search" mode is enabled.

    serviceTimeout: number

    The service request timeout, ms.

    3000
    threshold: number

    The similarity threshold, 0-100. Above 75 means that the faces' similarity is verified, below 75 is not.

    75
    url: string

    The URL of the Regula Face SDK service instance to be used.

    "https://faceapi.regulaforensics.com"

    • Allows you to deserialize object.

      Parameters

      • jsonObject: any

      Returns FaceApiParams

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods