Skip to content

Document Reader SDK 4.11: Release Notes

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