Releases: microblink/web-sdks
Release list
@microblink/camera-manager@7.3.3
v7.3.3
Changes
- Updates internal state cloning to use a browser-compatible fallback when
structuredCloneis unavailable.
@microblink/blinkid@8000.0.1
v8000.0.1
Changes
- Changes reticle type from searching to error for barcode scanning when barcode is not in frame
- Changed BlinkID UX Manager partially supported barcode step auto-resolution to respect barcodeModule.presenceMandatory.
- Improved RedactionResolver API, added getDefaultRedaction(classsInfo) parametar, more details here
- Relaxes the return type of
RedactionResolverso all fields are optional - Fixed UX manager creation failing when screen.orientation is unavailable (e.g. iOS Safari and some WebViews). Device orientation analytics now use a guarded subscription with legacy fallback
- Updates internal state cloning to use a browser-compatible fallback when structuredClone is unavailable.
@microblink/blinkid-verify@3.21.1
v3.21.1
Changes
Fixed UX manager creation failing when screen.orientation is unavailable (e.g. iOS Safari and some WebViews). Device orientation analytics now use a guarded subscription with legacy fallback
Updates internal state cloning to use a browser-compatible fallback when structuredClone is unavailable.
@microblink/blinkcard@3000.0.8
v3000.0.8
Changes
-
Fixed UX manager creation failing when
screen.orientationis unavailable (e.g. iOS Safari and some WebViews). Device orientation analytics now use a guarded subscription with legacy fallback -
Updates internal state cloning to use a browser-compatible fallback when structuredClone is unavailable.
@microblink/blinkid-verify@3.21.0
v3.21.0
Changes
- Update internal dependencies for blinkid-verify-wasm
- Updated to BlinkID v7.8
@microblink/blinkid@8000.0.0
v8000
Breaking release. This version aligns the BlinkID Web SDK stack with the v8000 runtime. Integrations built against the 7.x public surface require migration. See the BlinkID v8000 migration guide.
What's new
- SDK modularization & enhanced flexibility: We've transformed our core architecture. Features previously known as "fallback modes" are now independent SDK modules.
- Tailored implementation: Users can now toggle specific modules such as Capture, Barcode, MRZ, or VIZ scanners to build a workflow that fits their exact needs.
- Total control: This modular approach offers more flexibility, allowing you to use BlinkID as a comprehensive recognition tool or a specialized scanner, all while leveraging our latest feature updates.
- Expanded barcode support: When operating in Barcode Mode, BlinkID is no longer limited to PDF417.
- Universal scanning: We've added support for QR codes, Code 128, Code 39, ITF, EAN, UPC, and DataMatrix.
- Versatility: This expansion allows the SDK to be used across a wider variety of document types beyond standard IDs.
- Streamlined extraction & data redaction (anonymization): We are putting more power in the hands of our integrators by removing restrictive custom rules.
- Document rules: Custom document rules have been removed. Customers can now implement their own logic based on result completeness to determine how a document is processed.
- Data redaction (anonymization): We've transitioned away from fixed data redaction (anonymization) rules. You can now programmatically decide which fields to mask and how to handle them based on the specific data returned.
- We are transitioning our terminology from anonymization to data redaction to more accurately reflect the nature of this feature.
- Intelligent timeout mechanism: To balance performance with accuracy, we've introduced a new timeout feature.
- Non-blocking scans: Ensures a smooth user experience by preventing "stuck" scan states.
- Step-by-step decisions: After each extraction step, you can decide whether the current data is sufficient or if the SDK should continue processing to gather more information.
- Document-specific improvements
- EU residence permits: For documents with redundant fields on both the front and back, BlinkID now intelligently merges these into the top-level results for better data consistency.
- Egypt driver's license: Enhanced data extraction to now include Date of Birth (DOB) as an additional field.
- Zimbabwe ID: Improved data extraction to support and return both alphabetic and numeric characters within the document number field.
Bug fixes
- Date conversion accuracy: Resolved an issue where Islamic-to-Gregorian date conversions could occasionally differ by +/- 1 day. These conversions are now precise and consistent.
All-in-one SDK (@microblink/blinkid)
- Replaces
createBlinkIdUiwithcreateBlinkId. Update imports and entry-point usage. - Adds
uxManagerOptionsoncreateBlinkIdso you can passtimeoutConfigurationand other UX manager options without wiring the UX manager manually. - The built-in feedback UI derives extraction mode from session settings:
full-document— document capture flowdocument-with-barcode— document plus barcode stepsbarcode-only— barcode-focused flow
Configure viascanningModeand enableddocumentCaptureModule,barcodeModule,mrzModule, andvizModulesettings.
BlinkIdComponentcallbacks and filters (also available onBlinkIdUxManagerwhere noted):addOnResultCallback,addOnErrorCallbackaddOnUiStateChangedCallback— stabilized visible UI stateaddOnFrameProcessCallback— per-frame control withadvanceToNextStep(),triggerStepTimeout(), andgetLastFrame(); finish or advance when extracted data is sufficient even if the default flow would wait on an optional barcode stepaddOnProgressCallback— RAF-driven progress snapshots for debug overlaysaddDocumentClassFilter,addOnDocumentFilteredCallback
- Top-level UI customization:
targetNode,cameraManagerUiOptions,feedbackUiOptions(including nested localization), and cleanup viaBlinkIdComponent.destroy().
Core, worker & runtime (@microblink/blinkid-core, @microblink/blinkid-worker, @microblink/blinkid-wasm)
- Aligns published TypeScript types, worker Comlink API, and Wasm bindings with the v8000 runtime (breaking for code targeting the 7.x core/worker/wasm surface directly).
- Result typings trimmed to match the runtime: removes stale exports such as
mode,ParentInfo,RecognitionMode, and unsupported VIZ properties; tightensFieldTypeto currently supported values. - Renames
SingleSideScanningResult.barcodeInputImage→barcodeImage. - Adds
getResolvedSessionSettings()on the scanning session to read effectiveBlinkIdSessionSettingsafter defaults and resolvers are applied. - Data redaction API (replaces 7.x session anonymization):
- Remove
scanningSettings.anonymizationModeandscanningSettings.customDocumentAnonymizationSettingsfromBlinkIdSessionSettings. - Use
RedactionSettingsandRedactionModeinstead (none,image-only,result-fields-only,full-result— same string values as formerAnonymizationMode). - Pass optional
redactionSettingsResolverwhen creating a session (createBlinkId,BlinkIdCore.createScanningSession, orBlinkIdWorker.createScanningSession). The resolver receives classifiedDocumentClassInfoand returns settings applied automatically atgetResult()time. - Seed defaults with
BlinkIdWorker.getDefaultRedactionSettings(documentClassInfo)(Wasm:getDefaultRedactionSettings). RedactionSettingsaddsredactMrzandredactBarcodeon the result payload.- Migrate legacy
DocumentAnonymizationSettings:documentNumberAnonymizationSettings→documentNumberRedactionSettings; move per-document filters into resolver logic keyed onDocumentClassInfo.
- Remove
Feedback UI (@microblink/blinkid-ux-manager)
- Breaking — localization overrides: Flat top-level keys (e.g.
scan_the_barcode,help_modal_title_1,alert_cancel_btn,onboarding_modal_title,scanning_help) are no longer accepted. Use the nested shape:feedback_messages— live scan hintshelp_modal/onboarding_modal— branchesfull_document,document_with_barcode,barcode_only(stepsvisibility,lighting,blur; desktopcamera_lenswhere applicable)document_filtered_modal,document_not_recognized_modal,error_modal,timeout_modalhelp_button,sdk_aria
- Notable renames:
document_scanned→feedback_messages.document_scanned_aria;front_side_scanned→feedback_messages.front_side_scanned_aria;scan_unsuccessful→timeout_modal.title. New keys includefeedback_messages.scan_the_barcode_sideandfeedback_messages.keep_still. Full flat-key → nested-path table is in the migration guide and package README under Internationalization. - Help and onboarding copy and illustrations follow extraction mode (
full_document,document_with_barcode,barcode_onlyassets). - Two-timer timeout model via
timeoutConfiguration:inactivityTimeoutMs— inactivity between stabilized UI-state changes (restarts when the feedback stabilizer applies a new state)scanStepTimeoutMs— total active capture time for the current step (pauses when capture stops; resets on new intro-anchored step or app foreground)partiallySupportedBarcodeResolveTimeoutMs— wait before resolving a partially supported barcode step
Set any timer tonullto disable. ReplacesgetTimeoutDuration()/setTimeoutDuration()withgetTimeoutConfiguration()/setTimeoutConfiguration().
addOnProgressCallbackwithBlinkIdProgress,BlinkIdProgressTimerState, andBlinkIdProgressTimerStatusfor live progress instrumentation.addOnFrameProcessCallbackexported asBlinkIdFrameProcessCallbackfor frame-level flow control.
Minor API changes
- Removed from session settings:
anonymizationMode,customDocumentAnonymizationSettings, custom document rules. - Removed / trimmed from typings: stale result-only fields and enums noted above; unsupported VIZ properties.
- Renamed:
barcodeInputImage→barcodeImage; anonymization types/settings → redaction equivalents. - Added:
createBlinkId,uxManagerOptions,redactionSettingsResolver,getResolvedSessionSettings(),timeoutConfiguration(+ getters/setters on UX manager), progress and frame-process callbacks, nested localization structure,RedactionSettings.redactMrz/redactBarcode.
@microblink/blinkid-verify@3.20.3
v3.20.3
Changes
- Localization: Refined English onboarding and feedback strings (for example clearer “a document” wording) and adjusted Arabic locale strings for the same flows.
- Bug fixes: Fixed BlinkID Verify WebAssembly Embind registration so Point and Quadrangle are exported under the correct class names, matching the intended TypeScript types.
@microblink/blinkcard@3000.0.7
v3000.0.7
Changes
- Localization: Updated Arabic (ar) feedback and onboarding strings for consistency with the latest copy.
- Internal improvements: Consolidated BlinkCard WebAssembly session result bindings through shared @microblink/wasm-common helpers. No intended public TypeScript API changes.
@microblink/blinkid@7.8.0
v7.8.0
What's new
- The list of all supported documents and result fields is now available here.
- We have added extraction of date of birth from document numbers on Egypt DL.
- If a residence permit has a "remarks" field on both the front and back side, values of these fields will be combined in the top level result.
Bug fixes
- We have fixed MRZ parsing rules for Zimbabwe ID and the new version of Brunei ID; these are now successfully extracted.
New documents support
- Argentina - Polycarbonate Passport
- Bhutan - Identity Card
- Georgia - Polycarbonate Passport
- Jamaica - Identity Card
- Maldives - Driver's License
- Mongolia - Identity Card
- New Zealand - Proof Of Age Card
- Pakistan - Origin Card
- Saint Kitts And Nevis - Polycarbonate Passport
- South Sudan - Identity Card
- Virgin Islands Of The United States - Driver's License
- Virgin Islands Of The United States - Identity Card
New document versions for supported documents
- Argentina - Alien ID
- Argentina - Identity Card
- Armenia - Identity Card
- Australia, Australian Capital Territory - Driver's License
- Australia, Australian Capital Territory - Identity Card
- Brunei - Identity Card
- Bulgaria - Residence Permit
- Denmark - Driver's License
- Georgia - Identity Card
- Greece - Residence Permit
- Guatemala - Alien ID
- Guatemala - Identity Card
- Guyana - Paper Passport
- Kosovo - Driver's License
- Kyrgyzstan - Polycarbonate Passport
- Liechtenstein - Identity Card
- Mauritius - Identity Card
- Nigeria - Identity Card
- Puerto Rico - Driver's License
- Puerto Rico - Identity Card
- Uganda - Identity Card
- USA - Paper Passport
- USA - Polycarbonate Passport
- USA, Montana - Driver's License
- USA, Montana - Identity Card
- USA, New York City - Identity Card
- Venezuela - Driver's License
New segments supported on documents
- Pakistan, proof of registration: renamed fathersName to additionalNameInformation
- Mauritania, ID: renamed documentNumber to personalIdNumber
Minor API changes
- Added new items to enums:
- new
FieldTypeenum values:CardAccessNumber - new
Typeenum values:ORIGIN_CARD - new
Countryenum value:VIRGIN_ISLANDS_OF_THE_UNITED_STATES
- new
- Added member results to
ScanningResultandVizResult:- 'cardAccessNumber'
- Removed items from enums:
- removed
FieldTypeenum values: RemovedParentsLastName2,ParentsFirstName2,ChinPermanentExpiry - removed
Countryenum value:VIRGIN_ISLANDS_US
- removed
Other changes
- Improved analytics
@microblink/blinkid-verify@3.20.2
v3.20.2
Changes
- Improved analytics