New Imaging.dll introduced for working with images (load/save).
Added extended processing for IPI check – now decoded image verified for personal data presence (currently on some documents only).
Added check for document movement during the scan with rescan if needed.
Added possibility to identify almost identical document types by date of issue for correct security checks validation.
Added custom format for MRZ in Maldives passports.
Added KS code for Kosovo.
Added codes for ECOWAS.
Added extra check for barcode format in Syrian passports (both old and new data formats).
Added parser for Syrian ID card.
Added parser for Georgian documents with QR code (DL, Reg Cert).
Added new MRZ parser for China ID cards with 1 line MRZ.
Fixed issue with image capturing on AMD processors when connected to USB2 port on some PCs.
Fixed issue with capturing side light images for checking the holograms.
Fixed issues with parsing of DS certificate country codes for comparison if certificate is non-compliant.
Fixed issues with MRZ detection on some images.
Fixed issue with parsing of boarding passes (leap year for dates).
Fixed issue with parsing of barcodes with color JPEG images encoded inside the data.
Fixed issue with parsing Trinidad and Tobago passport barcode.
Fixed issue with wrong barcode coordinates provided in results.
Fixed graphic fields retrieving based on template for basic SDK version.
Fixed issue with generation of results in XML for some result types.
Fixed issue with incorrect generation of ntfLDS_ICAO_Certificate_Ext_DocTypeList_DocTypes notification.
Document Reader Application:
Added support for PNG, JP2, TIF image format files (Load from folder, Drag & Drop).
Added “Show next page request” option in View tab of Options dialog.
Added “RFID profiler type” option in RFID tab of Options dialog.
Added possibility to process prior saved RFID sessions without connected RFID reader.
Updated “Do reader log” option behavior: now it does all necessary steps for enabling/disabling debug logs and even starts dbgview.exe application for viewing logs if enabled.
Updated display for Barcode format check result.
Fixed message with number of images saved to folder, when using “Save to folder” command.
RFIDProfilerType property added for setting/getting the certificates profiler type (int, read/write).
ShowNextPageRequest property added for enabling/disabling mode when request for scanning next document page shown in case document has more than one page in templates (bool, read/write).
Added support for PNG, JP2, TIF image format files in AppendImage method.
OpenSSL libraries added to the package.
ICAO PKD master list version 64 included.
BSI master list version from 26.02.2016 included.
223 countries and territories / 4767 documents included.
180 new documents added.
Description extended for 31 document.
Version 4.9.6 - December 22, 2015
Added full support for 72x3 series devices.
Added full support for 7017 serie devices.
New driver version 10.5.2.7 with support of latest devices.
Thanks to the support of image acquisition in JPEG, new devices from series 72x3 &7017 can be used with USB over Ethernet connection even on poor connection channels.
New security feature check - face photo comparison and verification (Visual vs RFID).
Added possibility to change mode of lexical analysis process for more consistent results with regards of visual OCR propability (eLexAnalysisDepth enum).
New commands RPRM_Command_Options_Set_WaitForReadingComplete, RPRM_Command_ReadingComplete for 72x3 devices card ejection on process finish.
New commands RPRM_Command_Options_Set_QuickMrzProcessing, RPRM_Command_Options_Get_QuickMrzProcessing for set/get preliminary quick MRZ
recognition on low-resolution frame for faster RFID reading.
New commands RPRM_Command_Device_SetRequiredOcrFields, RPRM_Command_Device_GetRequiredOcrFields for setting/getting the list of only required fields for performing OCR (optimizing processing time by not reading unnecessary fields).
New commands RPRM_Command_Options_Set_LexAnalysisDepth, RPRM_Command_Options_Get_LexAnalysisDepth to set/get parameters set from
New commands RPRM_Command_Options_Get_LexDateFormat, RPRM_Command_Options_Set_LexDateFormat to set/get date format used for making RPRM_ResultType_OCRLexicalAnalyze result. By default, system date format used.
New commands RPRM_Command_Device_Get_GetJpegImages, RPRM_Command_Device_Set_GetJpegImages to set/get JPEG image acquisition mode for
72х3 & 7017 series devices.
New structure TDwordArray for use with RPRM_Command_Device_SetRequiredOcrFields command.
New structure TResultContainerPointersList.
New result type RPRM_ResultType_FieldFileImage for getting graphical field image as a file buffer from CheckResultFromList method.
New notification RPRM_Notification_DownloadingCalibrationInfo for notifying when SDK downloads calibration info from the camera.
Added XML generation for results according to BSI TR-03135 v2.
Module for compensation of image distorsion updated to decrease memory amount used for processing.
Module for detection and cropping the document from image updated for correct detection in conditions with complex backrounds, optical distorsion.
Extended Info section in all XML results, containing:
computer name (ComputerName),
Image availability notification now sent immediately on readiness, instead of at the end of processing.
Added new algorithms for IR visibility cheсk improving results quality on documents with some dirt.
Added ghost photo IR visibility check for photos printed under other data.
Added verification of barcode presence to the barcode format check.
Added cropping possibility of ID cards from image on 87x3 devices.
Added output of OCR fields even in case of no result, for correct verification (security text).
Added possibility to process document images without DPI.
Added number of custom MRZ parsers for non-standard filled documents and visas from Chile, China, Mongolia, and other countries.
Added MRZ parser to barcode data converter for some barcodes, containing MRZ.
Added sorting to pages list in multipage scan - photo page comes first.
Added conversion from Cyrillic to Latin for data fields from certain document types (Russian Federation) according to ICAO 9303 when making RPRM_ResultType_OCRLexicalAnalyze result.
Added ARH Combo Smart device support.
Fixed issue with applying compensation for white image when SmartUV mode enabled.
Fixed issue with correct handling of DG_IMAGE | DAT_IMAGEINFO | MSG_GET request in RegulaReaderDS TWAIN driver.
Fixed issue with 0x050C version of lights board in 70x4 devices causing black images in certain conditions.
Fixed issue with video detection sensitivity on 70x4M, 73x8 and 70x9 devices.
Fixed multi-thread results saving issue (now covered with critical sections) for images and XML results in CheckResult method calls.
Fixed AV in CheckResultFromList method if wrong container address provided on input.
Fixed issue when requesting RPRM_ResultType_FileImage result from CheckResult method with non-zero index.
Fixed issue with lexical analisys and comparison of text fields from RFID DG11/DG12 in different languages.
Fixed OCR issue with spaces after each letter in some documents with specific font.
Fixed issue with wrong OCR of the dates in China documents because of extra hieroglyphs presence.
Fixed issue with incorrect label serial number in XML results.
Fixed year 99 issue in MRZ in expiry dates – now correctly interpreted as 2099.
Fixed XX0000 issue in MRZ in date of birth in some documents.
Fixed issue with processing of external 32-bit color images.
Fixed issue with Security text on UV images not performed because of no UV image available at the point (4.9.1).
Fixed issue with IR visibility check not performed if any of the elements is out of image scene.
Fixed issue with saving images in TIFF format.
Fixed some issues in fibers security check algorithms to improve detection and verification quality.
Fixed some issues in image patterns security check algorithms.
Fixed issue with empty result container if list of fields is empty in RPRM_ResultType_OCRLexicalAnalyze result type.
Fixed issue with memory leak when making results in XML format.
Fixed issue with loading updated modules from Updates folder in user profile, if user profile name not in Latin characters.
Fixed issue when it was not possible to connect 70x4 deivce with document inside. 70x4 devices with control board firmware version 0x250D are able to connect with or without document inside.
Fixed issue with incorrect document type identification on Windows 8+ because of settings file not loaded correctly.
Fixed issue with saving graphic fields to files via CheckResultFromList without resolution set.
Fixed issue with mixing up etalon and result for OCR security text check.
Fixed a number of memory leaks and handle leaks.
IMPORTANT! New firmware versions for RFID reader included 10.22. If you have 10.x installed, then we recommend update to 10.22. Update is required for correct handling of some new type A chips on physical level.
Support for certificate master lists handling extended.
New notification RFID_Notification_PA_CertificateChainItem.
Added new amendment "AllowCOMSODInDGPM" - allow EF.SOD and EF.COM tags presence in DGPM (for China electronic documents).
Added DSCertificate and SignerIdentifier nodes in PA_Resources scenario request XML for compliance with BSI TR-03129-2, 3.4.1 GetDocumentSignerInformation().
Fixed behavior on other smartcard devices connect/disconnect.
Fixed device disconnect notification, now only for active device.
Fixed memory leak on getting image results under certain circumstances.
Fixed issue with making XML for RFID_ResultType_RFID_BinaryData result when DS certificate is not present in SOD.
Fixed issue with (case insensitive) comparison of issuer/subject text attributes when building digital signature check certificate chain (now, gb=GB).
All available application types now enabled by default in scenario, and if not needed - should be disabled explicitly.
Document Reader Application:
Added support for 72x3 devices for ejecting the card on reading complete.
Added possibility to get OVD image for devices supporting it.
By using “Report sample issue”, item report with current sample will be sent to our customer support system and ticket will be created, with confirmation email sent to address provided.
Added "Use embedded PKD" option in RFID tab of Options dialog.
Added "Use only external CSCA for ML" option in RFID tab of Options dialog.
Added "Full screen" option in View tab of Options dialog.
Added “Quick MRZ processing” option in Device tab of Options dialog.
Added “Quick boarding pass processing” option in Device tab of Options dialog.
Added touch screen interface option (TouchInterface=1 in RegulaReader.ini [Settings]).
Added JPEG image acquisition mode option for 72x3 & 7017 series devices (UseJPEGMode=1 in RegulaReader.ini [Settings]).
Added Chinese translation.
Fixed issue with attempt to read RFID by CAN even if PACE not enabled in settings.
Fixed display of incorrect areas for UV dull paper result.
Fixed issue with checking updates during database update download and installation.
Fixed issue of infinite database update confirmations even after update until application restart.
Changed naming of the folders for saving results - now starts from issuing country code instead of document class code.
Changed default PKD path for RFID to %LOCALAPPDATA%\Regula\PKD folder.
Added possibility to use ICAO PKD masterlists and CRLs embedded in templates database. They extracted to RFID Passive PKD folder if user has write access to this folder and “Use embedded PKD” option selected.
Fixed parsing of RFID session files when reprocessing data from folder.
Fixed parsing of RFID session files when session was too short.
Fixed behaviour with RFID reader list change – connecting/disconnecting other smart card devices does not affect current used device.
Fixed overall RFID result calculation issue, when RFID reading was finished before BAC/PACE and lead to true result.
Fixed overall RFID results calculation issue when no certificate notification checked for PA.
Fixed issue with RFID notifications synchronization that may lead to inability to read RFID after some number of scans.
Fixed issue with Asyncronous results saving, that may lead to unexpected crashes when enabled.
Fixed issue with saving results for incorrect scans when no results saved if optical part was ok and RFID - not.
Fixed issue with not displaying Transmitted IR light in available lights even when available in device.
Changed caption display for IR visibility check result.
Fixed issue with saving XML for empty RPRM_ResultType_OCRLexicalAnalyze result.
CustomUpdateServerHost property added for setting/getting custom FTP host name, used for checking and downloading template database updates (variant, read/write).
CustomUpdateServerUsername property added for setting/getting custom FTP host user name credential, used for checking and downloading template database updates (variant, read/write).
CustomUpdateServerPassword property added for setting/getting custom FTP host password credential, used for checking and downloading template database updates (variant, read/write).
FeedbackUserEmail property added for setting/getting user email address for sending requests to our support system (variant, read/write). For sending support requests, this property should have valid value.
FeedbackUserName property added for setting/getting user name (for proper naming) for sending requests to our support system (variant, read/write).
LexAnalisysDepth property added for setting/getting lexical analysis mode combination used for processing (int, read/write).
QuickMRZProcessing property added for enabling/disabling mode when MRZ reading performed before main scan and results are available immediately. If used in combination with UseVideoDetection property, MRZ recognition is done on every frame when motion is detected and if MRZ is present in area, you will get results even without main scan process (bool, read/write).
OCRFieldsFilter property added for setting/getting a list of text field types to make OCR processing for (variant, nullable, read/write).
RFIDUseEmbeddedPKD property added for enabling/disabling use of ICAO PKD certificate masterlists and CRLs, stored in templates database, for PA (bool, read/write).
RFIDUseOnlyExternalCSCAForML property added for enabling/disabling restriction to use only external CSCA certificate for masterlist signature validation (bool, read/write).
RFIDIsExpectedChipFound property added for querying whether expected chip found in last processed document (bool, nullable, read only).
SDKPackageVersion property added for getting installed SDK package version (variant, nullable, read only).
CheckUpdates method added for instant check of SDK and templates database availability on FTP.
PlaySound method added for playing the sound using internal beeper or PC speaker (if no beeper available in device).
GetReaderGraphicsFileImageByFieldType method added for getting optical graphic field image as file buffer in selected graphical format.
GetRFIDGraphicsFileImageByFieldType method added for getting RFID graphic field image as file buffer in selected graphical format.
OnImageReady event added for notifying that image result is available, including its light type and page index data.
OnProcessingStarted event added for notifying that new scan or processing process initiated.
Event OnNotificationOptical for RPRM_Notification_Error + RPRM_Error_RemoveDocument notification now implicitly called.
Fixed GetRFIDDGRawData behavior for dftSession type data - now it is possible to obtain it.
Fixed issue with event for RPRM_Notification_DeviceDisconnected notification.
Fixed issue with OnProcessingFinished event called twice if RFID part was read faster than optical part.
Fixed issue with CurrentDocumentType property returns garbage before first attempt to set its value.
ReportCurrentSampleIssue method send current sample to our support system with user name and email set in the FeedbackUserName and FeedbackUserEmail properties and the support ticket created. After ticket creation, confirmation email sent to supplied email.
New enums added and existing updated.
XSD schemas for all result types in XML included in installation package.
Added identification information for all IDs with MRZ to be recognized from any side.
Added IPI description for numerous documents that was missing.
ICAO PKD and BSI masterlists now included in database. Updated together with new database monthly releases.
Export fixed, useless files are not included anymore.
220 countries and territories / 4592 documents included.
703 new documents added.
Description extended for 146 documents.
Version 4.9.1 — March 5, 2015
Internal image processing optimized and parallelized to achieve better performance and significant processing time reduction.
Implemented new MRZ detection algorithm that allows reading MRZ at earlier stages to optimize RFID reading speed by providing key earlier. MRZ sent as usual in ResultReceiving callback function, but really earlier, almost immediately after scan start. This is useful for MRZ based background checks. If MRZ test quality option enabled, then MRZ sent via callback a number of times.
PDF417 module refactored and optimized (detect and read codes under any angle, speed optimized).
CAN reading implemented at MRZ reading stage. It is now possible to read CAN without identification of document type. Reading happens earlier than before. This allow speeding up RFID chip reading from photo side of the electronic ID card.
Document detection algorithm optimized for using both video and sensor detection in parallel. If sensor covered with document, ready event fired immediately, while with video detection there is a timeout for document to be staying still until document considered present and event fired. When document is present by sensor, then video detection thread suspended until sensor freed. This fixed interference of video detection stream with RFID reading.
Video detection frame size now set to minimum device frame resolution (like 1MP for 3MP devices).
New QuickBoardingPassProcessing mode allows detection and reading boarding pass barcodes (PDF417, Aztech, QR code, 1D) in very fast manner. In this mode, white light turned on automatically when any movement detected in scanning area. Barcode detected and read instantly on every captured frame. You must enable Video detection mode also. MRZ scanned in this mode in fast manner as well.
Algorithm of document bounds location on the image significantly improved. Now works with open cover, hands inside the device (ID cards), TWAIN scanned A4 images etc.
Document cropping and rotating from image optimized by speed.
SmartUV feature extended. WHITE and IR images compensated the same way as UV. Beware that enabling this feature leads to extra capturing time.
Hebrew OCR implemented.
OCR symbol database improved with support of lot new fonts.
Added support for fixed characters in text field masks. These symbols recognized as usual, but on the lexical analyze stage compared with mask for validity (document numbers for specific document types).
Added vCard format support in barcode data parser.
Added new barcode data format parsers for different countries/documents (CAN Ontario Health Card, CAN British Columbia documents, US Armed Forces IDs, MEXICO\MATRICULA CONSULAR ID CARD, MOLDOVA, REPUBLIC OF\ID CARD, COLUMBIA DL, Bangladesh DL, Guatemala ID, Honduras passport, Peru ID, El Salvador ID).
Added E-SEEK M500 device support.
Improved support of 7303 devices.
Added possibility to get printed label serial number of the device.
Added possibility to omit lighting unevenness compensation and distorsion compensation steps when processing the images by adding corresponding operation modes. This is useful for slow Atom based PCs, when only MRZ & RFID are required.
Extended support for TWAIN scanners.
Document templates database size optimized by removing unnecessary information for document type identification.
Capability of processing images, captured not by Regula devices/software now disabled by default in all devices. It is now available as extra feature only by request.
Device based SDK operation period limitation implemented for all types of devices.
Logging to debug output console implemented across all modules. This allows throughout immediate output without reducing performance on file operations. Also for user convenience, we included DebugView.exe in SDK package.
Boarding pass barcode parsing extended with airport and airline names.
Barcode format check enabled for all AAMVA barcodes versions.
Fibers check module optimized by processing time.
IR visibility check module refactored and check algorithm optimized.
OCR security text check refactored and moved to lexical analyze module. Now possible to compare dates in different formats from different sources.
Added Info section to all XML results, containing:
device hardware ID in HEX (DeviceNumber),
device label serial number (DeviceLabelSerialNumber).
Fixed unknown day (XX) handling in lexical analyze as “1” for date of birth and as last day of the month for other dates.
Fixed correct handling of ft_Date_Of_Issue field in lexical analyze.
Fixed correct handling of ft_First_Issue_Date field in lexical analyze.
Fixed correct handling of ft_DL_Under_21_Date field in lexical analyze.
Fixed document number checkdigit calculation on Portugeese ID card MRZ.
Fixed issue with no parsed data for boarding passes in Aztech, QR code.
Fixed issue in vocabularies module that caused it to work incorrectly on non-zero LCIDs.
Fixed issue in calibration module (Forensic Studio compatibility).
Fixed a number of memory leaks and handle leaks.
New field types added:
IMPORTANT! New firmware versions for RFID reader included 10.19. If you have 10.x installed, then we recommend update to 10.19. Update is required for correct handling of some new chips on physical level.
New command RFID_Command_Set_Processing_Amendment for applying exceptions to standard processing algorithm.
New amendment implemented “BlockMasterFileSelection” for new Ukrainian ePassport 2015.
New command RFID_Command_Set_ParsedCustomDataType for choosing application type when parsing saved data groups data.
New command RFID_Command_Session_LoadData_Reparse for parsing saved session data according to current SDK data parsing capabilities, not the way parsing was done when saved.
Implemented saving of binary data of DG-certificates from SecurityObject in XML results for RFID_ResultType_RFID_BinaryData result type.
Fixed issue with CVCA-link certificate not sent to the chip for verification when provided and TA termination.
Fixed issue with incorrect processing and parsing some eDL data.
Additional elements in ASN.1 structures allowed when parsing SignedData.
New field type added ft_VRC_DataObject_Entry for eDL DG1.
Document Reader Application
Automatic templates database update possibility implemented. Effective when “Check for updates” option enabled. If new database version available on FTP, you would be notified.
“Check for updates” menu item added to “Help” menu for immediate check of updates availability. Application will notify you with message box if SDK or templates database updated version available.
“Contact support” menu item added to “Help” menu. After clicking this item, application will open our support center web page support.regulaforensics.com in browser.
“Run Regula QuickSupport” menu item added to “Help” menu for convenient launch of our remote customer support module by TeamViewer.
“Report sample issue” menu item added to “Help” menu and main toolbar for convenient sharing of scanned document images, which have processing issues, not recognized, etc. Application will send report to our FTP after confirmation disclaimer.
“Details” and “Results” panels are now always visible (when enabled, not hidden on new scan start) for better performance.
“Results” panel slightly redesigned for properly supporting devices with and without RFID option.
On “Text data comparison” results page now possible to focus any field in the grid and field areas from all sources (for example from MRZ and Visual zone) highlighted for this field.
“Allow silent DB update” option implemented. This allows automatic templates database update download and installation on availability. Option is located on the “Options\General” page.
“Quick boarding pass processing” option implemeted. Option is located on the “Options\Device” page before device connection.
“Asynchronous results saving” mode implemented. In this mode, all result saving operations done in background in a separate thread after scanning is finished. Option is located on the “Options\Results” page.
“Restore last form position” option added. This allows having main application window always in the same custom size and position instead of having it always maximized. Option is located on the “Options\View” page.
“RFID eDL data groups” option added with list of available eDL data groups. This allows having different settings for retrieval of data groups from eDL application, than from ePassport application.
Status indicator colors updated from yellow to gray.
Drag&Drop functionality implemented for folders with images and separate images. You may drop folder or separate image on the main form and it will be loaded and immediately processed. Folder name added to the MRU list. Images in folders should be preferrable properly named (WHITE, IR, UV etc.). Any name is suitable for image as well:
if it is color, would be considered as WHITE,
if it is grayscale, would be considered as IR,
"Visible", "Infrared", "Ultraviolet" keywords in file names are also respected.
“Glare compensation” and “SmartUV” options setting and resetting behavior fixed.
RFID second read try implemented to happen immediately with lowered speed (106kbps) if first try ended up with communication error.
Now complete RFID session data saved also for further reloading and reprocessing if SaveImages option enabled. This allows getting same consistent processing result as when processing the chip in real.
RFID notifications processed in their native thread context, not the main thread.
MRZ from visas not transferred to RFID module as access key anymore.
MRZ from barcodes now transferred to RFID module as access key (eDL back side).
BSI TR-03135 xml results not saved now by default. To enable saving this result type you should enable "Results in XML" option and put “BSI_TR_03135_Results=1” line to [Settings] section of RegulaReader.ini file.
Fixed issue with incorrect handling of WM_POWERBROADCAST message.
Fixed issue with available results not saved if processing error occur.
BringToFront is not called anymore on device connect.
Application now has digital signature.
Now if COM server started by automation CreateObject call, UI interface is not visible by default.
OnResultReadyXML event added. Fired when result received from SDK and it has XML presentation as well. Result type and XML result string provided as params.
CanProcessImages property added for getting availability of external images processing capability (bool, read only).
DeviceLabelSerialNumber property added for getting device serial number that is printed on the device body label (variant, read only).
DatabaseVersion property added for getting version of currently connected templates database (variant, read only).
DatabaseID property added for getting type ID of currently connected templates database (integer, read only).
DoNoColorCompensation property added for enabling/disabling lighting unevenness compensation stage of image retrieving process (bool, read/write).
DoNoDistortionCompensation property added for enabling/disabling distortion compensation stage of image retrieving process (bool, read/write).
DoSilentDBUpdate property added for enabling/disabling silent installation of template database update after successful automatic download (bool, read/write). Works in combination with DoCheckUpdates property.
RFIDEDLDatagroups property added for getting/setting a set of datagroups to read from eDL application in elecronical driver licenses RFID chip (integer, read/write).
AppendImageFromFile method added providing capability to add images for processing from file stored on disk by its full filename, light index, and page index.
ReportCurrentSampleIssue method added for providing capability of immediate sharing of current document scanned images with support service. This is useful for automating reporting process.
Multiple clients handling implemented. Now all registered clients would receive events, not only the last one as in prior versions.
COM object now implements IObjectSafety interface for enabling running it in Internet Explorer as ActiveX marked "safe for scripting".
Events fired in COM server main thread, so you can handle them on the client side that expect them only in main thread (Delphi).
Enumerations updated, new constants added.
IMPORTANT: new documents database version should be accompanied by new RecPass.dll module in order to be backward compatible with older SDK versions.
Visual zone OCR fields described completely for all visas.
213 countries and territories / 3902 documents included.