blinkid_flutter 7.6.0 copy "blinkid_flutter: ^7.6.0" to clipboard
blinkid_flutter: ^7.6.0 copied to clipboard

Published 5 days ago • verified publishermicroblink.com
SDKFlutter
PlatformAndroidiOS
→

Metadata

Flutter plugin for BlinkID, SDK for scanning and OCR of various identity documents.

More...

7.6.0 #

What's New #

  • Added two new methods in BlinkidFlutter: loadBlinkIdSdk & unloadBlinkIdSdk
    • loadBlinkIdSdk - Initializes and loads the BlinkID SDK if it is not already loaded. This method can be called in advance to preload the SDK before starting a scanning session. Doing so reduces loading time for the performScan and performDirectApiScan methods since all resources will already be available and the license verified.
    • unloadBlinkIdSdk - Terminates the BlinkID SDK and releases all associated resources. This method safely shuts down the SDK instance and frees any allocated memory. If the parameter deleteCachedResources is set to true, the method performs a complete cleanup, including deletion of all downloaded and cached SDK resources from the device.
  • You can now configure the SDK to load resources locally instead of downloading them. Set downloadResources to false, and provide the local resource path using resourceLocalFolder (Android) and bundleIdentifier (iOS).
  • Added support for capturing the back of US and India passports that feature a barcode
  • Prevent parsing of two-line MRZ in TD1 format unless it's explicitly allowed. This will prevent false positive MRZ extraction on documents where the last line of the MRZ is covered or not fully visible

New Documents Support #

  • Angola - Paper Passport
  • Bahrain - Polycarbonate Passport
  • Burkina Faso - Polycarbonate Passport
  • Cameroon - Driver's License
  • Canada, Manitoba - Metis Federation Card
  • East Timor - Polycarbonate Passport
  • El Salvador - Paper Passport
  • Eritrea - Paper Passport
  • France - Adr Certificate
  • Germany - Adr Certificate
  • Ghana - Voter ID
  • India, Telangana - Driver's License
  • Ivory Coast - Paper Passport
  • Japan - Polycarbonate Passport
  • Liberia - Paper Passport
  • Liberia - Voter ID
  • Malawi - Identity Card
  • Malawi - Paper Passport
  • Maldives - Polycarbonate Passport
  • Mali - Paper Passport
  • Mauritius - Paper Passport
  • Oman - Vehicle Registration
  • Paraguay - Polycarbonate Passport
  • Rwanda - Driver's License
  • Senegal - Driver's License
  • Sierra Leone - Paper Passport
  • Somalia - Paper Passport
  • Switzerland - Adr Certificate
  • Togo - Driver's License
  • Togo - Paper Passport
  • USA, Maryland - Medical Marijuana ID
  • Vietnam - Paper Passport

New Document Versions for Supported Documents

  • Chile - Polycarbonate Passport
  • India - Paper Passport
  • Moldova - Identity Card
  • Pakistan - Identity Card
  • Peru - Identity Card
  • Romania - Identity Card
  • Slovakia - Identity Card
  • USA, California - Driver's License
  • USA, California - Identity Card
  • USA, New Hampshire - Identity Card
  • USA, Georgia - Medical Marijuana ID
  • USA, Pennsylvania - Medical Marijuana ID
  • USA, South Carolina - Driver's License
  • USA, South Carolina - Identity Card
  • USA, Texas - Driver's License
  • USA, Texas - Identity Card
New Segments Supported on Documents
  • Switzerland, Residence Permit - dateOfEntry
  • Hungary, Identity Card - maidenName, nationality, sexOrGender, documentNumber, dateOfBirth
  • Greece, Identity Card - fathersName (Latin and Greek), mothersName (Latin and Greek), personalIdNumber, issuingAuthority (Greek), municipalityOfRegistration (Greek)
  • Mexico, Voter ID - sectionCode, stateCode, municipalityCode, localityCode
  • Mexico, Consular Voter ID - stateCode, stateName
Renamed segments
  • Hungary - Identity Card - additionalNameInformation -> mothersName

New languages #

  • Added 33 new languages (see full list here)

Breaking changes #

  • Renamed the bundleURL to bundleIdentifier in BlinkIdSdkSettings.
  • Renamed BlinkIdUiSettings to BlinkIdScanningUxSettings.

Native platform changes #

iOS

  • The SDK was built with Xcode 26

Android

  • Updated Kotlin to v2.0.21 in the blinkid-core library. The blinkid-ux and microblink-ux libraries already used Kotlin v2.1.20.
  • Target SDK updated to API Level 36

Bugfixes #

  • Users are no longer forced to scan back sides of Alien and Refugee passports
  • Fixed the issue with Togo ID where document number from VIZ was overriden by a wrong value from MRZ

Other changes #

  • Changed default tiltDetectionLevel from Off to Mid

7.5.0 #

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

Bugfixes #

  • Fixed crash when the optional BlinkIdUiSettings parameter was not being passed to the performScan method.

7.4.0 #

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

New Document Versions for Supported Documents

  • Canada, Yukon - Driver's License

Bug fixes

  • Fixed issue with incorrect DriverLicenseDetailedInfo serialization

v7.4.0 #

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

New Document Versions for Supported Documents

  • Canada, Yukon - Driver's License

Bug fixes

  • Fixed issue with incorrect DriverLicenseDetailedInfo serialization

7.3.0 #

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
  • Added BlinkIdUiSettings for customizing various aspects of the UI used during the scanning process

New Documents Support

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

Renamed segments

  • Bahrain - Identity Card - documentNumber -> personalIdNumber

Bugs and fixes #

  • Fixed document number extraction from Canada/Nunavut barcodes
  • Fix for ARGENTINA ID and ALIEN_ID documents - made separate barcode scanning step optional for these documents; they have a barcode on the front side, and requiring barcode extraction was causing the scanning process to get stuck on the front
  • Fixed issue with DateResult where day, month and year were not properly returned

iOS-specific

  • Fixed issue with adding customDocumentRules in BlinkIdScanningSettings

7.2.0 #

The version 7 release of the BlinkID SDK.

Breaking changes #

  • The plugin now requires:

    • iOS version 16.0 and above.
    • Android API version 24 and above.
    • Flutter version 3.29 and above.

  • Class MicroblinkScanner has been renamed to BlinkidFlutter.

  • 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 blinkid_settings.dart file, 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 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.

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

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.

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

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 main.dart file.

6.1.2 #

  • Fixed date and documentDataMatch errors

6.1.1 #

6.1.0 #

5.8.1 #

  • Fixed documentDataMatch serialization.

5.8.0 #

5.7.1 #

Major bug fix: #

  • This version fixes bug introduced in v5.7.0 which could cause SDK crash on applicationDidBecomeActive event.

5.7.0 #

Plugin changes #

  • We changed the way BlinkID plugin is registered in Android so it no longer requires changing MainActivity. This fixes Issue #2 and Issue #5.

New features #

  • We translated complete SDK to the following additional languages: Malay, Dutch, Hungarian, Slovenian, Indonesian, Arabic(UAE), Romanian, Chinese traditional, Chinese simplified, Thai, Hebrew, Vietnamese, Filipino.

Improvements to existing features: #

  • We have improved parsing of MRZ formats deviating from the ISO/IEC 7501 standard:
    • Document discriminator was in place of the document number on driver licenses and IDs from:
      • New York
      • Michigan
      • Canada
    • Different check digit calculation for Mexico (Consular) ID
    • Recognition of the unofficial XCT country code for Northern Cyprus ID
    • Recognition of different country codes and check digit calculation on China Mainland Travel Permit for Hong Kong and Macao Residents
  • We added anonymization support for:
    • MRZ on the Mainland Travel Permit for Hong Kong and Macao Residents
  • We have made some changes to the BlinkID(Combined)Recognizer
    • You can now see ProcessingStatus in the results to inspect potential processing errors, such as when barcode detection fails, a mandatory field is missing, etc.
    • You can now also see a more detailed ImageAnalysisResult showing you when:
      • Face image is detected
      • MRZ is detected
      • Barcode is detected
    • We added a RecognitionModeFilter settings group. You can toggle flags on this object to control the recognition mode of the recognizer:
      • enableMrzId lets you scan MRZ on all identity documents except visas and passports.
      • enableMrzVisa lets you scan MRZ on visa documents.
      • enableMrzPassport lets you scan MRZ on passports.
      • enablePhotoId lets you scan photo IDs. Use it to enable or disable document and face image extraction on unsupported documents.
      • enableFullRecognition lets you scan all data from our supported documents.
      • Your license key still controls which of the above recognition modes are allowed.
    • We have added a RecognitionMode result member describing which recognition mode was used to produce the results.
    • We are now retrieving sex and nationality fields from the MRZ in cases where those two fields cannot be found in the document’s VIZ. Previously, we only used to do this for dates, name fields and document numbers.
    • We are now preserving the original string (raw data) of the dates we couldn’t parse.
  • We have improved the thresholds for card detection feedback messages ("move closer" and "move farther"). This will improve the UX when scanning in landscape mode as the document can now be closer to the camera.

Minor API Changes #

  • We have made some changes to the BlinkIDRecognizer and BlinkIDCombinedRecognizer:
    • We renamed DocumentImageMoireStatus to ImageAnalysisDetectionStatus
    • We grouped the conditions member from the results with the DriverLicenseDetailedInfo structure
  • We renamed RecogitionMode to RecognitionDebugMode in RecognizerBundle.

Bug fixes: #

  • We fixed an issue in default UI that was causing reticle to reappear while card flip animation was showing.

5.6.0 #

New features: #

  • We have translated complete SDK to following languages: Croatian, Czech, English, French, German, Italian, Portuguese, Slovak, and Spanish.

  • In BlinkIdCombinedRecognizer and BlinkIdRecognizer we added:

    • Support for US documents with vertical orientations:
      • Alabama DL
      • Arizona DL
      • California DL
      • Colorado DL
      • Connecticut DL
      • Georgia DL
      • Illinois DL
      • Iowa DL
      • Kansas DL
      • Kentucky DL
      • Maryland DL
      • Massachusetts DL
      • Minnesota DL
      • Missouri DL
      • New Jersey DL
      • Ohio DL
      • Pennsylvania DL
      • South Carolina DL
      • Tennessee DL
      • Texas DL
      • Utah DL
      • Washington DL
      • Wisconsin DL
    • Support for new document types:
      • Croatia Health Insurance Card / front side / BETA
      • Ecuador ID / front side
      • El Salvador ID / BETA
      • Sri Lanka ID / BETA
    • No longer BETA:
      • Canada Nova Scotia DL
      • Canada Yukon DL
      • Norway DL
    • Back side support:
      • Kenya ID
    • Result anonymization - with this option enabled, results are not returned for protected fields on certain documents. The full document image will also have this data blacked out.
      • Protected fields are:
      • Document number on Hong Kong ID
      • MRZ on Hong Kong passports
      • Personal ID number on Netherlands DL
      • Personal ID number and MRZ on Netherlands ID
      • MRZ on Netherlands passports
      • Document number on Singapore DL, ID, Fin Card, Resident ID
      • Personal ID number on Singapore Employment Pass
      • Document number and personal ID number on Singapore Work Permit
      • MRZ on Singapore passports
        • By using anonymizationMode property, you can choose the AnonymizationMode: ImageOnly, ResultFieldsOnly, FullResult or None.
      • FullResult anonymization (both images and data) is set by default.

  • We added support for new MRZ formats:

    • Guatemala ID
    • Kenya ID

Improvements to existing features: #

  • We updated UsdlRecognizerResult and IdBarcodeRecognizer.Result with additional address fields:
    • street, postalCode, city and jurisdiction
  • We added expired (in Swift isExpired) property to BlinkIdRecognizerResult, BlinkIdCombinedRecognizerResult and IdBarcodeRecognizerResult.
    • It compares the current time on the device with the date of expiry and checks whether the document has expired or not.
  • We made changes to the result structure of BlinkIdCombinedRecognizer and BlinkIdRecognizer:
    • Barcode data is now encapsulated in its own result structure: BarcodeResult.
    • Data from all OCR-ed fields, without MRZ data, is now encapsulated in a VizResult structure, representing the "Visual Inspection Zone" data. In BlinkIdCombinedRecognizer, front side data is available in its own structure (frontVizResult), back side data in its own (backVizResult), so you can now access data from each side separately.
    • The main part of the result, outside these structures, is filled according to these rules:
      • Document number is filled with data from the MRZ, if present.
      • Remaining data is then filled with barcode data.
      • Remaining data is filled from the back side's visual inspection zone (OCR data outside of MRZ).
      • Remaining data is filled from the front side's visual inspection zone.
      • Remaining data is filled with data from the MRZ.

Minor API changes: #

  • We moved BlinkIdRecognizerResult members colorStatus and moireStatus to the result's imageAnalysisResult (frontImageAnalysisResult and backImageAnalysisResult in BlinkIDCombinedRecognizerResult).

Bug fixes: #

  • We fixed US driver's license address extraction (Oregon, Mississippi, Rhode Island).
  • We removed OpenGL entirely which was causing unexpected crashes.

5.5.0+1 #

Updated README for 5.5.0

5.5.0 #

New features: #

  • In BlinkIdCombinedRecognizer and BlinkIdRecognizer we added:

    • Support for obtaining full document image for IDs with barcodes. Now you can capture document image and extract barcode data with a single scan.

    • Scanning & data extraction for travel visas and passports.

    • Field validation - we validate if the results from certain fields match predefined character sets. - If validation fails, the recognizer's state is RecognizerResultStateUncertain. - Use validateResultCharactersto enable or disable validation.

    • Field anonymization for sensitive data. - Enable or disable whether certain sensitive data should be anonymized in full document image result. - Use anonymizeImage to enable or disable image anonymization.

    • Support for new document types:

      • Australia New South Wales - ID Card / Front only / BETA
      • Brazil - Driver License / BETA
      • Brunei - Military ID / BETA
      • Brunei - Residence Permit / BETA
      • Brunei - Temporary Residence Permit / BETA
      • Ghana - Driver License / Front only
      • Latvia - ID Card
      • Norway - Driving Licence / Front only / BETA
      • Oman - ID Card
      • Saudi Arabia - ID Card / BETA
      • Sweden - Social Security Card / Front only
      • USA - Social Security Card / BETA
      • Back side supported:
        • Malaysia - MyTentera

    • No longer BETA:

      • Australia Tasmania - Driving Licence
      • Canada British Columbia - ID Card
      • Germany - Residence Permit
      • Morocco - ID Card
      • Nigeria - Voter ID
      • Singapore - Work Permit
      • USA Alaska - ID Card
      • USA District Of Columbia - Driver License
      • USA Indiana - ID Card
      • USA Kentucky - ID Card

    • Barcode scanning on the following documents:

      • Argentina ID
      • Colombia ID
      • Nigeria Voter ID
      • South Africa ID

Improvements for existing features: #

  • Improvements in BlinkIdCombinedRecognizer and BlinkIdRecognizer:
    • Documents discarded with the class filter are now reported as not supported
      • onDocumentSupportStatus will be called if a documents is filtered out by the classInfoFilter.
    • For Malaysian MyKad we are now returning if a Moire pattern is present on the scanned document (detected or not detected).
      • use documentImageMoireStatus in BlinkIdRecognizer.
      • use documentFrontImageMoireStatus and documentBackImageMoireStatus in BlinkIdCombinedRecognizer.
  • We added digital signature support to PassportRecognizer.
  • We updated IdBarcodeRecognizerResult with specific driving license info.
    • Use restrictions, endorsements and vehicleClass

← Metadata

45
likes
160
points
2.79k
downloads

Publisher

verified publishermicroblink.com

Weekly Downloads

Metadata

Flutter plugin for BlinkID, SDK for scanning and OCR of various identity documents.

Homepage

Documentation

API reference

License

MIT (license)

Dependencies

flutter, json_annotation, plugin_platform_interface

More

Packages that depend on blinkid_flutter

Packages that implement blinkid_flutter

Back