English Română

Drag to rotate • Scroll to zoom • Right-click to move

Welcome! This guide covers everything you need to set up and operate the Metrici Document Scanner. This device scans identity documents (ID cards and passports), recives detected license plates from LPR engine, and processes travel documents such as AWBs and invoices. All captured data is sent to the Metrici web application for centralized visitor and carrier management "Visitor Journal".

Table of Contents

  1. Introduction
  2. First Boot
  3. Settings
  4. Visitor Journal
  5. API Reference
  6. User Flow
  7. Troubleshooting

1. Introduction

The Metrici Document Scanner is a hardware terminal developed by Metrici for automated visitor, carrier, and deliverer registration at facility access points. The device uses a built-in camera to capture and extract information from identity documents (national ID cards and passports) and travel documents (invoices, AWBs). It also integrates with the Metrici LPR (License Plate Recognition) system to associate each visitor with their vehicle plate number.

All captured data — personal details, document images, plate numbers, and travel documents — is transmitted to the Metrici Visitor Journal web application via REST API calls. From the Visitor Journal, administrators can review, approve, and manage all visitor records in a centralized dashboard.

The device uses an AI-powered LLM (Large Language Model) to extract structured data from document images, supporting multiple document formats and languages. The built-in touch screen guides each user through the registration process with a simple, step-by-step interface available in 15 languages.

Key features:

Technical Data

SpecificationDetails
DescriptionDocument scanning terminal for visitor registration with LPR integration
Document TypesNational ID cards, passports, invoices, AWBs
AI EngineLLM-based data extraction (configurable model, default: qwen3vl)
ConnectivityEthernet 10/100/1000 Mbps (RJ45)
PowerPoE+ (Power over Ethernet Plus, IEEE 802.3at minimum) — power and data over a single cable. Standard PoE (802.3af) is not sufficient.
DisplayBuilt-in touch screen with guided workflow
CameraBuilt-in high-resolution document camera
Languages15 (English, Romanian, Bulgarian, Hungarian, Polish, Serbian, Ukrainian, Turkish, Croatian, French, Italian, Spanish, Portuguese, German, Dutch)
IntegrationMetrici Visitor Journal (REST API), Metrici LPR
ConfigurationWeb-based interface accessible at device IP address
Extracted FieldsCNP Number, Document Type, Serial Number, Birth Date, Last Name, First Name, Nationality, Sex
Auto-restartConfigurable delay (default 20 seconds) — returns to start after session completion

Workflow Overview

The Document Scanner follows a guided step-by-step flow for each visitor or carrier:

🌐 Language 👤 Role 🚗 Plate 🪪 ID Scan 📄 Documents 📍 Destination ✅ Access

Connectivity & Power

The Metrici Document Scanner is powered through PoE+ (Power over Ethernet Plus). A single Ethernet cable delivers both electrical power and network data to the device — no separate power adapter is needed. Simply connect the device to a PoE+-capable switch or PoE+ injector using a standard RJ45 Ethernet cable, and the device will power on and connect to the network simultaneously.

PoE+ minimum required! This device requires PoE+ (IEEE 802.3at) as a minimum standard — standard PoE (IEEE 802.3af) does not provide sufficient power. Make sure your network switch or injector supports PoE+ (802.3at) or higher (PoE++/802.3bt). Using a standard PoE-only port will result in the device failing to power on or operating unreliably.
Single cable setup: The Ethernet cable carries both power and data over the same cable. This means only one cable runs to the device — minimizing installation complexity and cable clutter. No separate power supply, power outlet, or additional wiring is needed at the installation point.

2. First Boot

2.1 Language Selection

When the device starts, the first screen displayed is the language selection — see Fig.1 Language Selection. The visitor selects their preferred language by tapping the corresponding flag. The entire interface (instructions, buttons, and messages) will switch to the chosen language for the remainder of the session.

Language selection screen showing 15 language options with national flags
Fig.1 Language Selection — 15 supported languages

Supported languages: English, Romanian, Bulgarian, Hungarian, Polish, Serbian, Ukrainian, Turkish, Croatian, French, Italian, Spanish, Portuguese, German, and Dutch.

Note: After the session completes (access granted or cancelled), the device automatically restarts and returns to this language selection screen. The restart delay is configurable in the Application Settings (default: 20 seconds).

3. Settings

The device is configured through a web-based interface accessible at the device's IP address from any browser on the same network. The configuration page has three tabs: Admin Settings, Application Settings, and Network Settings.

3.1 Admin Settings

Accessing the Admin Menu

To access the admin menu on the device, tap the bottom area of the screen with your finger (on the device) or click with your mouse (in the browser) 8 times in succession — see Fig.1 Language Selection (1). After the 8th tap/click, the Admin Settings panel will appear.

Note: This gesture-based access method is designed to prevent accidental entry into the admin configuration. Make sure to tap/click firmly and in the same area each time.

The Admin Settings tab allows you to set or change the admin password used to access the configuration interface — see Fig.2 Admin Settings.

Configuration page showing Admin Settings tab with New Admin Password field, Save and Exit buttons
Fig.2 Admin Settings — Change admin password

Enter a new password in the New Admin Password field and click Save. Leave the field empty to keep the current password. Click Exit to return to the main application without saving.

Important! Always set a strong admin password to prevent unauthorized access to the configuration interface. Please make sure you do not forget the password, as it cannot be changed. You will need to send the device back to Metrici to have the password reset.

3.2 Application Settings

The Application Settings tab contains all API endpoints and operational parameters — see Fig.3 Application Settings.

Configuration page showing Application Settings tab with Request Access URL, LLM API URL, Plate Number URL, LLM Model, Destinations URL, and Restart Delay fields
Fig.3 Application Settings — API endpoints and configuration
FieldDescriptionExample Value
Request Access URLThe Metrici Visitor Journal API endpoint for submitting access requestshttp://IP_ADDRESS/api_v2/vj/event_receiver.php
LLM API URLThe AI service endpoint used for document data extractionhttp://LLM_ADDRESS:PORT/v1/chat/completions
Plate Number URLThe Metrici LPR API endpoint for retrieving the last recognized plate numberhttp://IP_ADDRESS/api_v2/lpr/get_last_plate.php?camera_id=2
LLM ModelThe AI model used for document recognitionqwen3vl
Destinations URLThe API endpoint for fetching the list of available destinationshttp://IP_ADDRESS/api_v2/vj/get_destinations.php?location_id=1
Restart Delay (seconds)How many seconds the device waits before resetting to the start screen after a session completes20

Before saving, replace the placeholders in the URLs with the correct values for your setup:

Placeholder Description
IP_ADDRESS The actual IP address of your Metrici server.
LLM_ADDRESS:PORT The address and port of your LLM service.
camera_id= The ID of the camera (in the web application) that detects your license plates.
location_id= The ID of the location. Open the location in the web application and read it from the URL — for example, in http://localhost/pages/view_location/2, the location ID is 2.

Make sure all URLs are reachable from the device's network, then click Save to apply the changes.

3.3 Network Settings

The Network Settings tab displays the current Ethernet interface information — see Fig.4 Network Settings.

Configuration page showing Network Settings tab with Interface (eth0), IP Address, and MAC Address
Fig.4 Network Settings — Ethernet interface information
FieldDescription
InterfaceThe network interface name (e.g., eth0)
IP AddressThe current IP address assigned to the device
MAC AddressThe hardware MAC address of the Ethernet adapter

To access the configuration interface, open a browser on the same network and navigate to the device's IP address.

Connecting via Browser

The device's full configuration is accessible remotely from any browser — you do not need physical access to the device to change settings. To connect:

  1. First, find the device's IP address. You can do this in two ways:
    • From the device itself: open the admin menu (tap the bottom of the screen 8 times), go to the Network Settings tab, and read the IP Address field — see Fig.4 Network Settings.
    • From your router: check your router's DHCP client list or connected devices page to find the IP assigned to the Document Scanner.
  2. Open any web browser (Chrome, Firefox, Edge, Safari) on a computer or phone connected to the same network as the device.
  3. Type the IP address in the browser's address bar. For example, if the Network Settings tab shows 192.168.100.133, navigate to:

http://192.168.100.133

The configuration page will load, giving you access to all three settings tabs (Admin Settings, Application Settings, Network Settings) without needing to be physically at the device.

Tip: Bookmark the device's IP address in your browser for quick access. If the device is set to DHCP, the IP may change after a restart — in that case, check the Network Settings tab or your router's device list again. For a permanent address, consider assigning a static IP via your router's DHCP reservation feature.

4. Visitor Journal

The Metrici Visitor Journal is the web application where all visitor, carrier, and deliverer records are managed. This section explains how to configure the Visitor Journal to work with the Document Scanner.

First, the camera must be configured in the LPR engine and fully operational before proceeding. You can find the documentation here: License Plate Recognition.

After the camera is set up, you need to add it to the Metrici Web Application. You can learn how to add a camera by following the Locations & Cameras documentation. The camera type must be set to ID card reader — this is essential, otherwise the Document Scanner integration will not work.

Important! The camera type must be set to ID card reader in the Metrici Web Application. Selecting a different camera type will prevent the Document Scanner from communicating with the Visitor Journal.

Once a document is scanned, the person is automatically added to the database with all the information extracted from their ID card or passport — including name, Personal Identification Number (CNP), birth date, nationality, and sex — see Fig.4.1 People.

People page in Visitor Journal showing a list of registered visitors with surname, forename, CNP, birth date, nationality, sex, and ID card count
Fig.4.1 People — All registered visitors and their scanned ID cards

From the People page, administrators can edit or delete visitor records and view how many ID cards have been scanned for each person. Each entry is created automatically by the Document Scanner — no manual data entry is required.

You can also generate a report to see which persons entered your location within a specific time interval. Use the Events page to filter by date, camera, location, event type, destination, or CNP — see Fig.4.2 Events.

Events page in Visitor Journal showing a filtered list of check-in events with date, time, camera, name, CNP, ID card type, plate number, event type, destination, and document details
Fig.4.2 Events — Visitor check-in log with filtering and export options

Events can be exported as PDF, Excel, or CSV files using the export buttons at the top of the page. The detail panel on the right shows the scanned ID card image, personal details, and any attached travel documents (invoices, AWBs) for the selected event.

5. API Reference

The Document Scanner communicates with the Metrici platform through several REST API endpoints. All URLs are configurable in the Application Settings. Replace IP_ADDRESS with your Metrici server's actual IP address.

5.1 Visitor Journal — Request Access

PropertyDetails
Endpointhttp://IP_ADDRESS/api_v2/vj/event_receiver.php
MethodPOST
Content-Typeapplication/json (with base64-encoded images)
PurposeSubmit a complete visitor/carrier/deliverer registration to the Visitor Journal

5.2 Plate Number — LPR Integration

PropertyDetails
Endpointhttp://IP_ADDRESS/api_v2/lpr/get_last_plate.php?camera_id=2
MethodGET
PurposeRetrieve the last recognized license plate number from the connected LPR camera

5.3 Destinations — Facility Locations

PropertyDetails
Endpointhttp://IP_ADDRESS/api_v2/vj/get_destinations.php?location_id=1
MethodGET
PurposeFetch the list of available destinations within the facility for the dropdown selector

5.4 LLM API — Document Data Extraction

PropertyDetails
Endpointhttp://LLM_ADDRESS:PORT/v1/chat/completions
MethodPOST
PurposeSend a captured document image to the AI model for structured data extraction
ModelConfigurable (default: qwen3vl)

The device sends the captured document image to the LLM service, which uses computer vision to identify and extract structured fields (name, CNP, serial number, birth date, nationality, sex, document type). The model returns a JSON response with all extracted fields.

6. User Flow

6.1 Role Selection

After selecting a language, the user is presented with three role options — see Fig.5 Role Selection:

Role selection screen with three buttons: Visitor (blue), Carrier (orange), Deliverer (green), and a Cancel button
Fig.5 Role Selection — Visitor, Carrier, or Deliverer

Pressing Cancel returns to the language selection screen.

6.2 Plate Number Recognition

The system automatically reads the vehicle's license plate number using the integrated Metrici LPR engine. The recognized plate is displayed on screen for confirmation — see Fig.6 Plate Confirmation.

Plate number confirmation screen showing the recognized plate number B99KFZ with Cancel, Enter manually, and Confirm buttons
Fig.6 Plate Number Confirmation

Three options are available:

How it works: The device sends a request to the Metrici LPR API at http://IP_ADDRESS/api_v2/lpr/get_last_plate.php?camera_id=2 to retrieve the last recognized plate number from the connected LPR camera. The plate number is then displayed for user confirmation before proceeding.

6.3 ID Card / Passport Scanning

The user is prompted to place their ID card or passport on the document tray — see Fig.7 ID Scanning. The built-in camera captures an image of the document.

ID scanning screen showing the ID Card Area with camera preview, Cancel and Capture buttons
Fig.7 ID Card / Passport Scanning — Camera preview with capture button

The user presses Capture & Extract ID card or passport data to take the photo. The captured image is then sent to the LLM API for AI-powered data extraction.

6.4 Extracted Data Review

After the AI processes the document image, the extracted data is displayed for review — see Fig.8 Extracted Data. The following fields are extracted:

FieldDescription
CNP NumberPersonal Numeric Code (national identifier)
Document TypeIDENTITY CARD or PASSPORT
Serial NumberDocument serial number
Birth DateDate of birth
Last NameSurname
First NameGiven name(s)
NationalityNationality as printed on the document
SexM or F
Extracted data review screen showing fields with Cancel, Retry Capture, and Confirm buttons
Fig.8 Extracted Data — AI-powered document recognition results

Three actions are available:

Important! The accuracy of data extraction depends on document quality, lighting conditions, and proper placement on the tray. If the extracted data is incorrect, use Retry Capture to take a new photo. Make sure the document is flat, well-lit, and fully visible within the camera frame.

6.5 Document Scanning (AWB / Invoice)

For Carrier and Deliverer roles, an additional step is available to scan travel documents such as AWBs (Air Waybills), invoices, or delivery receipts. These documents are captured by the same built-in camera and attached to the visitor record — see Fig.8.1 Scan Documents.

Scanned documents appear in the Travel Documents panel alongside the ID Card / Passport data in the summary screen. Each document page is numbered and classified (e.g., "Invoice 2458842").

Extracted data review screen showing fields with Cancel, Retry Capture, and Confirm buttons
Fig.8.1 Scan Documents
Note: Document scanning is only available for the Carrier and Deliverer workflows. Visitors proceed directly from ID scanning to destination selection.

6.6 Summary & Review

Before requesting access, the user is shown a full summary of all captured data — see Fig.9 Summary Screen. This screen displays:

Summary screen showing plate number, ID Card data, and Travel Documents with Cancel and Confirm buttons
Fig.9 Summary — Plate number, ID data, and travel documents

Two actions are available:

6.7 Select Destination

The user selects their destination within the facility from a dropdown list — see Fig.10 Destination Selection. The list of available destinations is fetched from the Metrici Visitor Journal API.

Destination selection screen with a dropdown menu and Request Access button
Fig.10 Select Destination — Choose destination from dropdown

After selecting a destination, press Request Access to submit all data to the Metrici Visitor Journal.

How it works: When the user presses "Request Access", the device sends a POST request to the Visitor Journal API at http://IP_ADDRESS/api_v2/vj/event_receiver.php containing all collected data: plate number, personal details, document images, travel documents and selected destination. The Metrici web application processes the request and grants or denies access.

6.8 Access Granted

If the access request is approved, a green confirmation message is displayed — see Fig.11 Access Granted.

Access granted screen with auto-restarting countdown timer
Fig.11 Access Granted — Session complete, auto-restart countdown

The screen shows "Access is granted! Please enter the facility. Thank you!" along with a countdown timer. After the configured restart delay (default: 20 seconds), the device automatically returns to the language selection screen, ready for the next visitor.

7. Troubleshooting

Cannot access the configuration interface

Device does not power on

ID card or passport not recognized correctly

Destination list is empty or shows N/A

Device does not restart after session