Skip to content

Document Reader SDK 4.12: Release Notes

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.
Back to top