@regulaforensics/vp-frontend-document-components
    Preparing search index...

    Interface FaceApi

    FaceApi

    interface FaceApi {
        childAgeThreshold?: number;
        childDocValidityYears?: number;
        mode?: string;
        proxy?: string;
        proxy_type?: number;
        proxy_userpwd?: string;
        search?: FaceApiSearch;
        serviceTimeout?: number;
        threshold?: number;
        url?: string;
    }
    Index

    Properties

    childAgeThreshold? childDocValidityYears? mode? proxy? proxy_type? proxy_userpwd? search? serviceTimeout? threshold? url?

    Properties

    childAgeThreshold?: number

    The age threshold for the portrait comparison. Default: 13.

    FaceApi

    childDocValidityYears?: number

    Estimated duration of validity for a child's passport, years. Default: 5.

    FaceApi

    mode?: string

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

    FaceApi

    proxy?: string

    Proxy to use, should be set according to the <a href="https://curl.se/libcurl/c/CURLOPT_PROXY.html\" target="_blank">cURL standard.

    FaceApi

    proxy_type?: number

    Proxy protocol type, should be set according to the <a href="https://curl.se/libcurl/c/CURLOPT_PROXYTYPE.html\" target="_blank">cURL standard.

    FaceApi

    proxy_userpwd?: string

    Username and password to use for proxy authentication, should be set according to the <a href="https://curl.se/libcurl/c/CURLOPT_PROXYUSERPWD.html\" target="_blank">cURL standard.

    FaceApi

    search?: FaceApiSearch

    FaceApi

    serviceTimeout?: number

    The Regula Face Web service requests timeout, ms.

    FaceApi

    threshold?: number

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

    FaceApi

    url?: string

    The URL of the Regula Face Web service to be used.

    FaceApi

    Settings

    Member Visibility

    On This Page

    Properties