Configure Emirates ID card reader integration
Clinics in the United Arab Emirates can scan a guest's Emirates ID card during form filling to auto-populate identity fields. This integration applies specifically to Nabidh compliance forms in the UAE. The integration uses a local card reader attached to the provider's workstation; form fields mapped to the Emirates ID data source are filled in from the card with one scan.
Note: This integration is required only for clinics operating under UAE regulations that mandate Emirates ID verification. Organizations outside the UAE can leave the integration disabled.
On this page
- Before you begin
- How the integration works
- Enable Emirates ID card reader on a form
- Scan an Emirates ID during form filling
- Status messages
- Troubleshooting
- Installation troubleshooting checklist
- Related articles
Before you begin
Supported card readers
The Emirates ID reader integration supports the following hardware only. Other USB smart card readers are not supported.
- COOLBABY CT30 USB Smart Card Reader
- HID OMNIKEY 3121 USB Smart Card Reader
Connect the reader to the workstation via a direct USB port connection. Do not use a USB hub.
System requirements
| Requirement | Detail |
|---|---|
| Operating system | Windows 10 or Windows 11 |
| Browser | Google Chrome or Microsoft Edge (Zenoti Web only) |
| Network | The local Emirates ID service runs on localhost:8847 and does not require an outbound internet connection for card reads. |
Install the Emirates ID reader service
A lightweight helper service must be installed on each workstation that will scan cards. This is a one-time setup per workstation and requires administrator rights.
- Connect the card reader to the workstation using a USB cable.
- Download the Emirates ID Reader Service ZIP file using the link provided by your Zenoti representative.
- Right-click the ZIP folder and select Extract All. Choose a destination folder.
- Open the extracted folder and locate the installer file named Install service.
- Right-click the installer and select Run as administrator.
- Wait for the confirmation message indicating the service has been successfully installed.
- Close the installer once installation is complete.
Note: Install the service once per workstation. The service runs automatically after installation and does not require manual restart between sessions.
Identify the fields to map
Before enabling the integration on a form, identify which guest-profile fields should be populated from the Emirates ID (for example, first name, last name, date of birth, nationality, Emirates ID number).
Permission: Edit under CustomFields in the Administrator section of the security role β Required to enable HIS integration on a form definition and to map fields.
How the integration works
- The form definition sets an HIS integration platform type that identifies the card reader integration.
- Field mappings stored in the HIS integration mapping table declare which form fields receive which Emirates ID data points (name, ID number, date of birth, nationality, etc.).
- When a provider opens the form, a card reader button appears in the form view.
- The provider places the guest's Emirates ID on the reader and selects the button.
- The form opens a popup modal that shows the reader status, detects whether a card is present, and reads the card data.
- Card values populate the mapped form fields. The provider confirms and saves the form.
Enable Emirates ID card reader on a form
Navigate to Configuration > Forms > Form creation > Custom forms.
Open the form where you want to enable card reader integration.
In the form settings panel, locate HIS platform settings and set the HIS Integration Platform to Nabidh. Setting this value enables the card reader button in the form view.
Open the HIS integration field mapping for this form. For each Emirates ID data point you want to capture, select the form field that should receive the value:
Emirates ID data point Typical mapped field First name Guest first name Last name Guest last name Emirates ID number Emirates ID (custom field) Date of birth Date of birth Nationality Nationality Gender Gender Expiry date ID expiry (custom field) Save the mapping and save the form.
Scan an Emirates ID during form filling
- Confirm the Emirates ID card reader is connected and that the local service is running on the workstation.
- Open the form in the appointment view.
- Select the Read data using card reader button in the form header. The Emirates ID Reader popup opens.
- Place the guest's Emirates ID card on the reader when prompted. The popup shows the reader status and card presence.
- When the card is read, the popup displays the captured values. Confirm and close the popup.
- The form fields mapped to the Emirates ID now show the scanned values. Edit any field that needs correction before submission.
- Save or submit the form as usual.
Status messages
When you select the card reader button in the form, one of the following statuses appears in the Emirates ID Reader popup:
| Status | Meaning | Action |
|---|---|---|
| Checking Emirates ID Service | The form is contacting the local card reader service. | Wait a moment. If this status persists, check that the helper service is installed and running. |
| Detecting Card Reader | The service is scanning for a connected card reader. | Confirm a supported reader (COOLBABY CT30 or HID OMNIKEY 3121) is connected via a direct USB port. |
| Detecting Emirates ID | A reader is detected; the service is checking for a card on the reader. | Place the Emirates ID card on the reader. |
| Reading Emirates ID | The card is detected and the service is reading the data. | Hold the card steady on the reader until reading completes. |
| Data Read Successfully | The card data has been read. | Select Fill data to populate the mapped form fields. |
| Card reader application is not live | The local helper service is not running or is not installed on this workstation. | Install or restart the helper service following the steps in Before you begin. |
| No Card Reader Detected | No supported reader is connected to the workstation. | Connect a supported reader (COOLBABY CT30 or HID OMNIKEY 3121) and retry. |
| Emirates ID Not Detected | The reader is connected but no card is inserted. | Insert the card on the reader and try again. |
| Emirates ID Expired | The card is detected but the Emirates ID has expired. Autofill is disabled. The expiry details are shown in the popup. | Request a valid, non-expired Emirates ID from the guest. |
| Read failed | The service connected and detected a card, but could not read the data. | Re-seat the card and try again. If the issue persists, try a different card reader. |
Troubleshooting
| Symptom | What to check |
|---|---|
| Read data using card reader button does not appear | The form's HIS Integration Platform is not set, the form is locked, or you are not using the Zenoti Web appointment view. Open the form settings and confirm the HIS Integration Platform is set to Nabidh. |
| Popup shows Card reader application is not live | The local Emirates ID service is not running or not installed. Reinstall the helper service following the steps in Before you begin and refresh the form. |
| Popup shows No Card Reader Detected | The reader is not connected or is connected through a USB hub. Connect the supported reader directly to a USB port on the workstation and retry. |
| Popup shows Emirates ID Not Detected | The card is not seated correctly on the reader. Re-seat the card and try again. |
| Card reads but fields are not populated | The HIS integration field mapping is incomplete. Open the mapping editor and verify that each Emirates ID data point is mapped to a form field. |
| Some fields populate but others do not | The form field expected by the mapping has been renamed or removed. Re-open the mapping editor and re-select the current form field names. |
Installation troubleshooting checklist
If the card reader button does not appear or the service is not detected, work through these steps in order:
- Confirm a supported reader is connected β Only COOLBABY CT30 and HID OMNIKEY 3121 are supported. Other readers will not work.
- Use a direct USB port β Do not connect through a USB hub or dock. Connect directly to a USB port on the workstation.
- Try a different USB port β Some USB ports may not supply sufficient power. Try another port on the same machine.
- Reinstall the helper service β Run the installer again as Administrator. The service may have failed to install or may have stopped.
- Restart the workstation β Restart the workstation and confirm the service starts automatically before opening the form.
- Escalate to IT β If the above steps do not resolve the issue, escalate to your IT team. They may need to check firewall rules for
localhost:8847or confirm Windows service startup settings.
Tips
- Always connect the card reader to a direct USB port on the workstation β USB hubs and docks can prevent the local service from detecting the reader.
- The local helper service must be installed on every workstation where providers will scan Emirates IDs. One installation does not cover multiple machines.
- If a guest's Emirates ID has expired, the popup displays the expiry details but does not fill the form. Capture the guest's information manually and advise the guest to renew their Emirates ID.