Skip to content

Integration with Face API

The integration of Face API to Document Reader adds an automatic face match and search by a portrait taken from the document (Visual Zone and RFID-chip) or a live owner photo. In this case, the defined settings will be applied on the service startup.

If you need to adjust the Face API parameters via the request parameters, see the Using Face SDK integration page.

To set up the integration with Face API, use:

      url: ""
      mode: "match+search"
      search: "limit: 10"
      proxy: "https://proxy:8080"
      proxy_userpwd: "Regula%20User:StrongPassword"
      proxy_type: "CURLPROXY_SOCKS5"  
      threshold: 80
      serviceTimeout: 2500
      childAgeThreshold: 12
      childDocValidityYears: 6
Parameter Type Default Description
url string "" URL of Regula Face SDK service instance. Note that the default URL can be used for demo purposes only. For production purposes, you should purchase an appropriate license. For details, follow the link to the Face SDK.
mode string "match" Processing mode: match or match+search.

match is a comparison of persons that are passed in the request, enabled by default.

match+search performs both matching and searching by image. If only one person is available, match procedure is skipped and only the search is performed. If no search parameters are specified, the search is conducted over the entire database with the default parameters.

For more information, explore the OpenAPI documentation.
search string Search filter that can be applied if the match+search mode is enabled. May include limit, threshold, group_ids. If the group_ids are specified, the search is performed only in these groups. For more information, explore the OpenAPI documentation.
proxy string Proxy server to use, should be set according to the cURL standard.
proxy_userpwd string Username and password to use for proxy authentication, should be set in accordance with the cURL standard.
proxy_type string Proxy protocol type, should be set according to the cURL standard.
threshold integer 75 The similarity threshold, 0-100. Above 75 means that the faces' similarity is verified, below 75 is not.
serviceTimeout integer 3000 Service request timeout, ms.
childAgeThreshold integer 13 Minimum age of a child, at which photo comparison is initiated.
childDocValidityYears integer 5 Estimated duration of validity for a child's passport, years.