Biometric Integration
Overview
Integriti’s Biometric Integrations allow key functionality from 3rd party Biometric Systems to be controlled directly from the Integriti software suite, providing a single head-end for biometric enrolment and management.
Key features:
- Enrolment — Users on Integriti may be inserted to the biometric system with biometrics (fingerprints, faces) enrolled through Integriti’s credential editor interface.
- Synchronisation — User details such as name, Card Number, and start/end dates may be synchronised to the biometric device or 3rd party system.
Prerequisites
Licensing
- One Biometric Management Integration License per biometric system.
- One Managed Biometric Reader License per biometric reader.
- Sufficient Integriti Version License for the integration version.
- Some integrations may require additional feature-specific licenses (check the integration’s Release Notes).
System Requirements
Refer to the individual integration’s manual for specific pre-requisites and system requirements. If none are listed, requirements match the minimum Integriti software release.
Version Matching
The same version of each integration must be installed on both the Integriti Integration Server and all client workstations that will enrol or interact with the integration.
Step-by-Step
Installation
- Close all instances of the Integriti software suite and stop all running Integriti services on the target machine.
- Download and run the Integriti Biometric Integration installer on all Integriti servers first, then on all client workstations that will interact with the integration.
- After installation completes, restart all previously stopped services.
- If downgrading, uninstall the current version before installing an earlier version.
Enrolment
- In Integriti System Designer, select New Integrated Device from the System tab.
- Select the biometric integration from the list and press Ok.
- If the integration does not appear, ensure both 32-bit and 64-bit Integriti Integration Servers are running.
- Give the new device a Name and optionally Notes.
- Under Associated Entities, add the door(s) to associate with the biometric reader.
- On the Device Properties tab, configure Connection Configuration — set connection details to the 3rd party system, Card Number Start/End, and Card Template format.
- Optionally modify Biometric Scan Options per reader:
- Biometric Credential Type — filter UI elements; refresh each reader to auto-populate.
- Minimum Scan Quality — percentage threshold for credential quality.
- Minimum Enrolled Biometric Credentials — minimum credentials required.
- Verification Required — re-check biometric to verify match.
- Quality Check Disabled — for readers that don’t support quality checking.
- Conditional Text — display a consent message to the user (leave blank to disable).
- Click Save.
- Click Refresh Device (if available) to load configuration from the 3rd party system.
- Save and close — a persisted connection will automatically begin to the 3rd party system.
Setting Up Users
- Set Duress Code on a user to register biometrics as duress credentials (preferably use a separate user for duress).
- Set Is Juvenile for users with smaller biometric features, allowing accurate recording.
- Ensure the user has relevant permissions to the required door(s) or door list.
Acquiring Cards (Biometric Enrolment)
- Edit a user and press Acquire Card.
- Select a biometric integration credential type from the list.
- Before enrolling, ensure devices are refreshed — press Refresh Devices on the biometric system, or manually enter supported Biometric Credential types per reader.
- Device Selection — choose an enrolment device from the list; connection status will indicate success.
- Create New Card — assign a card number (mode-selected) and confirm.
- Biometric Enrolment — once a card number is chosen:
- For Fingerprints: select the finger, click Scan Fingerprint, have the user scan at the reader, follow reader instructions.
- If verification is enabled, the reader will verify after scanning.
- For other biometric types, the process is similar with type-specific options.
- Press Save Credential(s) on the plugin Biometric page, then save the user.
Biometric Entity Sync
- Entity sync runs in the background and updates users in the 3rd party system when a user is updated or new biometric credential data is added.
- The persisted connection must be enabled.
- Refresh each Biometric Reader Device to identify unique credential types per reader. Users must be enrolled per reader type (e.g., separately for Face and Fingerprint readers). Entity sync will then send credentials to all same-type readers the user has permission to use.
Verification
- After enrolment, verify the biometric system connection is established by checking the device status in Integriti.
- Open the credential editor via Acquire Card for a test user — ensure devices appear in the device selection list.
- Enrol a test user’s biometric, save, and confirm the user appears in the 3rd party biometric system.
- Test biometric authentication at a reader associated with a door — confirm access is granted and the event is logged in Integriti Review.
- Update user details in Integriti and verify the changes propagate to the biometric system via Entity Sync.
Troubleshooting
| Issue | Resolution |
|---|---|
| Plugin does not appear in ‘New Integrated Device’ list | Ensure both 32-bit and 64-bit Integriti Integration Servers are running. Restart both servers and the System Designer client. |
| Devices missing from ‘Acquire Card’ credential editor | Verify connection details in the Biometric System are correct. Check that the device is connected to the network/3rd party software. Ensure the connection user has adequate permissions to manage devices on the 3rd party system. |
| Biometric enrolment fails | Check Minimum Scan Quality settings. Ensure the reader supports the credential type. Verify the user has permissions to the associated door(s). |
| Entity Sync not updating users | Confirm persisted connection is enabled. Refresh each reader device and verify credential types are populated. |