Skip to content

Document Reader SDK 4: Release Notes

Version 4.15.1 — August 16, 2019

SDK

  • IMPORTANT! Windows XP and Windows Server 2003 are no longer supported from this version and forward. You either must stay on previous version, either update OS to Windows 7 at least.
  • Added support for 70x4M-5A devices.
  • Added OCR capability of Chinese Simplified and Traditional. Corresponding document templates updated.
  • Greatly improved OCR for next code pages (alphabets):
    • Cyrillic (Belarusian, Bulgarian, Kazakh, Russian, Serbian, Ukrainian),
    • Baltic(Estonian,Latvian,Lithuanian),
    • Vietnamese,
    • Western European/Latin (English, French, Spanish, Portuguese, Dutch, Finnish, Icelandic, Italian, Norwegian, Swedish),
    • Georgian,
    • Turkish (Turkish, Azeri, Uzbek),
    • Hebrew. Corresponding document templates updated.
  • Greatly improved scanning time on 70x7, 70x8M devices.
  • Improved OCR of the documents with floating inconsistent personalization.
  • Added new functionality of validating the printed text color of the field vs the template to Security text authenticity check. Templates updated to reflect and enable this functionality for corresponding documents. This is a massive update for US and Canada documents and is helpful in cases where validation is available by visible image only.
  • Added new functionality of validating the parameters and content of the barcode vs the template to Barcode format authenticity check. Templates updated to reflect and enable this functionality for corresponding documents. This is a massive update for US and Canada documents and is helpful in cases where validation is available by visible image only.
  • Implemented integration for external Regula face matching web service. If our new dedicated service is installed locally on the PC or its address is specified in RPRM_Command_Set_ProcessParametersJson JSON “processParameters.extPortrait.url” tag, face matching will be performed using that service, which provides more reliable comparison results, compared to the embedded light version.
  • New licensing options introduced: time limited OCR/AAC access and time limited Basic SDK access. At the moment next cases supported, depending on the obtained license:
    • Limited updates for OCR/AAC. For this type of license, you can use SDK versions issued before expiration of your updates subscriptio for unlimited time with full OCR/AAC functionality. Versions issued after expiration date will be limited to Basic SDK functionality only.
    • Time limited OCR/AAC. For this type of license you can use SDK functionality with any SDK version before the subscription expiration date. After that date functionality will be limited to Basic SDK on all SDK/DB versions regardless of their release date. To continue using OCR/AAC functionality you need to renew the subscription.
    • Time limited Basic. For this type of license, you can use Basic SDK functionality with any SDK version before the subscription expiration date. After that date functionality will be limited to “scan only” on all SDK versions regardless of their release date. To continue using Basic SDK functionality you need to renew the subscription.
  • Implemented validation check between Issuing authority and document series in Russian Federation passports.
  • Added support of BSI TR-03135 v2.3 logging scheme.
  • Added support of E-SEEK M500 device with 2.4.0 firmware.
  • Added support of new parameter in RPRM_Command_Set_ProcessParametersJson JSON “processParameters.mrzPreProcess” for disabling MRZ detection before document detection on external images. This is useful for processing external images from flatbed scanners to improve the detection results.
  • Added new MRZ parsers:
    • Antigua and Barbuda Id Card,
    • Aruba DL,
    • Cuba ID card,
    • Ecuador ID card,
    • Uruguay ID card.
  • Added new barcode parsers:
    • Botswana Residence permit,
    • Cuba ID card,
    • Ghana DL,
    • Israel Entry/Exit permit,
    • Jamaica ID card,
    • Nicaragua Passport,
    • Mozambique Visa and Emergency certificate,
    • Togo ID card.
  • Added new eCheckDiagnose enum members:
    • chd_TextColorShouldBeBlue
    • chd_TextColorShouldBeGreen
    • chd_TextColorShouldBeRed
    • chd_TextShouldBeBlack
    • chd_BarcodeWasReadWithErrors
    • chd_BarcodeDataFormatError
    • chd_BarcodeSizeParamsError
  • Added new eRPRM_ResultType enum member RPRM_ResultType_LivePortrait.
  • Added new CDocFormat enum member dfFlexible.
  • Added new eGraphicFieldType enum member gf_Portrait_Of_Child.
  • Added new eVisualFieldType enum members:
    • ft_Date_First_Renewal
    • ft_Date_Second_Renewal
  • Added new eLexAnalysisDepth enum member eLAD_CompareRussiaAuthority.
  • eRPRM_Lights enumeration reordered, and unused items removed.
  • All DWORD types changed to uint32_t in the whole types, structures, and function definitions.
  • All long types changed to int32_t in the whole types, structures, and function definitions.
  • Improved recognition of non-ICAO format documents and laminated documents. Now we are not limited to standard ID sizes.
  • Fixed issue with Aztec codes detection.
  • Fixed issue with not finding anchors specified as IR in template when only visible image is available for processing.
  • Fixed issue with incorrect cropping of ID2 document from external image when MRZ test quality enabled.
  • Fixed issue with incorrect cropping Ecuador ID cards from external image.
  • Fixed issue with incorrect cropping ID3x2 documents (adjacent pages of the passport, including ones scanned with cover) from external images from flatbed scanners.
  • Fixed issue with video detection of laminated documents, like old French ID.
  • Fixed issue with video detection of semitransparent documents on devices without the lid or with open lid.
  • Fixed issue with video detection when reader stops detection at some point in specific circumstances.
  • Fixed issue with video detection of document with one of the corners outside of the scanning area.
  • Fixed issue with loading PNG images with transparency.
  • Fixed issue with 9999 year in Date of expiry in Spanish ID cards.
  • Fixed issue with documents without expiration term in Bulgaria, Bolivia, Viet Nam.
  • Fixed issue with special symbols in text fields when performing partial value comparison to other sources.
  • Fixed issue with LCID in date fields. Now all dates are returned with LCID 0 in RPRM_ResultType_OCRLexicalAnalyze result.
  • Fixed issue with converting mass and weight values for all related fields into local measuring system.
  • Fixed issue with weight conversion if field contains code instead of actual weight value.
  • Fixed issue with country code incorrect validation in specific cases.
  • Fixed different minor issues with specific documents MRZ reading and correction.
  • Fixed issue with hardware sensor enabled in video detection mode on some devices.
  • Fixed issue with cropping documents on external image recursively in some cases.
  • Fixed issue with the TWAIN interface module on Windows 10.
  • Documentation updated.

RFID SDK

  • IMPORTANT! New firmware version 21.14. It is recommended to update your 21.x firmware series devices to this new version. Fixed issue with USB enumeration on some PCs.
  • Added new structures TRF_FT_DATE_TIME, TQualityBlock, TIrisImage_v2, TIrisBDB_v2.
  • Added new enums eIrisImageType_v2, eIrisImageFormat_v2.
  • Added new eCBEFF_FormatTypes enum member ftypIris_Image_v2.
  • Added new eIrisImageProperties enum members:
    • iipmPreviousCompression_Undefined
    • iipmPreviousCompression_Lossless
    • iipmPreviousCompression_Lossy
    • iipmPreviousCompression_Mask
  • All DWORD types changed to uint32_t in the whole types, structures, and function definitions.
  • All long types changed to int32_t in the whole types, structures, and function definitions.
  • Fixed issue with saving logs that was introduced in 4.12.5.

Document Reader Application

  • Updated and corrected algorithms of calculating CA and PA statuses when specific notifications are present or files absent.
  • Workaround included in RegulaReader.ini for Netherlands ePassports issued staring 01.01.2014 until 01.01.2017 with 10 years validity where CA with PACE takes too much time.
  • Updated logic of loading images from folder. Now all images of one scan should be of the same size and resolution. Images with differences will be ignored and not loaded.
  • Added correct diagnose display for all security check results.
  • Added field validity display for all text fields from all sources in color.
  • Fixed issue with image preview window remains open on new scan start.
  • Fixed issue with BAC result empty if chip re-detected before results calculation.
  • Fixed issue with incorrect printed report generation.
  • Results are now displayed after all comparisons and verifications are performed.

COM

  • Added method CheckRFIDResultsJSON to get RFID reading results in JSON format. Works the same way as CheckRFIDResultsXML.
  • Fixed exception when calling GetTextFieldByTypeAndSource method.
  • Enums updated.
  • Documentation updated.

Installer

  • OpenCV version 3.4.3 included and required for running SDK starting from this version.
  • Regula Keys application renamed to Regula Licensing and it is always installed with SDK now.
  • Vocabularies.dll removed from package.

Database

  • Improved description of image patterns in many templates based on statistics.
  • Updated and fixed document links to IRS databases.
  • ICAO PKD master list version 121 included.
  • BSI master list version from 06.08.2019 included.
  • 244 countries and territories / 7572 documents included.
  • 550 new documents added.
  • Description extended for 1059 documents.

Version 4.12.5 — March 05, 2019

SDK

  • Great improvements of OCR for Latin, Cyrillic, Hebrew, Vietnamese, and Balkan alphabets, both speed and accuracy.
  • Added support of 70x4M devices with new camera modules.
  • Added functionality for cropping rectangular stamp images from the document page.
  • Added support for custom preprocessing scenario, that should be stored in preProcessScenario.json file.
  • Added new MRZ parsers:
    • Mozambique ID card,
    • Estonia Residence permit.
  • Added new barcode parsers:
    • Haiti ID card,
    • Canada ID card.
  • Added new eRPRM_Commands enum members:
    • RPRM_Command_Options_Get_TrustDPI,
    • RPRM_Command_Options_Set_TrustDPI.
  • Added new eGraphicFieldType enum member gf_Stamp.
  • Added new eVisualFieldType enum members:
    • ft_Mother_Surname
    • ft_Mother_GivenName
    • ft_Father_Surname
    • ft_Father_GivenName
    • ft_Mother_DateOfBirth
    • ft_Father_DateOfBirth
    • ft_Mother_PersonalNumber
    • ft_Father_PersonalNumber
    • ft_Mother_PlaceOfBirth
    • ft_Father_PlaceOfBirth
    • ft_Mother_CountryOfBirth
    • ft_Father_CountryOfBirth
  • Improved CPU utilization in document presence video detection mode. Now by default video detection is skipping frames from camera to reduce CPU consumption. If you need to disable this (for faster barcode reading, for example), you can set “highPerformanceVideodetection” to true in “processParameters” via RPRM_Command_Set_ProcessParametersJson call.
  • Improved depersonalization functionality. Now you can make a scan, get normal results, then set depersonalization settings and after get depersonalized results for this same scan.
  • Improved external images processing by adding extra step to try recognize it as ID3 x 2 if there were no recognition in default formats on images without DPI set.
  • Improved processing of external images with very small size. They will be internally enlarged to fit OCR minimal requirements.
  • When processing external images, its DPI will be cleared by default, unless TrustDPI option is set.
  • Fixed issue with providing images in RPRM_ResultType_Internal_BSI_XML and RPRM_ResultType_Internal_BSI_XML_v2 results. Now if RPRM_GetImage_Modes_GetImages option is enabled, images will be present in the results and vice versa.
  • Fixed issue with capturing Axial image for 70x7 and 70x8M devices.
  • Fixed issue with cropping ID1 documents on 83x3 devices when SmartUV is enabled.
  • Fixed issue with hardware document presence sensor in video detection mode. Now it is always disabled.
  • Fixed issue with Mexican Passport barcode – personal number not returned, if filled with zeros only.
  • Fixed issue with returning gf_Portrait graphic field for scanned portrait photo only.
  • Fixed issue with video detection that was broken in 4.12.3 – some statuses were skipped.
  • Fixed issue with comparison of postcode in US DL between VIZ and Barcode, due to barcode filling formats in some states.
  • Fixed issue with “TRAJNO” value in expiry dates on verification.
  • Fixed issue with value 29/02/00 in DOB verification.
  • Fixed issue with TWAIN driver under Windows 10.
  • Fixed issue with cropping documents on 70x8 devices.
  • Fixed issue with correct DPI determination for external images of laminated cards captured without border laminate.
  • Documentation updated.

RFID SDK

  • IMPORTANT! New firmware version 21.13. It is recommended to update your 21.x firmware series devices to this new version. Fixed issues:
    • FL_DeviceConfigured flag correct handling in USB_Power_Event, USB_Suspend_Event, USB_Resume_Event, USB_Configure_Event.
    • Implemented handling of current active antenna in multi-antenna setup when moving document from one antenna to another without generating additional out-in events.
    • Fixed issue with device initialization – now wating for enumeration completion after USB_Connect signal.
    • Fixed issue with device enumeration when another contact smart card reader is present on older systems (Windows 7).
    • Fixed issue with default baudrate limit when using device from third party software.
  • Added new eRFID_BaudRate enum member rfbr_default.
  • Fixed issue with setting non default baudrate on disconnect.
  • Fixed issue with timer in logging.

Document Reader Application

  • Added correct handling of RFID PCSC FileNotFound, FileAccessDenied, EndOfFile notifications in overall result.
  • Added correct handling of CA and AA notifications of incorrect info in overall result.
  • Added capability of encrypting scanning results. When enabled, all scanning and processing results will be saved in encrypted storage file instead of a folder. Asynchronous results saving option will be disabled if encryption is enabled.

COM

  • Added property EncryptResults to enable/disable encryption of scanning and processing results. Disabled by default (Boolean, read/write).
  • Added property EncryptionPassword to specify the password to be used when encrypting scanning and processing results. Empty by default (string, write only).
  • Added property TrustDPI to keep or clean source images original DPI when processing external images. Disabled by default (boolean, read/write).
  • Fixed issue with DoProcessImage method thowing exception on call.
  • Fixed issue with DeviceAvailableLights property returning incomplete result.
  • Enums updated.
  • Documentation updated.

Installer

  • SDK installation package size greatly reduced due to removal of redundant 3rd party libraries.
  • Fixed device re-plug request message box after RFID FW update in silent installation mode.
  • RFFWUpdate.exe now does not require RegulaReaderFX.dll, as it is statically linked inside the application.
  • Perforation.dll removed from package.

Database

  • Improved description of image patterns in many documents based on statistics.
  • Updated and fixed document links to IRS databases.
  • ICAO PKD master list version 117 included.
  • BSI master list version from 04.02.2019 included.
  • 243 countries and territories / 7037 documents included.
  • 268 new documents added.
  • Description extended for 85 documents.

Version 4.12.3 — November 20, 2018

SDK

  • Added licensing by country filter for supported documents recognition. Now if your license allows only specific countries to be processed, then documents from other countries will not be recognized and will be processed as with Basic SDK license.
  • Added transliteration from cyrillic to latin for Bulgarian passports and IDs.
  • Added support of new 2 letter code "UN" for United Nations, used is DS certificates.
  • Added support for Australia Medicare Card number checksum validation.
  • Added support for loading license information file (devices.dat) from common program data folder for all users, where it can be installed via Regula Keys application ("C:\ProgramData\Regula\Licenses", by default).
  • New barcode parsers added:
    • Brazil consular ID,
    • Zimbabwe ID.
  • New MRZ format parsers added:
    • Myanmar Visa,
    • India Visa.
  • diDocType enum member dtRegistrationCertificate value changed from 31 to 206.
  • Added new eRPRM_Commands enum member:
    • RPRM_Command_Device_Get_LED.
  • Improved performance of document video detection for all supported devices. Now operator hands on the glass do not interfere with correct document detection when scanning ID cards.
  • Improved performance for 7017D devices when scanning ID1, ID2 cards.
  • Improved document images processing when document fills all image and there is no frame around it to detect document and crop it, when DPI is not set.
  • Fixed issue with incorrect XML and JSON results generation for RPRM_ResultType_MRZ_TestQuality result type.
  • Fixed issue with incorrect cropping of the document when working in document detection sensor mode for 7017/7027 devices.
  • Fixed issue with incorrect document detection/no detection for 7017/7027 devices, especially for passports.
  • Fixed issue with OCR results not availble if some of the fields does not fit into the image.
  • Fixed issue with document cropping not working correctly on processing images in some cases with ID3x2 document images.
  • Fixed issue with incorrect document cropping on Argentina ID’s.
  • Fixed issue with multiple results of RPRM_Authenticity_Photo_Embed_Type check with consecutive scans.
  • Fixed issue with DL class code dates validation on systems with Dutch locale date/time settings.
  • Fixed issue with South Sudan DS certificate country code validation.
  • Fixed issue with ft_Father_Name field being added into ft_SurnameAndGivenNames field for documents of Turkey.
  • Fixed issue with 29.02 day in dates that was incorrectly verified.
  • Fixed issue with "Mainland China to Taiwan Card (2014)"" document MRZ from RFID DG1 to make it comparable with printed MRZ.
  • Fixed issue with OCR of Kazakh national cyrillyc symbols.
  • Fixed issue with resetting LED indicators on connect for devices with multiple indicators.
  • Fixed issue with result images rotation.
  • Fixed issue with when sensor is enabled after scan on 72x3 devices.
  • Fixed issue with incorrect portrait comparison for babies and toddlers by not running this check for them.
  • Fixed issue with incorrect processing images from folder, when different images of the same page where processed as separate pages.
  • Fixed issue with processing document images, when one of two pages provided was not recognized.
  • Fixed issue with incorrect document format assumption after recognition, when document type was recognized correctly, but no more results avaialbe.
  • Lots of small internal fixes and refactorings made for optimization purposes.
  • Documentation updated.

RFID SDK

  • IMPORTANT! New firmware version 21.10. It is recommended to update your 21.x firmware series devices to this new version. Fixed issue with failed device detection on system start, when other CCID readers connected on Windows, that happen occasionally on selected systems. Fixed issue with device operation after PC returning from sleep mode.
  • Fixed issue with RFID_Command_CancelReading command call has no effect.
  • Fixed issue with value set by RFID_Command_Set_TrustedPKD command was not taken into account when loading certificates from PKD folder.

Document Reader Application

  • Added license check on database update. If your license if not eligible for current update user will be warned and it is not installed automatically in silent / background mode.
  • Added functionality on saving RPRM_ResultType_DocumentPosition results in XML and JSON.
  • Added support of processing images with ".jpeg" and ".tiff" extensions.
  • Fixed issue with results not saved if asyncronous saving results endbled and scan is correct.
  • Fixed issue with stability after switching touch interface on and off.
  • Fixed issue with touch interface being hidden on device auto connect.
  • Fixed issue with saving results for document when holder name has more than one line.
  • Fixed issue with checking battery status during scanning and processing.
  • Fixed issue with "Read RFID" when chip was already detected and no MRZ/password provided.
  • Documentation updated.

COM

  • Added method GetLED to retrieve current LED color for specified LED index.
  • Fixed issue with disconnecting clients on any exception. Now client is disconnected only when "The RPC server is unavailable" exception thrown on call.
  • Documentation updated.

Installer

  • Added license check for use eligibility of current SDK version on install. Warning is now shown if subscription is not covering version that is being installed.
  • Added standard Microsoft CCID driver for SmartCard devices support on Windows XP for compatibility on this OS with new HW generation of RFID board (21.x).
  • PDF417 module static resources taken out of the module as a separate files into SDK folder.
  • RFFWUpdate application added to “RFID Reader SDK\FirmwareUpdate” folder to provide possibility to update firmware on new HW generation of RFID board (21.x)

Database

  • Improved description of image patterns in many documents based on statistics.
  • Updated and fixed document links to IRS databases.
  • ICAO PKD master list version 111 included.
  • BSI master list version from 25.10.2018 included.
  • 242 countries and territories / 6763 documents included.
  • 180 new documents added.
  • Description extended for 100 documents.

Version 4.12.1 — July 27, 2018

SDK

  • Added support for new device 7017D.
  • Improved support for 7028M, 7017, 7027 devices. Performance is greatly improved for both scanning and video-detection. Video-detection now runs by default in the same resolution as set in device video mode for these devices.
  • Improved barcode detection and reading performance in Quick Boarding pass mode.
  • Greatly improved document type recognition module. Now recognition works 10x faster and database size is reduced by 50MB. Database loading time is also reduced a lot.
  • Improved document type recognition from external images without the correct DPI resolution set. The document type is now determined, even if the document was cropped to the edges or more.
  • Greatly improved OCR for Russian national passports, both speed, and accuracy.
  • Improved OCR for Hebrew.
  • Improved OCR for fields with noisy colorful backgrounds.
  • Added A4 format support for cropping and document type recognition from external images.
  • RPRM_Capabilities_ProcessImages capability is only available during its validity period that is registered in our licensing system for a specific device or software license.
  • Added generation of ft_Nationality field based on ft_Nationality_Code.
  • Added generation of Latin fields transliterated from Cyrillic for specific documents that can be enabled by configuration option.
  • Added generation of MRZ for non-MRZ documents for compatibility mode that can be enabled by configuration option.
  • Added new MRZ formats for:
    • Pakistan ID,
    • Turkmenistan visa,
    • Uzbekistan passport,
    • Coted'Ivoire visa,
    • Belgium ID.
  • Added new barcode parsers for:
    • BelizeDL,
    • CAFID.
  • New enum eVisualFieldType members:
    • ft_GrandfatherName
    • ft_Selectee_Indicator
  • Fixed issue with incorrect UV colors calibration for 70x7, 70x8m devices.
  • Lots of small issues and memory leaks fixed.
  • Documentation updated.

RFID SDK

  • RFID SDK re-certified for conformance with BSI TR-03105 – Conformity Tests for Official Electronic ID Documents: Part 5.1, EACv1, version 1.41; Part 5.2, EACv2, version 1.2. It is now certified for Windows, Linux, and Android operating systems. You can find a certificate for reference here.
  • Enum members of eRFID_VisualTextType moved to eRPRM_VisualTextType enum for consistency with the same names and values.
  • Fixed issue with Netherlands eDL 2017-> DG1 fields parsing that lead to the exception.
  • Fixed issue with RFID reading in manual detection mode when antenna field remained on after reading finished.
  • Documentation updated.

Document Reader Application

  • Added possibility to save DbgView logs to files instead of in-application only. Now, if you enable Do Reader log option, DbgView starts in hidden mode with tray icon only and saves all logs into the files named with today’s date into the Logs folder. The file named with PC’s name, start timecode and date. Daily rotation is enabled. This way logging will not cause any issues if left enabled for long periods of time (weeks, months) and all logs will be available for inspection.
  • Added possibility to reconnect RFID reader device if an active device was occasionally disconnected and then connected back again.
  • Added saving of BarcodesData.dat file into Recent results folder in video-detection mode if Quick Boarding pass mode is enabled and Save recent results option is enabled as well.
  • Fixed issue with Report sample issue function was not actually able to send the report because of old TLS protocol version used for data transfers. As this is third-party service that we use for support ticketing and they ruled this way for safety, unfortunately, all previous SDK versions are now unable to submit reports.
  • Fixed issue with the OnProcessingFinished event not being sent if the device was disconnected during reading or scanning process returned an error.
  • Fixed issue with PA status calculation, where file reading negative status was not counted, but the overall status was correct.
  • Fixed deadlock when calling the Disconnect method during scanning.
  • Fixed deadlock when RFID reading was in progress and device physically disconnected.
  • Fixed issue with resetting RFID chip presence after reading for chips supporting Mifare, that lead to the inability of subsequent readings without document re-inserting into the reader.
  • Fixed issue with Ask for next page option when notification window was not shown.
  • Fixed issue with Disconnect button enabled during calibration.
  • Fixed issue with device battery status querying during scanning and processing.
  • Fixed issue with the Print dialog where images were added to the report always regardless of selection.

COM

  • DebugLogsFolder property added that sets or returns folder path, where debug logs will be saved. By default, this property has value %AppData%\Regula\Logs. This folder used for saving the DbgView output into files and for saving debug reports (variant, read\write).
  • RFIDRestartOnPCSCError property added that sets or returns whether second RFID reading will be performed on smart card error during first reading (chip page lifted, document removed and inserted again during reading, lost connection to the chip, etc.). Enabled by default (boolean, read/write).
  • Fixed issue with a sequence of sending OnResulReadyXML and OnResultReady events at the same time for the same event (in video-detection).
  • Calls to ClearResults, GetImages and DoProcessImages methods are blocked during ongoing scanning and processing for safety reasons.
  • Logging extended. Now all calls to every property, method and event calls are logged.
  • Enums updated.
  • Documentation updated.

Database

  • Improved description of image patterns in many documents based on statistics.
  • Updated and fixed document links to IRS databases.
  • ICAO PKD master list version 104 included.
  • BSI master list version from 09.07.2018 included.
  • 241 countries and territories / 6584 documents included.
  • 203 new documents added.
  • Description extended for 105 documents.

Version 4.11.3 — April 02, 2018

SDK

  • Added support for new device 7028M.
  • Added support for new devices 7027.100, 7027.110, 7017.100, 7017.110 with hardware sensor.
  • Added support for new device 8824.
  • Added functionality to read CAN in videodetection, when QuickMRZProcessing mode is enabled.
  • QuickMRZProcessing mode completely redesigned and optimized for stability and time for both optical and full scanning, reading, and processing with RFID.
  • Added new country code for Abkhazia – ABK.
  • Added/updated MRZ parsing formats for:
    • Argentina passports,
    • Kenya passport.
  • Added parser for Netherlands eDL backside barcode to provide a possibility to read RFID data instantly when scanning back side only.
  • Added new barcode parsers for:
    • Paraguay DL,
    • Mali ID.
  • Added Hebrew fields OCR for Israel documents.
  • If QuickBoardingPassProcessing mode is enabled, now any barcode reading result will be sent with result availability callback, regardless of whether barcode is a boarding pass or not.
  • New enum eRPRM_DeviceTypes member:
    • RPRM_DeviceType_FX_7058M.
  • New enum eRPRM_VideoModes members:
    • RPRM_VM_24MP,
    • RPRM_VM_24MP_1_5.
  • New enum eRPRM_Capabilities members:
    • RPRM_Capabilities_RFID,
    • RPRM_Capabilities_BankCard.
  • New enum eRPRM_ResultType member:
    • RPRM_ResultType_DeviceInfo
  • Structure TRegulaDeviceProperties extended with new fields Capabilities, Authenticity, Database, ValidUntil and WillConnect.
  • New enum eVisualFieldType members:
    • ft_BankCardNumber,
    • ft_BankCardValidThru,
    • ft_TaxNumber,
    • ft_HealthNumber.
  • nFields field changed type from int to DWORD in TDocVisualExtendedInfo, TDocGraphicsInfo and TDocBarCodeInfo.
  • Enum diDocType redefined. All members renamed to new format.
  • Fixed critical issue with SDK crash when device was removed from system during scanning.
  • Fixed issue with OVI pattern contrast check incorrect results on some devices (5MP).
  • Fixed issue with call to RPRM_Command_Device_Disconnect returned RPRM_Error_Busy instead of waiting until disconnect actually happened, when called during scanning and processing.
  • Fixed issue with sending the same barcode or MRZ reading result multiple times from videodetection in QuickBoardingPassProcessing and QuickMRZProcessing modes.
  • Fixed issue with restarting document videodetection when any of following commands has been called: RPRM_Command_Device_UseVideoDetection, RPRM_Command_Options_Set_QuickBoardingPassProcessing, RPRM_Command_Options_Set_QuickMrzProcessing.
  • Fixed issue with document type recognition against whole database instead of one document ID if only one is set with RPRM_Command_Options_Set_CurrentDocumentType.
  • Fixed issue with document type recognition for visas with stamps over MRZ.
  • Fixed issue with incorrect dates encoding when generating TR-03135-2 XML results on some locales.
  • Fixed issue with parsing boarding passes barcode where day of flight field is filled with space instead of 0.
  • Fixed issue with parsing place of birth for Belarus passports.
  • Fixed issue with adding Father’s name into Hebrew full name.
  • Fixed issue with opening JPEG images having density set to 0 lead to incorrect resolution.
  • Fixed issue with extensive incorrect logging.
  • Minor memory leaks and minor bugs fixed.
  • Documentation updated.

RFID SDK

  • Added support of both cases of generation/verification of AA signature according to ISO9796- 2:2010 B.4, B.6.
  • MRZ parsing and validation functions have moved inside the SDK library from external library for crossplatform compatibility.
  • Fixed AA procedure when AlgorithmIdentifier.parameters field is missing in DG15. Now default parameters are applied and no incorrect data error generated.
  • Fixed issue with generating encoded APDU when switching from SingleLen to ExtLen.
  • Documentation updated.

Document Reader Application

  • Translation storage changed to single unified XML file format for all Regula products. All separate *.lng files in .\Languages folder are replaced by Translator.xml file in SDK folder.
  • Added database updates license expiration data to “About“ dialog information.
  • Feedback form updated with reference to our privacy policy and request for consent.
  • Branding updated.
  • Now free space check is performed before saving any results. If less than 100MB left on the target drive, save is not performed.
  • Fixed issue with PA result calculation and certificate chain statuses sequence in specific cases.
  • Fixed issue with translations – if translation is not available in selected language, it will be shown from English.
  • Fixed issue with endless authentication loop with PACE and incorrect key.
  • Fixed order of data in logging strings.
  • Fixed issue with RFID reading restart when reading was cancelled explicitly.
  • Fixed issue with incorrect result of PA when checking SOD signature with DS certificate only and Trust PKD option is enabled.
  • Fixed issue with saving RFID reading log into RFID session file (RFID_Session.dat). Now if RFID logging enabled, then after reading you may send sample via “Report sample issue” and reported data will automatically contain RFID reading log.

COM

  • RFIDIsDeviceReady property added that returns whether RFID reader device is available, connected, and ready for operation. If RFID reading is disabled via DoRFID property it will also return False (boolean, read only).
  • RFIDWaitForInsertTimeout property added that sets or returns timeout in milliseconds waiting for RFID chip to be detected before finishing reading attempt with WaitAndReadRFID method if not (Integer, read/write).
  • Fixed issue with setting AutoScan property before device connection.
  • Fixed issue with client being disconnected if it makes method call to COM from COM notification event handler, that generates another notification. Making such calls is not recommended as it can potentially lead to dead locks.
  • Fixed issue with deadlock when Disconnect method called during scanning and processing
  • Logging extended.
  • Enums updated.
  • Documentation updated.

Installer

  • Branding updated.
  • Languages folder is removed from Document Reader SDK installation folder.
  • mrzctest.dll & mrzproc.ini removed from RFID SDK installation folder.
  • Database installation package from now on will be provided separately between SDK releases. It will contain both template database updates and patched/fixed libraries for intermediate SDK update between releases. It will be available in both .msi and .exe formats.

Database

  • Improved description for visa recognition with MRZ, that can be covered with stamps.
  • Improved description for image patterns in many documents based on statistics.
  • Template binding data storage optimized.
  • Updated and fixed document links to IRS databases.
  • ICAO PKD master list version 98 included.
  • BSI master list version from 14.02.2018 included.
  • 241 countries and territories / 6398 documents included.
  • 285 new documents added.
  • Description extended for 94 documents.

Version 4.10.2 - February 17, 2017

SDK

  • Added support for new device series 83x3M.
  • Added support for 3M readers with 3M SDK v.3.3.3.10.
  • Improved document detection on the image, especially for 72x3 devices.
  • Added possibility to convert Cyrillic text fields into Latin for certain documents.
  • Added parsing of document serie into issuing region for Russian Federation domestic passports.
  • Added new parser of QR code for Angola visas.
  • Improved software and dongle licenses handling.
  • Improved image quality assessment algorithms (focus, glare, resolution).
  • New struct TFDSIDList.
  • New enum diDocType.
  • New enum eRPRM_Commands members:
    • RPRM_Command_Options_Get_StopOnBadInputImage,
    • RPRM_Command_Options_Set_StopOnBadInputImage.
  • Fixed issue with 1970 year dates conversion leading to completely incorrect values.
  • Fixed conversion of “безсрочен” date of expiry value into “01/01/2050” for Bulgarian ID cards.
  • Fixed issue with dates conversion from MRZ format into local regional format for quick MRZ processing mode.
  • Fixed numerous issues with parsing and validation of fields for different documents.
  • Fixed issue with reading CAN from ID cards in 90 degrees rotated position in quick MRZ processing mode.
  • Fixed issues fix parsing barcode data for numerous documents.
  • Fixed issue with handling 32-bit Bitmaps.
  • Fixed issue with std::mutex use on WinXP.
  • Fixed issue with reordering pages of document with multiple pages when processing images.
  • Fixed issue with incorrect rotation of document when processing images.
  • Fixed issue with processing images with incorrect DPI set.
  • Fixed numerous memory leaks.
  • Documentation updated.

RFID SDK

  • New amendment “DeviantUruguaySOD” for some Uruguay document issued with incorrect DS certificate in EF.SOD, that should be checked instead with different external certificates.
  • New enum eLDS_ParsingNotificationCodes members:
    • ntfLDS_ICAO_DeviationList_Version_Incorrect,
    • ntfLDS_BSI_DefectList_Version_Incorrect,
    • ntfLDS_BSI_BlackList_Version_Incorrect,
    • ntfLDS_ASN_SignerInfo_ListContentDescriptionAttr_Missing,
    • ntfLDS_ASN_SignerInfo_ListContentDescriptionAttr_Data.
  • New enum eRFID_CertificateOrigin members:
    • coDefectList_SO,
    • coDeviationList_SO,
    • coBlackList_SO.
  • New enum eRFID_DataFile_Type member:
    • dftDeviationList.
  • New enum eRFID_CertificateType members:
    • ctDevLS,
    • ctDefLS.
  • Fixed issue with XML results file containing incorrect characters for some of documents.
  • Fixed issue with chineese names parsing results from DG1 data in China documents.
  • Fixed issue with Symmetric Cypher algorithm determination for eDL by MRZ line (introduced in 4.10.1).
  • Fixed issue with Belgium SOD signature validation.
  • Fidex issue with eDL DG1 data parsing.
  • Documentation updated.

Document Reader Application

  • When reporting sample issue via Feedback form, screenshot of the main form is also attached to the ticket to demonstrate the issue as it appears for easier understanding.
  • Added possibility to specify subject in Feedback form.
  • Added possibility to update MRZ data after incorrect reading because of damaged document, for example, for passing it to RFID chip for further manual chip reading.
  • Fixed issue with submitting report sample ticket, when it was impossible to create ticket if “ or \ characters were present.
  • Fixed issue with incorrect data groups reading in eDL (introduced in 4.10.1).
  • Fixed issue with RFID chip reading in Mainland China to Macao and Hong Kong Card (2014).

COM

  • EjectDocument method added that allows you to eject the card manually from the reader. This is only effective specifically on 72x3 devices. Together with ManualEject property, this method may be helpful if you want to keep card inside the reader for some time after processing finished. If ManualEject is set to true, but you still do not call this method, card ejected automatically after HW defined timeout.
  • ManualEject property added for setting/getting whether ejection of the card will be done automatically (false by default) on processing finished. If set to true, then you may eject the card manually by using EjectDocument method. This property is only effective specifically on 72x3 devices (bool, read/write).
  • AddActiveLight method added that allows you to set specific light to capture. You can call this method for each separate light you need to capture. To reset current lights you may call SetActiveLights(0).
  • StopProcessingOnBadImages property added for setting/getting the mode, when image processing cancelled if input images quality check failed (false by default). This is only effective for images processing via DoProcessImages method call. If DoLocateDocument enabled, then before image quality check document detection on the image performed. If no document detected, then process cancelled (bool, read/write).
  • Fixed issue with not sending PA and TA resources back to RFID SDK, received via Scenario event callback, that lead to inability to perform PA or TA online (introduced in 4.10.1).
  • Documentation updated.

Installer

  • Added Reader3M.dll library for out of the box support of 3M readers.
  • FullVideoSensor.dll removed from package. Now its functionality included inside the RegulaReaderFX.dll

Database

  • ICAO PKD master list version 82 included.
  • BSI master list version from 05.01.2017 included.
  • 230 countries and territories / 5440 documents included.
  • 117 new documents added.
  • Description extended for 60 documents.

Version 4.11.1 - December 21, 2017

SDK

  • Added support for new device 7027.
  • Improved support for new device series 83x3M.
  • New camera driver version 10.5.6.1 included.
  • Added support for handling two simultaneously connected devices 70xx & 72xx. Device with inserted document becomes active.
  • Added possibility to send text recognition results to COM port (configurable).
  • Added possibility to depersonalize scanned document images with black squares based on field types setup (text/graphic) or physical coordinates in mm based on recognized document type or country/document type code from MRZ.
  • Added possibility to use IR light only for determining document type in case visible light is not available and vice versa.
  • Added possibility to use IR light for searching for field bindings in case visible light image is not available and vice versa.
  • Added support for parsing Place of birth field in Belarus passports into separate fields for city, region, state, country.
  • Added new barcode parsers for:
    • Mauritania visa,
    • Abkhazia passport,
    • Jordan passport,
    • Mexico voting card,
    • Paraguay ID card.
  • Added/updated MRZ formats:
    • Spain residence permit,
    • Spain ID card,
    • Kazakhstan ID card (ID1),
    • Kazakhstan ID card (ID2),
    • Kazakhstan residence permit,
    • Turkmenistan visa,
    • El Salvador passport,
    • Ireland DL,
    • Slovakia eDL,
    • Francee DL,
    • Estoniae DL,
    • Netherlands eDL.
  • Added MRZ conversion for RFID reading for some Chinese travel ePermits.
  • Added possibility to crop signature from scanned image and return it as graphic field. If the scanned paper has only signature on it, and no MRZ, no photo, and document type hasn't been recognized.
  • Added support for Transmitted and Transmitted IR lights handling in 70x4m devices.
  • Updated country codes according to ICAO Doc 9303:2015.
  • Improved non latin paths handling. Now everything in UTF8.
  • Improved software license handling. Standard capabilities license is needed to use SDK with 3rd party devices to scan and process document images. With standard license we allow processing and reprocessing images taken with specific device using our SDK. Additional extended “Process images” capability is required if SDK need to be used with any external image from any source (not taken with specific licensed device, and not with our SDK. For example - web cam, flatbed scanner or mobile phone camera).
  • Improved devices connect/disconnect handling via system events / callbacks.
  • Improved CurrentDocumentType option handling. Now it is possible to set many document IDs separated by “|” (“ID1|ID2|...|IDn”).
  • Improved recognition of document type specified by CurrentDocumentType by checking document 180 degrees rotation.
  • Improved scanning performance with Quick MRZ reading option enabled by switching video mode back to initial after scan finish.
  • Improved support for 3M devices: no need for calibration, licensing fix, single-time connection fix.
  • Improved performance of videodetection.
  • All image processing modules made cross-platform (tested on Windows, Linux, Android, and iOS).
  • Fully switched to OpenCV instead of IPP for image processing in all modules.
  • Removed dependency from QT libraries from all modules.
  • New struct added:
    • TVideodetectionNotification.
  • New enums added:
    • eProcessCommands,
    • eProcessCommandsResult.
  • New enum eRPRM_NotificationCodes member:
    • RPRM_Notification_VideoFrame.
  • New enum eRPRM_DeviceAdditionalFeatures members:
    • RPRM_DeviceAdditionalFeature_KeyboardLight,
    • RPRM_DeviceAdditionalFeature_ExternalLight,
    • RPRM_DeviceAdditionalFeature_Transmitted_IR940,
    • RPRM_DeviceAdditionalFeature_DocumentSensor.
  • New enum eRPRM_Lights member:
    • RPRM_Light_Transmitted_IR940.
  • New enum CDocFormat member:
    • dfPhoto.
  • New enum eRPRM_Authenticity member:
    • RPRM_Authenticity_Kinegram
  • New enum eRPRM_Commands members:
    • RPRM_Command_Set_ProcessParametersJson,
    • RPRM_Command_Options_Set_VideodetectionLowSensibility,
    • RPRM_Command_Options_Set_TrustVideodetectionResult.
  • TOneCandidate.ID type changed from DWORD to int.
  • TImageQualityCheck struct extended with new members mean, std_dev and probability.
  • TBoundsResult struct extended with new members ResultStatus, Reserve1 and Reserve2.
  • Fixed issues with implementation of BSI TR-03135 XML results.
  • Fixed issue with capturing coaxial light only.
  • Fixed issue with videodetection under Windows XP.
  • Fixed issue with saving TIFF images.
  • Fixed issue with loading PNG images from memory buffer.
  • Fixed issue with cropping rotated 180 degrees ID1 documents.
  • Fixed issue with visa ID in Russian visa.
  • Fixed issue with Central African Republic country code in DS certificate.
  • Fixed issue with validating Valid from field in visas if today is the day.
  • Fixed issue with ‘i’ OCR in Hong Kong ID cards.
  • Fixed issue with Chenese symbols ‘day’, ‘month’, ‘year’ recognition in Chinese IDs.
  • Fixed issue with device unplug leading to crash on Windows 7.
  • Fixed issue with processing of extremely large images.
  • Fixed issue with lighting board version on 70x4.
  • Fixed numerous memory leaks.
  • Documentation updated.

RFID SDK

  • New RFID SDK version 3.5.
  • Linux & Android OS are now supported.
  • Full switch from IPP to OpenSSL library for cryptography algorithms.
  • Added support for new devices with hardware based on 21.x firmware series.
  • Added support for APDU commands for devices control instead of IOCTL commands to driver.
  • New driver version 7.6.5.7 for devices with hardware based on 5.x/10.x firmware series included and should be used with this SDK for correct performance.
  • IMPORTANT! New firmware version 10.31. It is recommended to update your 10.x firmware series devices to this new version. Added support of chips with asymmetric read/write baudrates. Fixed issue with failed connection on some chips while performing AA (issue was introduced in 10.28).
  • eDL application support of both EU and ISO format extended and corrected.
  • Scenario for Advanced authentication procedure type has been changed according to Frontex technical guidelines http://frontex.europa.eu/assets/Publications/Research/Best_Practice_Technical_Guidelines_ ABC.pdf
  • Added extra information to scenario requests in XML required for Online TA as per BSI TR- 03129 p.4.3.2 [https://www.bsi.bund.de/SharedDocs/Downloads/EN/BSI/Publications/TechGuidelines/TG03129/BSI_TR_03129.pdf] (https://www.bsi.bund.de/SharedDocs/Downloads/EN/BSI/Publications/TechGuidelines/TG03129/BSI_TR_03129.pdf). Now when tatsdtPlainData is used, “Challenge” node has 4 attributes (idPICC, challengePICC, hashPK, auxPCD) with their length in concatenated binary array (Challenge), that is Base64 encoded.
  • Added possibility to switch to manual detection mode at any time without library reinitialization.
  • Added possibility to verify SOD signature using only external DS certificate from trusted source without need for CSCA certificate.
  • Added possibility to get/save results in JSON format.
  • New structures added:
    • TRF_EDL_DG2,
    • TRF_EDL_DG3,
    • TMIFARE_BlockAuth,
    • TRFID_Layer14_Param,
    • TRFChipProperties,
  • New enums added:
    • eRFID_RegulaDeviceModelID,
    • eRFID_Layer14_Items,
    • eRFID_Layer14_Param_Type.
  • New enum eRFID_VisualFieldType members:
    • ft_TypeApprovalNumber,
    • ft_AdministrativeNumber,
    • ft_DocumentDiscriminator,
    • ft_DataDiscriminator,
    • ft_ISO_Issuer_ID_Number.
  • New enum eCBEFF_FaceImageTypeFDIS members:
    • fitFDISProcessedFrontal,
    • fitFDISBasic3D,
    • fitFDISFullFrontal3D,
    • fitFDISTokenFrontal3D.
  • New enum eCBEFF_ImageDataType members:
    • idtJPEG2000Lossless,
    • idtPNG.
  • New enum eRFID_DataFile_Type member:
    • dftDL_CVCA,
    • dftChipProperties.
  • New enum eLDS_ParsingNotificationCodes member:
    • ntfLDS_ASN_SignedData_ContentOID_Incorrect.
  • New enum eRFID_ErrorCodes member:
    • RFID_LAYER6_MUTUAL_AUTH_FAILURE_DATA.
  • New enum eRFID_Commands members:
    • RFID_Command_ReadCardPropertiesExt2,
    • RFID_Command_Set_DetectionMode,
    • RFID_Command_Layer1_4_Param_Set,
    • RFID_Command_Layer1_4_Param_Get.
  • New enum eRFID_PKD_ResourceType member:
    • pkdDefL,
    • pkdDevL,
    • pkdBL.
  • TRF_EDL_DG1 structure changed: TRF_FT_STRING
  • TRFID_AntennaParams and TRFID_AntennaParamsPair structures deprecated.
  • TRFCardProp.ATQ_B member size changed from 12 to 13 bytes.
  • TCustomRawDataList.Count changed type from int to DWORD.
  • Deprecated enum eRFID_Commands members:
    • RFID_Command_SetAntennaParams3,
    • RFID_Command_GetAntennaParams3,
    • RFID_Command_SetAntennaParams4,
    • RFID_Command_GetAntennaParams4,
    • RFID_Command_Get_AntennaParamsCount,
    • RFID_Command_Set_AntennaParamsItem,
    • RFID_Command_Get_AntennaParamsItem,
    • RFID_Command_Get_ActiveAntennaParamsIdx,
    • RFID_Command_Set_ActiveAntennaParamsIdx.
  • Fixes for x64 platform support.
  • Fixed issue with readers connect/disconnect: now based on system events, detection monitoring thread deleted.
  • RFID.h file encoding changed to UTF8.
  • C++11 standard support in code.
  • Logging extended.
  • Documentation updated.

Document Reader Application

  • Added support for Kinegram security check results display.
  • Added full support for two simultaneously connected readers 70xx & 72xx (together with RFID reading support from current active reader with document).
  • Added saving of XML/JSON results for InputImageQuality check result data into “Results”/”Recent results” folders.
  • Added possibility to see IR luminescence, Transmitted and Transmitted IR light images in printed scan report.
  • Added possibility to save RFID results in JSON format.
  • Fixed applying amendment “DeviantUruguaySOD” not only for passports, but for ID cards also.
  • Fixed issue with RFID overall result when DG reading errors occurred.
  • Fixed issue when message dialog asking for chip insertion remains on next scan on 83xx devices.
  • Fixed issue with non latin folder names (now all strings in UTF8).
  • Fixed issue with main window loosing focus on next scan.
  • Fixed issue with RFID reading thread termination on exit.
  • No manual RFID chip detection for third-party readers.
  • “ExtendProcessingModes” and “DocTypeAdvScheme” configuration parameters are now applied/saved from/to configuration file.
  • RegulaReader.json configuration file is now applied as ProcessingParams configuration if exists besides RegulaReader.ini.
  • Fixed issue with saving debug log files.
  • Prepared to support x64 SDK.

COM

  • ExtendProcessingModes property added that sets or returns whether processing modes will be automatically extended to required, based on requested modes or it will be explicitly specified what should be done. For example, if you need to do Visual OCR, usually we need to crop document and recognize its type. However, in some cases it is possible to skip some steps and perform only certain steps for speeding up the processing (boolean, read\write).
  • ProcessingParams property added to set all kind of possible parameters for processing in JSON format. Now, only implemented parameters are for images depersonalization. You may set hiding fields (text or graphic) or areas from images in all lights for any or specific document (country, document format, specific document ID, etc.). This property accepts JSON string with specific parameters inside (see optical SDK documentation) or empty string to disable depersonalization. Disabled by default. In future, we plan to use this property for passing all configuration at once for convenience (variant/write only).
  • RFIDWaitForCryptKeyTimeout property added that sets or returns timeout waiting for MRZ/CAN to become available after chip was detected before finishing reading attempt if not.
  • TrustVideoDetectionResult property added that sets or returns whether video detection results of document position used for document cropping if DoLocateDocument enabled. If disabled, document location will be determined separately. This may affect performance/accuracy of cropping (boolean, read\write).
  • VideoDetectionDivider property added that sets or returns active camera video resolution used for video detection of document presence. Value is division factor from maximum original video mode resolution. By default set to minimum video mode size. See UseVideodetection for details (integer, read/write).
  • VideoDetectionLowSensibility property added that sets or returns whether low sensibility mode enabled. This mode used for readers installed in gates to track only changes in the reader view field that look like documents. Enabled by default (boolean, read/write).
  • OnVideoDetectionFrame event added that is raised each time SDK notification callback called with RPRM_Notification_VideoFrame notification code. This event is useful to obtain images from optical reader immediately on their availability from video detection in real time.
  • Fixed issue with raising exception when COM client process left his connection orphaned (process was terminated, or just left COM object handle undisposed on exit).
  • Fixed issue with “License expired” message appear even when running in InBackground mode.
  • Documentation fixed and updated.

Installer

  • Added Help center article on all available installer parameters here.
  • Added possibility to use local Document Reader web service for using document readers from Internet browsers using, for example, JS. Help center article describes how to install and use it here.
  • Added option to add Document Reader application to Startup and enable Auto connect.
  • Added AlcorMicro driver version 1.7.46.0 for contact SmartCard reader (7034M, 7039, 7233).
  • Added driver version 1.0.2.1 for new RFID readers hardware based on 21.xx firmware (Windows native INF-only).
  • Added libcrypto-1_1.dll (OpenSSL).
  • Camera driver updated to version 10.5.6.1.
  • RFID reader driver updated to version 7.6.5.7.
  • Gmp.dll removed from package in favor of mpir.dll.

Database

  • Improved description for document type recognition for documents without MRZ.
  • Improved description for image patterns in many documents based on statistics.
  • Updated and fixed document links to IRS databases.
  • ICAO PKD master list version 94 included.
  • BSI master list version from 20.12.2017 included.
  • 239 countries and territories / 6121 documents included.
  • 689 new documents added.
  • Description extended for 275 documents.

Version 4.10.1 - December 16, 2016

SDK

  • New camera driver version 10.5.4.2 included.
  • Software licenses support implemented. You may run only one copy of application using SDK on a computer with software license, by default. All licenses are time limited, therefore when license is expired, SDK will still connect, but with no capabilities available. You may not run SDK under server OS or on terminal server via RDP unless explicitly licensed. License is provided as a file which itself is a token, that may be used once issued. License may be reused after expiration if data file with licensing information will contain renewal information for this token. Also there is a possibility to license image processing capabilities for images from specific devices only, limited by list of device UIDs.
  • Processing saved images now limited to the images scanned by the connected Regula device. For processing all other external images or images taken on other devices, you need to have a special license.
  • Completely redeveloped cross-platform module for patterns authenticity check. It includes low and high frequency objects checks, shape and color checks, support of floating objects, UV ghost photo matching to visual, OVI objects check, text luminescence check, support of objects degradation, false luminescence check. Now it covers most of the object cases available and template creation is based on statistical methods.
  • Completely redeveloped cross-platform module for document type recognition. It is now faster, more effective and uses small size descriptors.
  • Completely redeveloped cross-platform module for document location on the image. It is now faster, more functional, and reliable. Detects multiple documents on the image, fixes perspective distortion, works on any image, regardless of resolution (DPI set or not). Supports ID1, ID2, ID3, ID3x2 document formats.
  • Completely redeveloped cross platform module for OCR. It is now 2 times faster and after storage optimization symbol base is also 2 times smaller in size. Fixed a lot of issues with incorrect dates recognition (DL reverse side categories table, fffooor example).
  • Added distortion compensation for 73x8 mobile devices.
  • Greatly Improved video detection behavior for 7017 devices. Now documents are correctly detected regardless of the ambient light conditions.
  • Implemented blacklist / hitlist database checking capability after scan is performed. Database connection and query are configurable. Available by request as plugin + configuration file.
  • Export results in JSON format implemented.
  • Improved XML results export. Got rid of MSXML dependency. Fixed issue with incorrect characters presence.
  • Updated XML generation for results according to BSI TR-03135 v2.1.
  • Device label serial number field length extended to cover all available serial number types for different devices produced.
  • Database version included in Info section in XML \ JSON results.
  • Added support for .webp images format (load/save).
  • MRZ parsing added / changed for:
    • China Home Visit Permit Cards,
    • China Resident permits,
    • Serbian ID cards,
    • French Registration certificates,
    • French ID cards,
    • French Driving Licenses 2013+,
    • USA Resident cards,
    • Uruguay ID cards,
    • Croatian Driving Licenses,
    • Polish Travel documents,
    • Mexican ID cards,
    • Slovakian Driving Licenses,
    • Belarus Border Crossing Cards,
    • Germany ID cards (old edition),
    • Burundi Passports,
    • Czech ID cards,
    • Bulgarian Registration certificate.
  • Added new country codes:
    • XOM/XO – Sovereign Military Order Of Malta
    • XCT/XC – Northern Cyprus,
    • EUE/EU – European Union,
    • UNO/ZZ – United Nations,
    • RSL – Somaliland.
  • Added new barcode parser for:
    • MexicanDL,
    • Peru passport,
    • Tanzania voting card,
    • Dominican Republic passport,
    • Syrian passport barcode with support of fingerprint template extraction.
  • Struct TRegulaDeviceProperties extended with:
    • LPSTRLabelSerialNumberStr–serialnumberonlabel(string),
    • uint64_t CameraSerialNumber – camera HW serial number,
    • GUID CameraGuid - camera GUID.
  • New enum eRPRM_DeviceAdditionalFeatures member – RPRM_DeviceAdditionalFeature_IntegratedDisplay. Used for 73x8 device series.
  • New enum eRPRM_GetImage_Modes members:
    • RPRM_GetImage_Modes_DetectDocument – get document detection position,
    • RPRM_GetImage_Modes_ImageQA–makeimageQAresults(glare,focus).
  • New enum eRPRM_ResultTypes members:
    • RPRM_ResultType_DatabaseCheck–buffer=TDatabaseCheck,
    • RPRM_ResultType_FingerprintTemplateISO–buffer=bytearray,
    • RPRM_ResultType_DocumentPosition – buffer = TBoundsResult,
    • RPRM_ResultType_InputImageQuality–buffer=TImageQualityCheckList.
  • New enum eRPRM_ErrorCodes members:
    • RPRM_Error_BadDataFile – data file is absent or corrupted,
    • RPRM_Error_BadInputImage – input image has glares or out of focus.
  • New enum eImageQualityCheckType added.
  • New structure TImageQualityCheck added.
  • New structure TImageQualityCheckList added.
  • New structure TDatabaseCheck added.
  • New structure TBoundsResult added.
  • New enum eRPRM_OutputFormat members:
    • ofrFormat_JSON,
    • ofrJSON_Clipboard,
    • ofrJSON_File,
    • ofrFileBuffer_JSON_Clipboard,
    • ofrFileBuffer_JSON_File.
  • New enum eRPRM_SecurityFeatureType members:
    • SecurityFeatureType_LowContrastObject,
    • SecurityFeatureType_Photo_Color,
    • SecurityFeatureType_Photo_Shape,
    • SecurityFeatureType_Photo_Corners.
  • New enum eCheckDiagnose members:
    • chd_Photo_IsNot_Rectangle,
    • chd_Photo_Corners_Is_Wrong.
  • New enum eRPRM_Notifications members:
    • RPRM_Notification_LicenseExpired,
    • RPRM_Notification_OperationProgress,
    • RPRM_Notification_LatestAvailableSDK,
    • RPRM_Notification_LatestAvailableDatabase.
  • New enum eVisualFieldType members:
    • ft_Number_of_Card_Issuance,
    • ft_Number_of_Card_Issuance_Checksum,
    • ft_Number_of_Card_Issuance_CheckDigit,
    • ft_Century_Date_of_Birth,
    • ft_DLClassCode_A3_From,
    • ft_DLClassCode_A3_To,
    • ft_DLClassCode_A3_Notes,
    • ft_DLClassCode_C2_From,
    • ft_DLClassCode_C2_To,
    • ft_DLClassCode_C2_Notes,
    • ft_DLClassCode_B2_From,
    • ft_DLClassCode_B2_To,
    • ft_DLClassCode_B2_Notes,
    • ft_DLClassCode_D2_From,
    • ft_DLClassCode_D2_To,
    • ft_DLClassCode_D2_Notes,
    • ft_DLClassCode_B2E_From,
    • ft_DLClassCode_B2E_To,
    • ft_DLClassCode_B2E_Notes,
    • ft_DLClassCode_G_From,
    • ft_DLClassCode_G_To,
    • ft_DLClassCode_G_Notes,
    • ft_DLClassCode_J_From,
    • ft_DLClassCode_J_To,
    • ft_DLClassCode_J_Notes,
    • ft_DLClassCode_LC_From,
    • ft_DLClassCode_LC_To,
    • ft_DLClassCode_LC_Notes.
  • Typedef for NotifyFunc now have intptr_t instead of long parameters type for cross platform and cross architecture compatibility.
  • Implemented correct handling of 32-bit input images.
  • Fixed issues with incorrect MRZ recognition in some specific cases.
  • Fixed issue with exception thrown when recognizing CAN on some ID cards.
  • Fixed issue with "Age" field calculation if date of birth present in DG1 and DG11 in RFID results.
  • Fixed issue with incorrect parsing of some categories data from eDL.
  • Fixed issue with AV when RFID text data result container contains null buffer.
  • Fixed issue with incorrect comparison of full name and address between RFID and OCR in some cases.
  • Fixed issue with document number validation taken from barcode for Egypt passport.
  • Fixed issue with stored calibration data from all devices ever connected to this computer taking too much space. Now only information from last 3 connected devices remains cached on the hard drive.
  • Fixed issue with saving images in PNG format.
  • Fixed issue, when quick MRZ results sent only once on 7017.
  • Fixed issue, when quick MRZ result sent even when not enabled.
  • Fixed issue when OCR results were provided even when not licensed.
  • Fixed issue with 83x3 devices based on mainboard with 0x0902 firmware where images were with incorrect exposition (half dark).
  • Fixed memory leak when saving XML results.
  • Fixed issue when videomode switched to 1MP after internal error, when quick MRZ reading mode is enabled.
  • Improved handling of IR/IR luminescence input images, when they are supplied not in 8 bit format.
  • Fixed issue with calibration data storage if “AppData” parameter existed in HCKU\Software\Regula\Document Reader SDK but its value was empty.
  • Fixed exception when making OCR on some documents (Iran).
  • Fixed issue with no OCR results for fields with 180 degrees rotation.
  • Fixed logging of process used memory from Working Set to Private Bytes.
  • Fixed issue with loading files from Updates folder, if its path contains non latin characters.
  • Documentation updated.

RFID SDK

  • IMPORTANT! New firmware version 10.28. It is recommended to update your 10.x firmware series devices to this new version. Reading speed improved up to 30% on large datagroups. Fixed issues with reading some type A chips on 848kbps speed.
  • RFID SDK version changed to 3.4.
  • Completely redeveloped RFID SDK main library as a step to cross platform solution. All dependencies from Windows components, such as dependent COM servers usage for logging and saving graphics or XML are removed.
  • Changes in param type in RFID_Command_Scenario_Process command and value type in RFID_Notification_Scenario notification : VARIANT * -> char *.
  • Full compatibility with PACE-CAM implemented.
  • Logging mechanics was redesigned and now each log message is not saved immediately on the disk, but stored in memory. This allowed keeping the same reading times even with logs enabled.
  • New enum eRFID_DataFile_Type member dftLogData.
  • New field type ft_VRC_DataObject_Entry for eDL, DG1 – category of vehicle/restriction/condition Data Object entry.
  • New enum eRFID_OutputFormat members:
    • ofClipboard_JSON,
    • ofFile_JSON,
    • ofJSON.
  • Logs are now saved in the session file as a dftLogData root file.
  • XML representation of results now does not contain formatting (no extra tabs or spaces). This allowed to reduce results size.
  • Commands RFID_Command_Set_SynchronizedNotifications and RFID_Command_Get_SynchronizedNotifications deprecated.
  • New commands added RFID_Command_Set_Graphics_CompressionRatio and RFID_Command_Get_Graphics_CompressionRatio to control compression parameter when saving graphical results to JPEG/JPEG2000.
  • Fixed issue with using SDK from console applications without message queue, where chip detection events were sent at inappropriate moments.
  • Fixed CSCA-link certificates detection logic.
  • Fixed Active Authentication procedure (signature length and Order comparison).
  • Fixed issue with saving RFID_ResultType_RFID_BinaryData result type in XML format if reading session was interrupted at specific point.
  • Fixed issue with reparsing eDL_DG1 exception via RFID_Command_Session_LoadData_Reparse command.
  • Fixed issue with ntfLDS_Auth_SignerInfo_Certificate_RootIsNotTrusted was thrown for certificates from MasterList, DefectList even if TrustedPKD was set to true.
  • Documentation updated.

Document Reader Application

  • Added support for WEBP image format files (Load from folder, Drag & Drop).
  • Added "Touch interface" option in View tab of Options dialog. When enabled special form will be displayed with simplified interface instead of main application form with all the details.
  • Added "Help Center" menu item in "Help" menu to access our Help Center page (requires Internet connection).
  • Added possibility to send request for support to our support system right inside the application via feedback form. You have to specify your name, email and question you have. Accessible via "Contact support" menu item in "Help" menu (requires Internet connection).
  • Added possibility to send request for updates subscription renewal via feedback form (including all necessary data) right after license expiration notification is shown (requires Internet connection).
  • Added support for Papillon fingerprint scanners.
  • Added possibility to cross compare fingerprint templates from barcode with live captured (with selected licensed FP scanners).
  • Added “JSON results” option in Results tab of Options dialog.
  • Added “JSON Image results” option in Results tab of Options dialog.
  • Added possibility to apply specific parameters for RFID chip reading based on document code nd issuing country. These parameters may be stored in RegulaReader.ini file as a separate sections named [RFID_CASE_{DOC_CODE}_{COUNTRY_CODE}]. Section name may include “” as a wildcard, for more generic cases. Like [RFID_CASE_P_NLD] for all NLD passports. Each section may contain next parameters:
    • RFIDDataGroups,
    • RFIDProfilerType,
    • RFIDAuthProcType,
    • RFIDBaseSMProcedure,
    • RFIDSkipAA,
    • RFIDPassiveAuth,
    • RFIDBufferSize. Also in this section it is possible to specify period of document expiry via “DOEFrom” and “DOETo” parameters specified in MRZ format (YYMMDD) to target specific series of documents.
  • Added zooming possibility in full page image display mode (opened by double-click) by scrolling the mouse or pinch with touch screen for every image displayed in interface.
  • Added possibility to read RFID chip automatically on 7323 devices after optical scanning is finished.
  • Added possibility to toggle "Document location" processing option by Alt+L hotkey. This is useful when reprocessing scanned images.
  • Added possibility to send sample reports without connecting device. Now you may open previously saved sample from folder or drag and drop it on the form (same with single saved images) right after starting the application and then press “Report sample issue” button on the toolbar.
  • Data file with licensing information is downloaded and automatically updated every time when check for updates is performed (requires Internet access).
  • Disk free space is now checked prior to saving scanning results. If there is less than 100MB of free space left on the disk drive, results are not saved.
  • Improved modules choosing/loading mechanics from updates/install folders.
  • Fixed issue with sending sample reports, where it was impossible to send data from first attempt due to incorrect loading of OpenSSL libraries.
  • Fixed FTP proxy bypass issue for downloading updates.
  • Fixed AV when processing saved RFID session in some cases.
  • Fixed logging of process used memory from Working Set to Private Bytes.
  • Fixed a lot of small bugs and memory leaks.
  • Documentation updated.

COM

  • !Breaking сhanges! RFIDIsExpectedChipFound property has now type Variant/dynamic instead of Boolean. As this is 3 states property (True/False/Null) exception was thrown when its value was Null. Documentation updated accordingly.
  • IsNotBlackListed property added for getting whether processed document/person was not found on the hit list (dbBlacklist.dll plugin). Plugin available by request (bool, read only).
  • DoDetectDocument property added for enabling/disabling receiving result of document detection on the image. This is useful for preprocessing of the external images. If no document found on the image, no need to make any other time consuming processing of this image. Dedicated to service usage (bool, read/write).
  • DoImageQA property added to enabling/disabling making and receiving results of input images QA for glare and focus. This is useful for preprocessing of the external images. If QA not passed, no need to make any other time consuming processing of this image. Dedicated to service usage (bool, read/write).
  • JSONImageResults property added to enabling/disabling saving scanned images in JSON format (bool, read/write).
  • JSONResults property added to enabling/disabling saving document processing results in JSON format (bool, read/write).
  • DeviceCameraSerialNumber property added for getting device camera serial number (variant, read only).
  • DeviceUID property added for getting device unique ID number (variant, read only).
  • SelectedDeviceName property added for setting/getting device name to use for connection with Connect method. If you have more than one device connected to the PC at a time, you can select which one you want to connect (variant, read/write).
  • RFIDUsePKDDS property added for enabling/disabling whether DS certificate from SOD ignored and instead searched and taken from PKD (bool, read/write).
  • CheckReaderResultJSON method added for obtaining processing results in JSON format for required result type by its index. This method behaves exactly the same as CheckReaderResultXML, with only difference in return format type.
  • InBackground property "False" case implemented, that will return interface back visible if was hidden.
  • Fixed CurrentDocumentType property behavior. Now you may set / get preferred document ID as text (like "123456").

Installer

  • Added option to installer to disable certificate propagation from smart cards & smart card plug and play service to eliminate possible conflicts with Windows when accessing RFID chip. Enabled by default.
  • RFID firmware 11.x for 70x8 devices now included in the package.
  • RI.dll & CI.dll removed from the package, as they incorporated in RegulaReaderFX.dll
  • OpenCV libraries upgraded from 2.49 to 3.1. These dlls are not signed by Regula certificate anymore, as this lead to memory leak on free for unknown reason.
  • test40.exe removed from package.
  • Vocabularies data moved from database into separate file Vocabularies.dat in SDK installation folder.
  • MRZDetector.dat removed from package and incorporated into library itself.
  • Patterns.ini removed from package.
  • Regula Licensing tools are now installed together with SDK.

Database

  • Database updates now limited only to active subscribers. If your template database updates subscription (device based /software license) is expired on the date of database release, then you will not be able to use this database. In this case you have to send request for updates subscription renewal to support@regulaforensics.com. This is offered automatically in Document Reader application on license expiration.
  • Document type recognition data storage format optimized by size and completely changed. All document templates in the database were rechecked to meet new recognition module requirements. Database is not backward compatible and should be used only together with new version of RecPass.dll.
  • Authenticity checks template data format completely changed for new algorithms used and optimized by size. All document templates in the database were redefined to meet new module requirements. Database is not backward compatible and should be used only together with new version of Patterns.dll.
  • Template binding data storage format optimized by size. Database is not backward compatible and should be used only together with new version of RegDBRec.dll.
  • Updated and fixed document links to IRS databases.
  • ICAO PKD master list version 80 included.
  • BSI master list version from 13.12.2016 included.
  • 229 countries and territories / 5327 documents included.
  • 560 new documents added.
  • Description extended for 1018 documents.

Version 4.9.7 - March 18, 2016

SDK

  • 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.

RFID SDK

  • 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.
  • Documentation updated.

COM

  • 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.
  • Documentation updated.

Installer

  • OpenSSL libraries added to the package.

Database

  • 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

SDK

  • 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 eLexAnalysisDepth enum.
  • 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 eRPRM_Orientation enumerarion added.
  • New eLexAnalysisDepth enum added.
  • New text field types:
    • ft_Fast_Track,
    • ft_Owner,
    • ft_MRZ_Strings_ICAO_RFID,
    • ft_Number_of_Card_Issuance,
    • ft_Number_of_Card_Issuance_Checksum,
    • ft_Number_of_Card_Issuance_CheckDigit,
    • ft_Century_Date_of_Birth.
  • New security feature types:
    • SecurityFeatureType_Portrait_Comparison_vsCamera,
    • SecurityFeatureType_Portrait_Comparison_RFIDvsCamera,
    • SecurityFeatureType_GhostPhoto,
    • SecurityFeatureType_ClearGhostPhoto,
    • SecurityFeatureType_InvisibleObject.
  • 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:
    • transactionID(TransactionID),
    • computer name (ComputerName),
    • username(UserName).
  • Added short date format description, used to output the dates in RPRM_ResultType_OCRLexicalAnalyze result type XML representation Info section (for JavaScript usage convenience).
  • 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.
  • Documentation updated.

RFID SDK

  • 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 codes:
    • ntfLDS_Auth_MLSignerInfo_Certificate_Validity,
    • ntfLDS_Auth_MLSignerInfo_Certificate_RootIsNotTrusted,
    • ntfLDS_Auth_MLSignerInfo_Certificate_CantFindCSCA,
    • ntfLDS_Auth_MLSignerInfo_Certificate_Revoked,
    • ntfLDS_Auth_MLSignerInfo_Certificate_SignatureInvalid.
  • New notification RFID_Notification_PA_CertificateChainItem.
  • New commands:
    • RFID_Command_Set_UseExternalCSCA,
    • RFID_Command_Get_UseExternalCSCA,
    • RFID_Command_Set_UseShortFileID,
    • RFID_Command_Get_UseShortFileID.
  • 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.
  • Documentation updated.

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.
  • ShortFileID used by default when reading RFID.
  • Documentation updated.

COM

  • AsyncResultsSaving property added to enabling/disabling asynchronous results saving mode (bool, read/write).
  • 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.
  • Logging extended.
  • Documentation updated.

Installer

  • XSD schemas for all result types in XML included in installation package.

Database

  • 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

SDK

  • 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:
    • timeofresultcreation(DateTime),
    • SDKversion(SDKVersion),
    • SDKmainmoduleversion(Version),
    • activedevicetype(DeviceType),
    • 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:
    • ft_Invited_by,
    • ft_Purpose_of_Entry,
    • ft_Skin_Color,
    • ft_Complexion,
    • ft_Airport_From,
    • ft_Airport_To,
    • ft_Airline_Name,
    • ft_Airline_Name_Frequent_Flyer,
    • ft_License_Number,
    • ft_In_Tanks,
    • ft_Exept_In_Tanks.
  • Documentation updated.

RFID SDK

  • 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.
  • Documentation updated.
  • Translations updated.

COM

  • 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.
  • Documentation updated.

Database

  • 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.
  • 497 new documents added.
  • Description extended for 436 documents.

Version 4.8.6 — August 11, 2014

SDK

  • 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:
    • ft_DLClassCode_A1_From,
    • ft_DLClassCode_A1_To,
    • ft_DLClassCode_A1_Notes,
    • ft_DLClassCode_A_From,
    • ft_DLClassCode_A_To,
    • ft_DLClassCode_A_Notes,
    • ft_DLClassCode_B_From,
    • ft_DLClassCode_B_To,
    • ft_DLClassCode_B_Notes,
    • ft_DLClassCode_C1_From,
    • ft_DLClassCode_C1_To,
    • ft_DLClassCode_C1_Notes,
    • ft_DLClassCode_C_From,
    • ft_DLClassCode_C_To,
    • ft_DLClassCode_C_Notes,
    • ft_DLClassCode_D1_From,
    • ft_DLClassCode_D1_To,
    • ft_DLClassCode_D1_Notes,
    • ft_DLClassCode_D_From,
    • ft_DLClassCode_D_To,
    • ft_DLClassCode_D_Notes,
    • ft_DLClassCode_BE_From,
    • ft_DLClassCode_BE_To,
    • ft_DLClassCode_BE_Notes,
    • ft_DLClassCode_C1E_From,
    • ft_DLClassCode_C1E_To,
    • ft_DLClassCode_C1E_Notes,
    • ft_DLClassCode_CE_From,
    • ft_DLClassCode_CE_To,
    • ft_DLClassCode_CE_Notes,
    • ft_DLClassCode_D1E_From,
    • ft_DLClassCode_D1E_To,
    • ft_DLClassCode_D1E_Notes,
    • ft_DLClassCode_DE_From,
    • ft_DLClassCode_DE_To,
    • ft_DLClassCode_DE_Notes,
    • ft_DLClassCode_M_From,
    • ft_DLClassCode_M_To,
    • ft_DLClassCode_M_Notes,
    • ft_DLClassCode_L_From,
    • ft_DLClassCode_L_To,
    • ft_DLClassCode_L_Notes,
    • ft_DLClassCode_T_From,
    • ft_DLClassCode_T_To,
    • ft_DLClassCode_T_Notes,
    • ft_DLClassCode_AM_From,
    • ft_DLClassCode_AM_To,
    • ft_DLClassCode_AM_Notes,
    • ft_DLClassCode_A2_From,
    • ft_DLClassCode_A2_To,
    • ft_DLClassCode_A2_Notes,
    • ft_DLClassCode_B1_From,
    • ft_DLClassCode_B1_To,
    • ft_DLClassCode_B1_Notes,
    • ft_Surname_at_Birth,
    • ft_Civil_Status,
    • ft_Number_of_Seats,
    • ft_Number_of_Standing_Places,
    • ft_Max_Speed,
    • ft_Fuel_Type,
    • ft_EC_Environmental_Type,
    • ft_Power_Weight_Ratio,
    • ft_Max_Mass_of_Trailer_Braked,
    • ft_Max_Mass_of_Trailer_Unbraked,
    • ft_Transmission_Type,
    • ft_Trailer_Hitch,
    • ft_Accompanied_by,
    • ft_Police_District,
    • ft_First_Issue_Date,
    • ft_Payload_Capacity,
    • ft_Number_of_Axels,
    • ft_Permissible_Axle_Load,
    • ft_Precinct.
  • Documentation updated.

RFID SDK

  • 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] (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] (https://www.bsi.bund.de/SharedDocs/Downloads/EN/BSI/CSCA/GermanMasterList.html).
  • New commands added:
    • RFID_Command_Set_SynchronizedNotifications,
    • RFID_Command_Get_SynchronizedNotifications.
  • New error codes added:
    • errLDS_PACE_CAM_Data_Incorrect,
    • errLDS_PACE_CAM_Data_CantVerify,
    • errLDS_PACE_CAM_Data_NonMatching,
    • errLDS_PACE_IM_Scheme_Incorrect,
    • errLDS_PACE_IM_RandomMapping_Failed.
  • New notification codes added:
    • ntfLDS_ICAO_Certificate_Ext_SubjectAltName_Info_Missed,
    • ntfLDS_ICAO_Certificate_Ext_IssuerAltName_Info_Missed,
    • ntfLDS_ICAO_Certificate_Ext_SubjectAltName_Critical,
    • ntfLDS_ICAO_Certificate_Ext_IssuerAltName_Critical,
    • ntfLDS_ICAO_Certificate_SN_NonCompliant,
    • ntfLDS_ICAO_Certificate_Issuer_SN_NonCompliant,
    • ntfLDS_ICAO_Certificate_Subject_SN_NonCompliant,
    • ntfLDS_ICAO_Certificate_Issuer_AttributeNonCompliant,
    • ntfLDS_ICAO_Certificate_Subject_AttributeNonCompliant,
    • ntfLDS_ICAO_Certificate_IssuerSubject_Country_NonMatching,
    • ntfLDS_ICAO_Certificate_Ext_CSCA_AltNames_NonMatching,
    • ntfLDS_ICAO_Certificate_Ext_NameChange_IncorrectData,
    • ntfLDS_ICAO_Certificate_Ext_NameChange_NonCompliant,
    • ntfLDS_ICAO_Certificate_Ext_NameChange_Critical,
    • ntfLDS_ICAO_Certificate_Ext_DocTypeList_NonCompliant,
    • ntfLDS_ICAO_Certificate_Ext_DocTypeList_Critical,
    • ntfLDS_ICAO_Certificate_Ext_Optional_Critical,
    • ntfLDS_SI_Storage_PACEInfos_NonConsistant.
  • New notification for callback added:
    • RFID_Notification_Biometrics_EmptyPlaceholder.
  • Documentation updated.

Document Reader Application

  • 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.
  • Translations updated.

COM

  • 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.
  • Documentation updated.

Database

  • Template database is now available in next versions:
    • All world documents (not including DL & ID for USA & CAN)
    • DocumentsfromUSA&CAN(DL&ID)
    • 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

SDK

  • 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 fields added ft_Electronic_Ticket_Indicator, ft_Compartment_Code, ft_CheckIn_Sequence_Number, ft_Airline_Designator_of_boarding_pass_issuer, ft_Airline_Numeric_Code, ft_Ticket_Number, ft_Frequent_Flyer_Airline_Designator, ft_Frequent_Flyer_Number, ft_Free_Baggage_Allowance, ft_PDF417Codec, ft_Identity_Card_Number_Checksum, ft_Identity_Card_Number_CheckDigit, ft_Veteran.
  • 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.
  • Documentation updated.

RFID SDK

  • IMPORTANT! New driver version 7.0.3.2 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.
  • Documentation updated.

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.
  • Translations updated.

COM

  • 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.

Database

  • 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

RFID SDK

  • IMPORTANT! New driver version 7.0.1.9
  • 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.

Installer

  • 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

SDK

  • 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.

RFID SDK

  • 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.
  • Translations updated.

COM

  • 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.

Database

  • 198 countries and territories / 1892 documents included
  • 26 new documents added
  • Description extended for 18 documents

Version 4.8.1 — July 8, 2013

SDK

  • 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.

RFID SDK

  • 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

COM

  • 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

Database

  • 196 countries and territories /1868 documents included
  • 139 new documents added
  • Description extended for 416 documents

Version 4.7.1 — March 8, 2012

SDK

  • New camera driver on modern KMDF version 10.1.0.1 included
  • New 5MP camera support
  • New CI.dll library added to the package for support of devices on the new driver (only for devices on Micron S camera and newer)
  • Calibration data storage format changed for new driver interface. It is required to recalibrate the device
  • Calibration data storage format version is now explicitly stored in camera EEPROM and verified for compatibility
  • Videochip frequency divider parameter now determined automatically, depending on the PC hardware, and no need to set it from the user application (new driver only)
  • Regula Document Reader device now can be found in Forensic Devices group in Device manager
  • ACPI parameters control module changed. Now when reader connected, system might not set the processor to the C1 and C2 states, both on AC power and on batteries (Windows 7 and up)
  • Full-page document presence video detection mode improved. Now detection works even with the cover open independent of outside lighting conditions
  • All file and path names passed into functions as parameters should be in UTF8
  • Fixed issue with writing incorrect image size in image header for Image and EtalonImage elements for RPRM_Authenticity_Image_Pattern check of the RPRM_ResultType_Authenticity result type
  • Fixed issue with returning all images, not only selected in ResultTypeAvailable and CheckResult functions
  • Cognitec FaceVACS-SDK support implemented natively for face comparison (Visual<->RFID, Visual<->Ghost, Ghost<->RFID). Consolidated result provided in RPRM_ResultType_Authenticity result type in RPRM_Authenticity_Portrait_Comparison check. Provided by request, not included in SDK by default. Cognitec license required for using this
  • Document type identification optimized by speed and adapted for multipage document processing
  • New filters added for document type identification – barcode and magnetic stripe presence
  • 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.7.1 and above.
  • Data loading for document type recognition improved
  • Barcode location module now optimized to work with images from scanners, that may stretch image horizontally
  • Columbia ID card barcode format is now supported by barcode parser
  • Magnetic stripe data parser updated according to AAMVA 2012
  • ft_Address field generation from barcode data has been changed for US/CAN DL/ID
  • Face detection module optimized for speed and better detection of faces of different races
  • New MRZ filling formats added: ID1_Card_COL, ID1_EDL_USA_CAN
  • Symbols with poor probability in MRZ will be recognized again using full symbol database
  • New text field types added: ft_CCW_Until, ft_Reference_Number_Checksum, ft_Reference_Number_CheckDigit
  • When connecting the device with document inserted device will beep
  • Logging is now done in UTF8
  • All result types in XML will now contain index of the page, from which this result was received
  • RPRM_ResultType_Authenticity result type in XML format will contain images of the elements in CDATA block (encoded with Base64) and also graphic format type and size
  • Fixed issue with processing external images with incorrect resolution set

RFID SDK

  • New driver version 6.2.6.2
  • New firmware versions for RFID reader included 5.24 & 10.08 (for different hardware versions). If you have version 5.x installed in the device, then you need to update it to 5.24. If you have 10.x installed, then you need to update it to 10.08. Update is required for correct operation with new driver
  • Device has new name in Device manager – Regula RFID Reader
  • Fixed issue in driver, when chip is answering with “wait” request, but driver drops the connection by default timeout (brute force MRZ attack protection case)
  • Chip presence detection algorithm changed, that solved the issue with repetitive detections of type A chips
  • Fixed issue with CA (version 1) for SAC with AES
  • All file and path names passed into functions as parameters should be in UTF8
  • Logging is now done in UTF8
  • RFIDTest3.exe – RSrvMngr4x dependency removed
  • RFIDTest3.exe – when “always asking for chip key” mode is enabled and BAC/PACE failed after entering the key, chip key is not requested again

Document Reader Application

  • «Save only incorrect scans» option added
  • MIFARE chip data is now displayed correctly after processing
  • All file and folder paths in UNICODE now processed correctly
  • All saved results in RecentResultFolder are now properly cleared

COM

  • CurrentResultsFolder property added, that returns path where the last scan results were saved
  • SaveOnlyIncorrectScans property added, that enable (works together with SaveImages only) saving processing results only for documents, that raised any kind of warnings or errors during processing
  • AppendImage method added, that allow send external image into the COM server as a byte array for further processing. Light index, page index and graphical format of the image can be passed as params
  • GetReaderBitmapImageByLightIndexAndPageIndex method added, that allow to get scanned image as a byte array in .BMP graphical format with particular light index and page index
  • GetReaderEOSBitmapImageByLightIndexAndPageIndex method added, that allow to get scanned image from high resolution scanner as a byte array in .BMP graphical format with particular light index and page index
  • GetReaderFileImageByLightIndexAndPageIndex method added, that allow to get scanned image as a byte array in selected graphical format with particular light index and page index
  • PagesCount property added, that return a number of available pages with results
  • Fixed issue, that occur after COM client connect and disconnect to the COM server and after continue processing documents

Database

  • 191 country /1744 documents included
  • 15 new documents added
  • Description extended for 129 documents

Installer

  • SDK code samples extracted into separate feature that might not be installed
  • SDK code samples folder is changed. Now they are all placed into the Regula\Samples folder by default

Version 4.6.4 — November 24, 2012

SDK

  • Added TWAIN driver
  • Added IATA boarding passes 2D barcode parsing
  • Added IATA boarding passes date validation
  • Added age field in RPRM_ResultType_OCRLexicalAnalyze result (generated)
  • Added text parsing for 1D barcode fields (personally described for some documents with custom 1D data format available)
  • Added eyes color and hair color translation for correct comparison
  • Added new text field types
  • Added new graphic field types
  • Added RPRM_Notification_LidOpen notification
  • Added new command RPRM_Command_Device_Get_Calibration_FrequencyDivider
  • Added RFID SOD DV certificate issuer code with MRZ issuer code comparison
  • Changed Barcode reading order is now performed before Visual OCR
  • Changed MRZ fields "Other" to "Optional data"\"Line X optional data"
  • Fixed MRZ vs. RFID field comparison from flexible to 1:1
  • Fixed Fibers (RPRM_Authenticity_UV_Fibers) check issue with too bright images lead to incorrect fibers detection
  • Fixed IR visibility (RPRM_Authenticity_IR_Visibility) check issue with dark non-contrast object detected as invisible
  • Fixed Image pattern (RPRM_Authenticity_Image_Pattern) check issue when no UV image is present
  • Fixed Middle name parsing for 2D barcodes (AAMVA)
  • Fixed dates translation for 2D barcodes (AAMVA)
  • Fixed issue with light management in devices with optical firmware 0x2503
  • Fixed USB/PCI Express power management issues that lead to non-stable work of the camera
  • Fixed memory corruption issue with image compensation under some special circumstances

Document Reader Application

  • Video frequency divider now automatically set to precalibrated value. It still may be changed, but will be saved only after calibration
  • AutoConnect option now works always if set, not only on application start
  • "Connect", "Disconnect" and "Options" commands are duplicated in tray icon popup menu
  • Options dialog now always on top
  • Custom antenna parameters for RFID firmware 10.XX added in configuration file

COM

  • DeviceSerialNumber property added returns camera serial number

Database

  • Ghost photos described in all containing documents
  • 191 country /1732 documents included
  • 64 new documents added
  • Description extended for 129 documents

Version 4.6.3 — October 30, 2012

Document Reader Application

  • Fixed issue with folder names when saving results
  • Fixed issue with printing results report

Version 4.6.2 — September 12, 2012

SDK

  • Fixed issue with document location on the image, when document was cut incorrectly in some cases
  • Fixed memory leak issue when parsing barcodes

RFID SDK:

  • CHR is now passed in CAR field on step 2 in TTerminalAuthenticationStepData
  • Document Signer (DS) certificate properties exposed as text fields in RFID_ResultType_RFID_TextData

Document Reader Application

  • Fixed issue with images rotation
  • Fixed issue with saving images and RFID data into separate folders
  • Fixed issue with AutoScan property switching to false after manually reading RFID
  • Translations updated

COM

  • GetTextFieldByTypeAndLCID method added
  • GetTextFieldByTypeAndSource parameters list changed LCID added

Database

  • New documents added, description and FDS linkage updated for existing documents

Installer:

  • Fixed Windows 8 issue with smartcard service start

Version 4.6.1 — August 16, 2012

SDK

  • New document type recognition module version introduced, that made significant improvement to recognition probability
  • Added multi-page processing possibility for documents. Document with dependent child pages is now processed as one
  • Added complex textual verification and comparison for multi-page documents
  • Added complex authenticity check for multi-page documents
  • Added possibility to process together document + visa to match them
  • Added glare compensation mode (reflection removal) for visible and IR images
  • Added possibility to parse 2D barcodes from driver's licenses according to AAMVA
  • Added possibility to parse magnetic stripe data from driver's licenses according to AAMVA
  • Added possibility to cross compare magnetic stripe parsed text data as MRZ data in Textual comparison result (RPRM_ResultType_OCRLexicalAnalyze)
  • Added possibility to control document video detection depending on document format (any / predefined in configuration)
  • Calibration algorithm has been changed. Device should be recalibrated for use with this SDK version
  • Calibration process now may be cancelled
  • Fixed issue with devices enumeration on Windows 7 that may block device connection
  • IR Visibility (RPRM_Authenticity_IR_Visibility) check results are now presented with different structure (TSecurityFeatureCheck -> TIdentResult)
  • Overall stability improved
  • A lot of minor changes and bug fixes

RFID SDK

  • Certified by BSI for PACE/SAC EAC 2.0 version of RFID SDK included
  • Added possibility to set trust option for certificates in PKD folder (RFID_Command_Set_TrustedPKD)

Document Reader Application

  • User interface has been changed to reflect multi-page document processing
  • Added possibility to skip RFID reading attempt if no MRZ found on the document page
  • Added document type recognition check, that have influence on the final document result status
  • Added possibility to load images of multiple document pages from disk for processing at once
  • Added button "Fast settings" in Options dialog for setting speed optimized settings
  • Added automatic check of new SDK version availability (optional, can be disabled)
  • Added automatic error reporting (optional, can be disabled)
  • Threading model has been changed now one thread is used instead of opening/closing new thread for each scan
  • LED is not controlled any more when processing images without scanning

COM

  • SeparateOpticalReading boolean property added. If set to True, then RFID reading will not be performed together with optical reading
  • Events added to interface, so client application may subcribe for needed events and get the results and notifications immediately
  • OnProcessingFinished event added
  • OnNotificationOptical event added (duplicating NotifyFunc SDK callback)
  • OnNotificationRFID event added (duplicating RFID_NotifyFunc RFID SDK callback)
  • OnResultReady event added (duplicating ResultReceivingFunc SDK callback)
  • OnPassiveAuthentication event added (to perform online Passive Authentication passing the user certificates)
  • OnTerminalAuthentication event added (to perform online Terminal Authentication passing the user certificates)
  • GlareCompensation property added (boolean)
  • DetectAnyDocFormat property added (boolean)
  • SeparateOpticalReading property added (boolean)
  • RFIDReadWithoutMRZ property added (boolean)
  • RFIDTrustPKD property added (boolean)
  • MultiPageProcessing property added (boolean)
  • IsDocumentRecognized property added (boolean/readonly)
  • CheckStatusSecurityComplex property added (variant/readonly)
  • PA_DS_Certificate property added (variant)
  • PA_CSCA_Certificate property added (variant)
  • TA_CVCA_Link_Certificate property added (variant)
  • TA_DV_Certificate property added (variant)
  • TA_IS_Certificate property added (variant)
  • TA_IS_PrivateKey property added (variant)
  • TA_ChipSignature property added (variant)
  • DoProcessImage method added for processing one single image from file on the disk
  • RFIDCancelReading method added for cancelling current RFID read operation

Database:

  • New documents added

Version 4.5.7 — March 13, 2012

SDK:

  • Fixed document identification issue when document has child documents
  • Fixed issue with reflection in IR visibility module
  • Fixed calibration issue with devices without UV

RFID SDK:

  • RFID.h file changed: new notification, error codes and new structures implemented
  • Fixed RFIDtest2.exe issue when reading smartcards
  • Minor fixes

Drivers

  • Added device metadata (image) for RFID reader driver
  • Document Reader Application:
  • Added possibility of full-screen display of scanned image (double-click)
  • Translations added

COM:

  • Added GetTextFieldByType method to get the field text value by its name
  • Added GetMRZLines method to get MRZ lines text
  • Added GetRFIDDGRawData method to get raw binary data of RFID chip datagroup

Version 4.5.6 — January 31, 2012

SDK

  • Support for new device types (7XX7, 7XX3 series 3MP)
  • Face detection algorithm implemented (correct photo cropping even for unknown documents)
  • Document images rotation by photo orientation implemented
  • Improved document presence video detection algorithm
  • Improved document position on the image detection algorithm
  • Improved calibration algorithm (UV image calibration added)
  • Improved performance of security check processing
  • Improved performance of device connection process
  • Improved algorithms for security features checks
  • Overall stability improved
  • Lot of minor changes and bug fixes implemented.

RFID SDK

  • New version of RFID SDK included

Drivers

  • New device drivers supporting USB 3.0

Document Reader Application

  • Interface has been improved and extended

COM

  • COM server interface has been extended

Database

  • Updated and extended templates database included (185 countries and territories / 1554 documents included)
Back to top