SDK memory usage significantly optimized and reduced.
SDK loading time significantly optimized and reduced.
New camera driver version 10.3.1.4 with new device types and Windows 8 support.
New 7308 device type support added.
Document type recognition module improved by implementing additional filter allowing fast recognition of non-MRZ documents.
Calibration module refactored to reduce memory usage.
PDF417 barcode reading module reimplemented with lots of improvements by detection, speed, and quality of reading.
New 2D barcode parsers added for Rwanda, UAE, Argentina, Philippines.
OCR module improved and optimized by speed.
Added possibility to OCR characters from different LCID in one text field.
OCR of national characters (with subscripts and surerscripts) improved by adding missing character masks.
Correct OCR of ‘ and “ symbols.
Removed constraint on maximum 256 bytes length result for OCR fields.
Added possibility to set path to custom AppData folder for Regula in registry –
x64: AppData key in HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Regula\,
x86: AppData key in HKEY_LOCAL_MACHINE\SOFTWARE\Regula
If set, standard path from C:\Users\\AppData\Local\Regula remapped to specified one.
Possibility to detect ID1 MRZ (3x30) on ID2 format documents added.
Transmitted IR light scheme support added.
Date of expiry check added for Russian Federation domestic passports based on date of issue and date of birth.
Added ft_Issuing_State_Code field generation for identified documents without MRZ/RFID.
Added ft_Nationality field generation for Russian Federation domestic passports.
Connection of multiple Regula devices in separate processes now allowed.
Improvements to IR visibility check implemented.
New field types added:
eDL application support added (ISO/IEC 18013).
PACE Integrated Mapping (IM) and Chip Authentication Mapping (CAM) support added.
Fixed correct handling of CSCA certificates in ICAO .ldif format [https://pkddownloadsg.icao.int/ICAO/pkdLDIFDownload.jsp]
Support of CSCA MasterList in .ml format [https://www.bsi.bund.de/SharedDocs/Downloads/EN/BSI/CSCA/GermanMasterList.html]
Battery status not checked anymore in COM background mode.
Calibration request dialog not shown anymore in COM background mode.
RFID firmware update request not shown anymore in COM background mode.
RFID antenna parameters initialization fixed both in application and configuration file (FW 5.x).
Possibility to connect device defined by its ID and serial number added (for multiple devices connected to one PC) using configuration file parameter “SelectedDeviceName”.
Old style MRZ results saving format for MRZ.txt file can be set via configuration file parameter “OldStyleMRZResult”.
Fixed issue with wrong page displayed after processing from selected in “Default details page” parameter.
LoadDatabase property added for enabling/disabling loading of templates database (bool, read/write).
QuickBoardingPassProcessing property added for enabling/disabling mode when barcode reading performed first and if there is boarding pass barcode, and then all further processing cancelled (bool, read/write).
CancelOpticalOperation method added for cancelling any optical SDK operation immediately.
Template database is now available in next versions:
All world documents (not including DL & ID for USA & CAN)
Full version, with all documents included.
All world documents (not including DL & ID for USA & CAN) is included in SDK by default.
To get other DB versions please send a separate request.
Included documents data are from full database version.
212 countries and territories / 3411 documents included
1051 new documents added
Description extended for 234 documents.
Version 4.8.5 — Macrh 19, 2014
OCR improved and optimized by speed.
New camera driver version 10.3.1.1 with new device types and Windows 8 support.
New 7xx8, 7xx4M device series support.
Changed power management approach, now power profiles are not changed.
Memory consumption reduced significantly by reducing size of calibration data and optimizing memory used by processing results.
Countries list and their names updated according to ISO 3166-1 2013.
New country codes added according to Supplement to ICAO Doc 9303 Revision 13.
MRZ reading module updated according to Supplement to ICAO Doc 9303 Revision 13.
1 line MRZ OCR implemented according to ISO/IEC 18013.
3 lines by 38 characters MRZ implemented for Polish registration certificates.
Belgium ID card MRZ case added as custom parsing and validating rule.
In _ExecuteCommandFunc “params” parameter type changed from long to void.
New calculated field ft_Issuing_State_Name added to RPRM_ResultType_OCRLexicalAnalyze result. It is based on ft_Issuing_State_Code and contains English name of the issuing country.
Barcode detection optimized by speed.
Most passports included in the database that have PDF417 barcode now can be parsed and format checks added for them.
Optional mode for quick boarding pass only scanning and processing added.
Boarding pass 2D barcode parsing extended.
Datamatrix 2D code reading supported now.
Support for the latest AAMVA DL & ID cards format standard from 2013.
Fixed issue with no images available after scan on some processing error.
Optimized loading of vocabularies for OCR.
If no IR image is available but it specified in OCR template, OCR made based on available white image.
Turkmen LCID added to OCR.
Updated check for invalid document numbers containing only zeros (like AA000000).
Added fix and template description changed for Panama passports based on known forges.
Fixed issue with SDK not loading when protection dongle is expired. Now is dongle is expired
for this version of database, only database would not be loaded.
Fixed XML generation according to BSI TR-03135.
Fixed issue with document video detection when starting with document inside.
Fixed issue with exception on getting results when RPRM_Command_Options_Set_CheckResultHeight called with non-zero value.
Fixed issue with synchronous call for selecting the specimen in the reference documents database after scan that lead to excessive timeout with new version of reference database.
IMPORTANT! New driver version 22.214.171.124 with Windows 8 support.
IMPORTANT! New firmware versions for RFID reader included 10.17. If you have 10.x installed, then you need to update it to 10.17. Update is required for correct usage of long TA certificates.
New command added RFID_Command_UseDeviceDriverLog.
New commands added RFID_Command_Get_OnlineTAToSignDataType and RFID_Command_Set_OnlineTAToSignDataType.
Fixed issue with no raw data for MIFARE chip available under scenario work mode.
Fixed issue with no request sent for TA_Signature in scenario mode, when no private key available.
Document Reader Application
Added new option on the General tab of the Options dialog – “Do RFID driver log” for logging driver level communication data to RFID reading log file.
Added possibility to open and process images from folder which path specified in the clipboard by pressing “F12”.
Added possibility to immediately process images from folder when selected from the history of all opened folders by pressing “Enter”.
Added possibility to save screenshot of the application window by pressing “Alt-S”. Screenshots saved in the scanning result folder, with time code as a name in BMP format.
Added new option into [Settings] section of the RegulaReader.ini configuration file “QuickBoardingPassProcessing”. To enable quick boarding pass processing mode set it to 1 (0 by default).
Added possibility to enlarge photos taken from document (and RFID) by double-clicking on it.
Cleaning of previous scan results in RecentResultsFolder optimized.
Results panel look redesigned for “show only summary” mode for correct display on small resolution displays.
DoShowWarningsAsErrors property added for enabling/disabling mode, when warnings on the security checks treated as errors (bool, read/write)
ClearListOnStartAndConnect property added for getting/setting mode, when scanned document list cleared on application start and device connect (bool, read/write).
RFIDVersion property added for getting current RFID SDK version (variant, read only).
RFIDDriverVersion property added for getting connected RFID reader device driver version (variant, read only).
RFIDFirmwareVersion property added for getting connected RFID reader device firmware version (variant, read only).
BatteryCount property added for getting existing battery count in the connected device (int, read only).
BatteryStatusByIdx method added for getting specified battery (int) status (charge in %) (int).
DoRFIDDriverLog property added for controlling adding of extended driver level communication information between RFID reader driver and device into the general RFID reading log (bool, read/write).
SaveConfig method added for immediate saving current configuration to file.
RFIDOnlineTAToSignDataType property added for getting/setting data type returned to sign in TA_Signature request (Challenge or its Hash) (int, read/write).
Enumerations updated, new constants added.
Documentation on COM server interface included.
Template size for image pattern checks optimized.
209 countries and territories / 2361 documents included
471 new documents added
Description extended for 205 documents
Version 4.8.3 — December 06, 2013
IMPORTANT! New driver version 126.96.36.199
IMPORTANT! New firmware versions for RFID reader included 5.25 & 10.15 (for different hardware versions). If you have version 5.x installed in the device, then you need to update it to 5.25. If you have 10.x installed, then you need to update it to 10.15. Update is required for correct operation with new driver
Driver updated and compiled with newest Windows Driver Framework to support Windows 8 certification.
Fixed issue in both firmware and driver with long timeout when accessing specific chips after some period they are already visible to system (card busy with system read requests if Certificate Propagation service enabled in Windows 7 & 8).
Optimization of USB communication performed between driver and firmware.
Fixed issue that may lead device to hang if chip removed at certain moment during CA.
Added automatic update capability for RFID reader firmware to the latest recommended version (if needed) during setup process after confirmation. If installation running in silent mode, then update would be performed without request.
Driver packages now contain RFID reader firmware files and update utilities.
UPDATEFIRMWARE installation parameter when set to UPDATEFIRMWARE=0 will skip the firmware check and update process.
Version 4.8.2 — August 19, 2013
OCR improved and optimized by speed.
Text fields ft_Surname, ft_Given_Names и ft_Surname_And_Given_Names converted to Latin characters according to ICAO 9303 regardless of MRZ presence. Conversion rules for special characters changed.
Country codes conversion table from 2 to 3 characters updated (DE -> D<<).
Dominican Republic passport 2D barcode format added.
New calculated field ft_RemainderTerm added – number of months until expiry date. Will be available in case of field ft_Date_of_Expiry presence.
New status diagnose added for UV pattern checks: chd_PhotoFalseLuminiscence – unexpected luminescence presence in the area around photo.
Default 72 DPI value set for the images that come for processing without DPI set.
Invalid for XML characters are removed from text fields data when exporting to XML.
MRZ recognition of 0 and O improved.
Main page determined by the face presence on the image in multipage processing mode and pages are rearranged accordingly.
Critical bug fixed that lead to exception when exporting to XML graphic field images or security checks element images.
New command (RPRM_Command_Options_Get_BatteryNumber) added to retrieve the number of available batteries in the mobile complex.
New firmware 10.09 with fixed issue with hanging occurred if chip removed from antenna field at the certain moment of reading.
ATTENTION! Unused exported function _RFID_FreeResult removed from the library RFID_SDK.dll.
RFID_Command_CancelReading command will cancel the reading immediately on the next APDU command.
Document Reader Application
Second reading mode on RFID communication error with reducing the speed and adjusting antenna parameters when manual detection mode enabled restored.
Added possibility to open folder with last scanning results (Alt+O). Added corresponding menu item and toolbar button. Folder will be open in new explorer window.
Added possibility to open images from folder by typing its name and history of all opened folders.
Fixed incorrect display of text and security elements on the document image when selected on the details panel.
DeviceAvailableLights property added for getting available lights combination (eRPRM_Lights) in the connected device (int, read-only).
DeviceAvailableVideoModes property added for getting available video modes combination (eRPRM_VideoModes) in the connected device (int, read-only).
DeviceFeatures property added for getting additional device features combination (eRPRM_DeviceAdditionalFeatures) for the connected device (int, read-only).
CheckReaderImagePageIndex method added, that returns page index (int) for the scanned image with index AIdx (int).
Enumerations updated, new constants added.
198 countries and territories / 1892 documents included
26 new documents added
Description extended for 18 documents
Version 4.8.1 — July 8, 2013
New, fully redesigned, version of OCR
New camera driver version 10.2.0.2 included
New SmartUV mode added, allowing automatic removal of external light reflections on the UV images. With this mode on it is possible to work with the reader lid open without intensive direct external light.
New security check added RPRM_Authenticity_BarcodeFormatCheck that shows matching/nonmatching of the present 2D barcode data format to the one saved in the template for that document type.
New security check added for checking the luminescent text in UV in RPRM_Authenticity_Image_Pattern (Belgium ePassport).
New geometric document format added dfID3_x2 (full 2 near pages of passport)
Added possibility to process image of two full pages of passport (e.g. from TWAIN flatbed scanners). Document image cropped from the whole image, divided in 2 separate pages of ID3 format and then processed.
Added possibility for rotation of the document images to the angle set in the template when corresponding mode is set. In this case, images will display document as human expects it.
Added rotation of the document images by the owner photo orientation before identification.
Added text fields data conversion according to ICAO 9303 from national characters to Latin as used in MRZ for proper comparison.
Now we trim “<” characters from the Issuing State Code and Nationality fields for proper comparison with Visual OCR.
Added filter of given names and surnames by stop list words (MUSTER, SPECIMEN, TEST etc.).
Added filter of the document numbers equal to zero (000000000 etc.).
Added possibility to compare ft_Sex fields from Visual OCR to MRZ when printed in national language.
Added special MRZ filling format for Panama passport.
Added new type of inspected UV fibers – without checking the color.
Changed behavior when processing document without IR image. In this case, gray image (RPRM_Light_White_Gray) created from WHITE and used instead of IR for OCR.
Document template description extended. Now it includes issue year, document type (ID, visa, passport, DL etc.), state.
XML data format for RPRM_ResultType_ChosenDocumentTypeCandidate result type extended. Now populated with new data from template.
New vocabularies (given names, surnames, addresses etc.) added and existing updated for OCR.
New text field types added: ft_Room_Number, ft_Religion.
Data storage format for document type identification has changed in templates DB. New format is not compatible with previous ones. New templates DB would work only with SDK 4.8.1 and above.
Added new notification type RPRM_Notification_Processing. It is sent at the beginning and at the end of captured images processing.
XML data format for RPRM_ResultType_ChosenDocumentTypeCandidate result type populated with child documents info.
Filenames for saving the results into files with CheckResult should be encoded in UTF8.
XML data format for RPRM_ResultType_OCRLexicalAnalyze result type extended with and elements for each field.
Memory usage optimized.
SDK loading time optimized.
Lots of small improvements and fixes.
New SDK version 3.1.
Certificates MasterList support.
Certificates usage, validation and processing algorithms extended.
Memory usage optimized when working with certificates.
New scenario reading mode added. Implemented in one function call with providing all reading settings in XML parameter.
New notification RFID_Notification_Scenario added. It is possible to pass all necessary user data (certificates, parameters etc.) during reading in XML format. See documentation for details.
Added/changed notification and error codes.
!!! XML data format for RFID_ResultType_RFID_RawData changed. Now element contains <![CDATA]> block encoded in Base64 for its binary value.
!!! XML data format for RFID_ResultType_RFID_TextData changed. Now element is not present anymore and element has attribute “Text” instead, that contains text name of field type constant.
!!! XML data format for RFID_ResultType_RFID_ImageData changed. Now element contains <![CDATA]> block encoded in Base64 for its binary value. element is not present anymore and element has attribute “Text” instead, that contains text name of field type constant
!!! XML data format for RFID_ResultType_RFID_BinaryData completely changed. Now it contains all RFID reading results in one XML. See documentation for details.
All XML data now encoded in UTF8.
Log file now contains full time code at the start of RFID chip reading and at the time when command for saving log file to disk received.
Document Reader Application
New RFID scenario reading mode implemented.
PACE\SAC documents reading support implemented.
New parameters for reading PACE\SAC documents added.
Passing ft_CardAccessNumber text field value as a password into RFID SDK.
New design for displaying processing results
New status added – PACE
New status added – overall optical processing result
New status added – overall RFID processing result
New status added – overall processing result (large), corresponding device LED indication.
New PA_SensitiveNotifications section added to RegulaReader.ini file. It contains a list of notification codes that will fail PA if any of them present during processing.
Added notification about chip absence in the document when expected to be present as described in document template. It has influence on the overall processing result.
New logic of “Show warnings as errors” option. If off, unknown document type will not fail the overall result.
“Show warnings as errors” option enabled by default.
RFID Baud rate saved value changed in RegulaReader.ini. Now exact value of the speed saved instead of combination prior.
“Detect any document format” option available when processing images.
Fixed saving of the images from barcodes in XML format.
RFID reading progress display changed. Progress now displayed for each data group read separately.
Fixed issue with processing French ePassport (2006) with wrong (0) length in DG2 BDB tag.
Fixed displaying of the element area when mouse is hovering over document image.
Double-click on graphic field enlarge image to original size
Calibration data verified on connect only when “Do reader log” option enabled
OnRFIDRequest event added and raised when there is a need to receive user data for chip processing (certificates, CRL etc.).
RFID_ResponseXML property added to provide user data on OnRFIDRequest event in specific XML format (variant, read\write).
RotateResultImages property added for setting the document images rotation mode to get result images oriented to have photo positioned correctly vertical (bool, read\write).
SmartUV property added for setting special UV image capture mode (bool, read\write).
RFIDAuthProcType property added for setting authentication procedure type for RFID reading (int, read\write).
RFIDBaseSMProcedure property added for setting Secure Messaging procedure type used when accesing the chip (int, read\write).
RFIDPassiveAuth property added for setting on or off Passive Authentication processing during RFID chip reading (bool, read\write).
RFIDSkipAA property added for setting on or off skipping Active Authentication after Chip authentication already done (bool, read\write).
RFIDMRZ property added for setting MRZ style RFID-chip access key for BAC\PACE (variant, read\write).
RFIDPassword property added for setting CAN\PIN style access key for PACE (variant, read\write).
CheckStatusRFIDBAC property added for checking BAC result (variant, read only).
CheckStatusRFIDPACE property added for checking PACE result (variant, read only).
CheckStatusRFIDRI property added for checking RI result (variant, read only).
RFIDPACEPasswordType property added for setting password type used for PACE (int, read\write).
RFIDTerminalType property added for setting terminal type for RFID-chip reading (int, read\write).
CheckStatusComplete property added for checking overall document processing result (variant, read only).
CheckStatusOptical property added for checking document optical processing result (variant, read only).
ClearResults method behavior changed. Now all previously scanned pages results cleared, not only current page (in multipage processing mode)
Fixed issue, that occur after COM client connect and disconnect to the COM server and after continue processing documents
196 countries and territories /1868 documents included