Live comparison (using Face SDK) with Regula Document Reader SDK

Prerequisites: 

• Face Processing Service (Face SDK) installed;
• Document Reader SDK installed (alternatively, with Local Service SDK installed);
• License supporting Live comparison feature.

For more details on how to install the products above, refer to these articles:

Document Reader SDK Installation

Document Reader SDK Local Web Service installation

Face Matching Service installation

Configuration:

1. Document Reader desktop application:

• Connect Regula document reader device with an active Live Face Comparison SDK license (to get the license, contact your regional manager or send a request to support@regulaforensics.com) to your PC.
• Run the installed application Document Reader and click the "Connect" button to connect the reader.
• Open the Options menu and configure the following settings:

Description of the settings:

• Live comparison — comparison of the facial image obtained from the document (or extracted from the RFID chip) with the facial image captured from the video stream.
• Auto live capture on scan — capturing video in the process of scanning a document.
• Capture in parallel with scan — capturing video simultaneously with the scanning process.
• Show capture window — displays the video capture window.

External Camera section:

• Type — specifies the type of the connected video camera.
• Camera URL —  specifies the URL of an IP camera.
• Active device — selection of the video camera from the drop-down list of available devices.
• Resolution — selection of the video resolution from the drop-down list.
• Rotation — selection of the video rotation type from the drop-down list. 
• Depth — not set (used for cameras with a depth map).

Results section:

• Save faces — saving images of detected faces.
• Save video — saving the video of an image capture session.
• Capture results to scan folder — save the results to the folder containing scan results.
• Video quality — the quality of the saved video in percent.
• Face width threshold, % — minimum width of a face relative to the width of the video frame in percent.
• Timeout —  maximum allowed time for capturing a facial image in the frame, in ms.

Face API section:

• Type — type of connection to Regula Face Processing Service
  1. Local — the service is installed on the PC to which the document reader is connected. 
  2. Custom — the service is installed on a remote computer in the network. 
  3. Internet — in this case, requests will be sent to Regula servers (requires Internet connection).
• Service URL — the URL ( http://localhost:41101/ or https://localhost:41101/) of Regula Face Processing Service that is used when the Custom connection type is selected. Default link - http://localhost:41101
• Threshold — the minimum threshold for matching faces in percent; "75" by default.
• Service timeout — the maximum allowed time to get a response, in ms.

2. Document Reader SDK Local web service:

• Connect Regula document reader device with an active Live Face Comparison SDK license (to get the license, contact your regional manager or send a request to support@regulaforensics.com) to your PC.

• Open RegulaReader.ini configuration file located at one of the following paths:

  If the service is installed under the current user:
  C:\Users\{USERNAME}\AppData\Local\Regula\Document Reader SDK\RegulaReader.ini

  If the service is installed under the system user:
  C:\Windows\SysWOW64\config\systemprofile\AppData\Local\Regula\Document Reader SDK (x64)\RegulaReader.ini

• Make sure the following line is present inside the file:

• DoLiveFaceComparison=1

  If necessary, change this value manually in the file.

• After making changes, make sure to restart Regula.SDK.Service.Host in Windows services for the new settings to take effect.

Additional settings for Live Comparison

• DoLiveFaceCaptureInParallel=1 - the check is performed in parallel with document processing;
• AutoLiveCaptureOnScan=1 - the camera is invoked automatically hen scanning a document;
• SaveLiveCaptureToScanFolder=1 - the photo is saved to the results folder;
• FaceAPIThreshold=75 - similarity threshold is set to the indicated value.

Document Scanning + Live Comparison

While scanning a document, the image capture window opens automatically (when AutoLiveCaptureOnScan=1). If the the flag is disabled (AutoLiveCaptureOnScan=0), image capture can be invoked via the Face Matching button:

The comparison results are displayed in the Portrait comparison section:

Important notes: