Skip to content

Releases: BlinkID/blinkid-react-native

v7.5.0

23 Sep 11:29
fe51ff7
Compare
Choose a tag to compare

What's New

  • We introduced event tracking across the SDK lifecycle, giving you deeper insights into user journeys, success rates, and drop-off points during scanning sessions. These enhanced analytics make it easier to identify optimization opportunities and ensure the best possible user experience.
  • Updated detection analysis logic in case of photo mode
  • Added new parsed result member to the BarcodeResult which indicates whether the raw barcode data was successfully parsed
  • Barcode recognition is now allowed on all document classes; unparsable barcodes will be returned as raw data

v7.4.0

24 Jul 08:54
83e8638
Compare
Choose a tag to compare

What's new

  • Improved extraction for Canada/Nunavut ID and DL by introducing error correction for "1" and "I" characters which look the same in the font used on a document

New Documents Support

  • Canada, Newfoundland And Labrador - Identity Card
  • Canada, Northwest Territories - Driver's License
  • Canada, Northwest Territories - Identity Card
  • Canada, Prince Edward Island - Identity Card
  • Canada, Yukon - Identity Card
  • Canada, Nunavut - Driver's License
  • Canada, Nunavut - Identity Card
  • Liberia - Identity Card
  • Mali - Identity Card
  • UK - Military ID

New Document Versions for Supported Documents

  • Bahrain - Identity Card
  • Canada, Yukon - Driver's License
  • Canada - Weapon Permit
  • Chile - Alien ID
  • Chile - Identity Card
  • Finland - Driver's License
  • Indonesia - Driver's License
  • Kosovo - Identity Card
  • Latvia - Polycarbonate Passport
  • Mexico, Chiapas - Driver's License
  • Mexico, Ciudad de Mexico - Driver's License
  • Mexico, Durango - Driver's License
  • Mexico, Jalisco - Driver's License
  • Sri Lanka - Driver's License
  • USA, Alaska - Driver's License
  • USA, New Hampshire - Driver's License
  • European Union - Health Insurance Card

New Beta Documents Support

  • Canada - Non Card Tribal ID
  • Dominica - Paper Passport
  • Dominica - Polycarbonate Passport
  • UAE - Diplomatic ID
  • USA, Georgia - Medical Marijuana ID

New Document Versions for Beta-Supported Documents

  • Egypt - Driver's License
  • Mexico, Quintana Roo - Driver's License
  • Philippines - Postal ID
  • Vietnam - Identity Card

New Segments Supported on Documents

  • European Union, Health Insurance Card - countryCode
  • Italy, Identity Card - documentOptionalAdditionalNumber
  • France, Identity Card - additionalNameInformation
  • UK, Asylum Request - residencePermitType, remarks
  • UK, Residence Permit - residencePermitType, remarks, certificateNumber, nationalInsuranceNumber

Bug fixes

  • Fixed issue with incorrect DriverLicenseDetailedInfo serialization

v7.2.0

17 Jun 07:12
5d71908
Compare
Choose a tag to compare

The version 7 release of the BlinkID SDK.

Breaking changes

  • Starting with BlinkID v7, the NPM package has been renamed and moved from blinkid-react-native to @microblink/blinkid-react-native to improve organization and maintainability.

    • The old package blinkid-react-native is now deprecated and will no longer receive updates. To continue using the latest BlinkID features and improvements, please install the new package:
        npm install @microblink/blinkid-react-native
  • BlinkID v7 is now fully written in TypeScript for improved type safety and developer experience.

  • The plugin now requires:

    • iOS version 16.0 and above.
    • Android API version 24 and above.
  • Method scanWithCamera has been renamed to performScan.

  • Method scanWithDirectApi has been renamed to performDirectApiScan.

  • Many of the older settings have been renamed to be more intuitive, for more information see the blinkIdSettings.ts and types.ts files, and the native documentation for Android and iOS.

  • See section Version 7 plugin usage for more details about how to use each method, and how to handle the scanned results.

Version 7 plugin usage

The performScan method

The performScan method launches the BlinkID scanning process with the default UX properties.
It takes the following parameters:

  1. BlinkID SDK settings
  2. BlinkID session settings
  3. The optional BlinkID UI settings
  4. The optional ClassFilter object for filtering documents.

BlinkID SDK Settings - BlinkIdSdkSettings: the class that contains all of the available SDK settings. It contains settings for the license key, and how the models, that the SDK needs for the scanning process, should be obtained.

BlinkID Session Settings - BlinkIdSessionSettings: the class that contains various settings for the scanning session. It contains the settings for the ScanningMode and BlinkIdScanningSettings, which define various parameters that control the scanning process.

BlinkID UI Settings - BlinkIdUiSettings: the class that allows customization of various aspects of the UI used during the scanning process.

The optional ClassFilter class - ClassFilter: the class which controls which documents will be accepted or reject for information extraction during the scanning session.

  • The implementation of the performScan method can be viewed here in the index.tsx file.

The performDirectApiScanning method

The performDirectApiScan method launches the BlinkID scanning process inteded for information extraction from static images.
It takes the following parameters:

  1. BlinkID SDK settings
  2. BlinkID session settings
  3. First image string in the Base64 format
  4. The optional second image string in the Base64 format

BlinkID SDK Settings - BlinkIdSdkSettings: the class that contains all of the available SDK settings. It contains settings for the license key, and how the models, that the SDK needs for the scanning process, should be obtained.

BlinkID Session Settings - BlinkIdSessionSettings: the class that contains various settings for the scanning session. It contains the settings for the [ScanningMode] and [BlinkIdScanningSettings], which define various parameters that control the scanning process.

The first image Base64 string - string: image that represents one side of the document. If the document contains two sides and the ScanningMode is set to automatic, this should contain the image of the front side of the document. In case the ScanningMode is set to single, it can be either the front or the back side of the document. If the document contains only one side (for example, various passports), the SDK will automatically detect it, and will not look for the other side.

The optional second image Base64 string - string: needed if the information from back side of the document is required and the ScanningMode is set to automatic.

  • The implementation of the performDirectApiScan method can be viewed here in the index.tsx file.
  • All of the mentioned settings can be found in the blinkIdSettings.ts file.

BlinkID result

  • Both methods return the BlinkIdScanningResult object, which contains the results of scanning a document, including the extracted data and images from the document.

  • All of the available results can be viewed in blinkIdResult.ts and types.ts.

Implementation guide

  • A detailed guide about the integration and usage of the plugin can be viewed here.
  • The sample application which demonstrates the usage of the SDK can be found in the App.tsx file.

v6.13.1

10 Jan 13:24
c6b53a7
Compare
Choose a tag to compare
  • Android-specific
    • Fixed naming of the deprecated LegacyDocumentVerificationActivity in AndroidManifest.xml

v6.13.0

03 Jan 15:25
f55feee
Compare
Choose a tag to compare

New features

  • ClassFilter
    • ClassFilter represents the document filter used to determine which documents will be processed.
    • Document information (Country, Region, Type) is evaluated with the content set in the filter, and their inclusion or exclusion depends on the defined rules.
    • The recognition results of the excluded documents will not be returned.
    • If using the standard BlinkID Overlay, an alert will be displayed that the document will not be scanned.
    • Modifying the includeClasses property will set the filter to scan only the set document classes. Other document classes will be rejected.
    • Modifying the excludeClasses property will set the filter to reject only the set document classes. Other document classes will be accepted.
      • By defult, all of the document classes are accepted.

Expanded document coverage

  • All of the new documents & document versions can also be found in the release notes for native Android and iOS SDKs.

Bug fixes

  • NY ID/DL: Added logic to expose the Enhanced document subtype, allowing customers to distinguish between regular and enhanced versions.
  • Bolivia & Namibia ID: Resolved data match inconsistencies that were causing data match failures.
  • Romanian ID: Multi side scan no longer expects blank back card of old IDs, even with skipUnsupportedBack set to false.
  • Fixed backImageAnalysisResult.cardRotation not being correctly populated when scanning the wrong side of a document.
  • [iOS-specific] Fixed document flip animation on the BlinkIdOverlay

v6.12.0

14 Nov 14:56
3bbf2e5
Compare
Choose a tag to compare

New features

  • Beta Feature: Second Page Passport Scanning
    • Added support for scanning and extracting data from the second page of passports for select countries - Slovenia, Ireland, and New Zealand.
    • When BlinkID detects one of these passports, a UI message will guide the user to the second page.
    • By default, this feature is disabled but can be enabled via the BlinkIdMultiSideRecognizer.scanPassportDataPageOnly setting - if set to false, it will be required to scan the second page of certain passports. This feature is in beta, and your feedback is appreciated.
  • USA Green Card - Enabled Data Match for the Document Number field, matching values from the VIZ (Visual Inspection Zone) and MRZ to further enhance extraction reliability.

Bug fixes

  • Spain ID: Fixed an issue with indefinite expiry dates, ensuring consistent values between the MRZ and Visual Inspection Zone (VIZ).
  • Bulgaria ID: Improved parsing for indefinite expiry dates in the MRZ for better accuracy.
  • Netherlands ID & Norway Passport: Resolved issues with the Personal ID number field that were causing the data match feature to fail.
  • Chinese Passport: Enhanced reliability of extracted data with additional logic for the Document Number field.
  • German ID & Luxembourg ID: Adjusted name extraction logic to resolve issues with name separation, ensuring more consistent results.

v6.11.1

23 Oct 11:26
bc16bab
Compare
Choose a tag to compare

Bug fixes

  • NYC Municipal ID & USA Border Crossing Card
    • Resolved an issue where the scanning process could get stuck on the back side during multi-side scanning.

v6.11.0

14 Oct 13:50
cb8dee7
Compare
Choose a tag to compare

Expanded document coverage

  • All of the new documents & document versions can also be found in the release notes for native Android and iOS SDKs.

New features

  • Greek Alphabet Support
    • Added support for extracting Place of Birth in both Greek and Latin scripts.
  • New result fields in the BlinkIdSingleSideRecognizer and BlinkIdMultiSideRecognizer
    • manufacturingYearvehicleTypeeligibilityCategoryspecificDocumentValiditydependentsInfo

Bug fixes

  • Android specific
    • Removed unused libc++_shared.so from the SDK
    • Fix for duplicate attrs resource: attr/mb_onboardingImageColor when combining multiple Microblink's SDKs in the same app
    • Raised minSdkVersion to 23 to support React-Native v0.75

v6.10.0

13 Sep 13:17
e4776ec
Compare
Choose a tag to compare

Expanded document coverage

  • All of the new documents & document versions can also be found in the release notes for native Android and iOS SDKs.

New features

  • Avoiding Double Scans of the Front Side: For a more reliable scanning process, BlinkID now prompts users to flip the document when they scan the front side twice. This improves the overall experience and reduces the chance of mistakes.
  • Starting with the Right Side: If users attempt to scan the back side of a document first, BlinkID will prompt them to begin with the front side. This feature ensures that users follow the correct order, leading to a more reliable and user-friendly experience.
  • Added imageExtractionFailures to AdditionalProcessingInfo
    • imageExtractionFailures allows tracking if any images are not visible on the presented document
    • Added  ImageExtractionType (FullDocumentFaceSignature) enum to specify the image type
  • Added a new result member, barcodeStepUsed to BlinkID recognizers, which indicates whether the barcode scanning step was utilized during the scanning process.
  • Added two new settings to BlinkID recognizers:
    • allowBarcodeScanOnly - allows barcode recognition to proceed even if the initial extraction fails - set to false by default
    • combineFrameResults - enables the aggregation of data from multiple frames - set to true by default

v6.9.0

19 Jul 13:39
a030b88
Compare
Choose a tag to compare

Expanded document coverage

  • All of the new documents & document versions can also be seen in the release notes for native Android and iOS SDKs.

Custom mandatory fields

  • We’re introducing the option to define a custom set of mandatory fields. This feature allows greater flexibility in the scanning process by enabling the extraction of only the necessary information from identity documents.
  • Custom mandatory fields can be set at the document level or applied universally to all document types.
  • Custom mandatory fields can be set with CustomClassRules and DetailedFieldType.

Glare and blur detection

  • We’ve introduced glare detection to BlinkID, which removes occlusion on document images caused by glare.
  • We’ve raised the threshold for our blur model, making it stricter. This improvement ensures that sharper images are accepted for processing.
    • To disable the glare and blur filters, modify the enableBlurFilter and enableGlareFilter properties on the BlinkID recognizers (filters are enabled by default).
    • The strictness level can be modified to Strict, Normal and Relaxed on the glareStrictnessLevel and blurStrictnessLevel properties with StrictnessLevel.
    • To check if glare and blur are present on the document after the scanning process has finished, see glareDetected and blurDetected properties in ImageAnalysisResult.

UI Settings

  • Real-time feedback during scanning includes a new UI message to help users position the document correctly and reduce glare and blur.
    • Check errorGlareDetected and errorBlurDetected in the BlinkIdOverlaySettings.
  • We have added camera presets to each platform
    • Modify AndroidCameraResolutionPreset and iOSCameraResolutionPreset in BlinkIdOverlaySettings to change different to camera resolutions if necessary.
  • Camera Legacy API - Android-specific
    • We have added enableAndroidLegacyCameraApi property. This setting should only be used if the new Camera2 API is not working on the device, and it should not be applied to all devices.