Skip to content

Document Reader SDK 4.10: Release Notes

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