Skip to main content

toden_flutter 4.2.0 copy "toden_flutter: ^4.2.0" to clipboard
toden_flutter: ^4.2.0 copied to clipboard

Toden SDK for Flutter. ID verification, liveness detection, NFC chip reading and document capture.

4.2.0 #

No breaking changes. The version jumps from 4.0.1 to 4.2.0 so the three SDKs share one number; there is no 4.1.0.

Deploy note for Toden: the letters-and-digits code and the work-address message need the matching server release, which sends alphanumericCode in the workflow and the corporate_email_required reason. Until then the code field stays digits only and a refused address shows the existing message. The declined session screen needs the server release that sends session_declined; until then a used-up code only disables the field. The limit on liveness attempts needs the server release that adds maxLivenessAttempts to the workflow and /api/kyc/liveness/failed; until then a failed face check offers Try Again as many times as before.

Added #

  • Codes with letters as well as digits. When a workflow's email or phone verification turns on alphanumericCode, the code field accepts letters and digits, upper-cases them, and opens a text keyboard that capitalises, with autocorrect off. Paste and one-time-code autofill work the same way, and the instruction asks for the "6-character code". Digits-only codes are unchanged.
  • A clear message for work-address-only workflows. When email verification takes work addresses only (corporateOnly) and the person enters a free-provider address, the SDK asks for a work email instead of showing a general error.
  • A screen for a declined session. When a workflow's email or phone verification turns on declineOnLastAttempt and the person uses up a code, the server declines the session and the SDK ends the flow on its own screen: "We couldn't verify your email address" (or phone number), the server's message or a default one, and Close. Every later refusal on that session (starting or resuming it, saving progress, submitting) shows the same screen rather than an error with Try again, and onError receives session_declined once, the way a cancelled session reports session_cancelled. EmailVerificationConfig and PhoneVerificationConfig gain declineOnLastAttempt (default false).
  • A limit on liveness attempts. On by default: the face check may fail 3 times in one verification, unless the workflow sets maxLivenessAttempts to 1 or 2, or turns the limit off with false. Each failed check is reported to the server, which counts them, and the panel under "Time's up. Let's try again." says how many attempts are left ("1 attempt left." or "2 attempts left."), shown as a small warning: an amber pill with a warning icon. At the limit the server declines the session (session_declined, reason liveness_attempts_exceeded) and the flow ends on the declined screen, "We couldn't verify your face", with the server's message and Close, and onError receives session_declined once. Try Again never waits on the report, and a report that fails changes nothing. VerificationConfig gains maxLivenessAttempts, set by the workflow (3 when it leaves the setting out).
  • An explanation before the chip read. The chip step now opens on a screen laid out like the address-monitoring explanation, saying the document has a chip the phone can read and how to hold it: for a passport, close it and place the phone on the front cover (and try the back cover if nothing happens); for a card, place the phone on the card. It names where the phone's reader is (the top of an iPhone, the middle of an Android phone's back), asks for a thick phone case to come off first, and lists the photo page first: ticked when document capture already read the code that unlocks the chip, still to do when it did not. The read starts on Continue; it used to start the moment the step opened.

Fixed #

  • A used-up code no longer leaves the code field open. Once a code has had its last wrong attempt (or the server refuses to check it again), the step says "Too many incorrect attempts. Request a new code.", the field stops taking input, paste and autofill, and the main button becomes "Send a new code". Sending a new code clears the field and opens it again. A wrong code with attempts left behaves as before.
  • Code errors are easier to see. A wrong, expired or used-up code now shows in an alert box under the field, read out by screen readers.
  • A wrong code clears the field, so the next try starts empty.
  • Code boxes stop growing. The boxes stop at 56px wide, the same cap as the web and React Native SDKs, so a short code keeps phone-sized boxes, centred.
  • Android release builds scan again. R8 removed the constructors ML Kit uses to start, so in a release build (not a debug one) ML Kit never started: the document was never detected, the code on the photo page never read, and no face found, while the camera ran. The keep rules the SDK ships now cover them, with nothing to change in your app. Release builds of 4.0.0 and 4.0.1 on Android have this problem.
  • A failed face check's message is never cut off. "Time's up. Let's try again." and Try Again now rest on the bottom edge at their full height. They were squeezed into the strip under the camera window, which on a short screen cut off the top of the panel.
  • The photo-page scan's spinner is its normal size. While the camera started, the spinner filled the screen.
  • A retaken document side is submitted with its own recording, or none. A retake kept the recording uploaded for the earlier photo, so a retake with no recording of its own (a photo from the gallery, a clip that would not compress or upload) was submitted beside a recording of a different capture, which the server's injection check compares the photo with. Continue now clears the document's photos and recordings before uploading them again. A back captured for a two-sided ID picked earlier is no longer submitted with a one-sided one.

Changed #

  • Your organisation's logo by default, and a workflow's "None" wins. With no appearance.logo from your app or the workflow, the flow shows your organisation's logo from the dashboard, as 'default' does (it showed none). An empty appearance.logo ('') means no logo, and the workflow's value wins over the logo your app sets, as its theme does.
  • The code check names the session. Checking an email or phone code now sends the session, as the web SDK does, so the step is charged when the check completes rather than at submission.
  • The flow follows the device's light or dark setting by default. When neither the workflow nor your app sets a theme, the flow now opens in the applicant's device setting (system). It used to open light whenever your app passed an appearance. Set appearance.theme (or the workflow's theme) to light or dark to pin it.
  • The chip screen says each thing once. The header says where to hold the document ("Hold your document flat against the back of your phone until it's read."), so the body no longer repeats it: it shows "Waiting for the chip", then "Chip found. Keep still until this finishes." with each step of the read. The builder preview now shows the same screen. New defaults, shared with the web and React Native SDKs: nfc.description as above, nfc.waiting "Waiting for the chip" (it was the placement instruction, and now also labels the waiting line, so your wording reaches it) and nfc.skip "Continue without the chip".

4.0.1 #

  • iOS builds no longer fail with "The compiler is unable to type-check this expression in reasonable time" in DocumentDetector.swift. Some Xcode versions could not compile the check that a document lies wholly inside the frame; it is now written in a form every Xcode handles. Detection is unchanged.

4.0.0 #

The first release as toden_flutter, and the first release since myaza_kyc_sdk_flutter 3.7.0. 3.8.0 was never published; its changes are here too.

This version needs a native rebuild (new native code on iOS and Android).

Upgrading from myaza_kyc_sdk_flutter #

  • The package is renamed from myaza_kyc_sdk_flutter to toden_flutter. Change the dependency in pubspec.yaml and your imports to package:toden_flutter/toden_flutter.dart; the API is unchanged. myaza_kyc_sdk_flutter receives no further releases.
  • The Android package moves from co.myazahq.kyc to co.toden.flutter. If your AndroidManifest.xml declares the presence foreground service, change it to co.toden.flutter.PresenceForegroundService. The geofence and boot receivers are declared by the SDK and need no change.
  • The iOS background task id (co.myazahq.kyc.presence.checkin) and the Keychain service holding the stable device id are unchanged, so your Info.plist stays as it is and devices keep their id.

Toden names for the bundled ML Kit flag and the iOS check-in task #

  • Bundle the ML Kit models with todenBundledMlKit=true (in android/gradle.properties, or the root ext/extra). The old name, myazaKycBundledMlKit, still works when the new one is not set.
  • The iOS background check-in id is now co.toden.presence.checkin. An Info.plist that lists the old co.myazahq.kyc.presence.checkin keeps working; if it lists both, the SDK schedules with the new one.

API hosts #

  • Each environment now has its own host, as the docs list them: pk_test_ keys go to https://sandbox-api.toden.co and pk_live_ keys to https://api.toden.co. Both used to go to https://trust.myaza.app.

Presence token and OTP settings from the session #

  • Presence: the presenceToken from POST /verify is stored beside the on-device pin and in the native background stores, and sent on every report, so reports from the phone that captured the address keep their full weight. Pins saved before this have no token and report at the foreground tier until the person verifies again.
  • The contact step sends sessionId on /contact/send and sizes the code field from the codeLength the server returns.

Document review and audio #

  • documentReview (default off): true shows the review screen after a document scan. Uploaded photos always get the review, and so does a scan that failed to upload or that the capture check could not read.
  • livenessAudio (default off): records sound in the liveness video, and the consent screen says so. It needs the same microphone setup as documentAudio.
  • documentAudio (default off): records sound in the document video, and the consent screen says so. Add NSMicrophoneUsageDescription on iOS and RECORD_AUDIO on Android to allow it. Without them, or if the person refuses, the video is silent and nothing fails.

The Toden address book #

  • When the organisation has it on, the address flow opens with a choice: use an address the person saved with Toden (an email, a six-digit code, then a pick) or enter one. A picked address skips the map, the entrance photo and the review, and is sent as addressBookReuse instead of a pin.
  • A flow with a presence check lists only saved addresses whose presence was confirmed in the last six months, and says why others are missing.
  • If the server refuses the picked address (the code expired or the address can no longer be used), the flow returns to the address book step instead of ending on an error.
  • The review step offers an unticked box to save the confirmed address to the person's own Toden address book, with the directions and the entrance photo each included only if they choose.
  • Never offered on business verifications.

Scoped business workflows #

  • A business workflow with the address, questionnaire or contact scope now runs that scope's own steps. It never opens the business application (company search, registry lookup, key people, documents or the applicant's own check).
  • Those screens name the business: the welcome screen and its list of steps, the email and phone code steps, proof of address, the address screens, the questionnaire and the success screen. A workflow's own wording for the person's version of a text still applies to the business version. Presence checks for a business count days at the premises only.
  • A business workflow with a face check scope shows "Unable to start verification" and never opens the camera. onError receives invalid_workflow.
  • A submission the server refuses with entity_type_mismatch (the reference names a person on a business workflow, or the reverse) is reported as invalid_workflow with a clear message, not as something to retry.

Business documents, one group at a time #

  • The business documents step groups what the organisation asks for (legal presence, company details, ownership structure, authority to represent the business, address, financial, tax, licences and permits). The applicant uploads one document per group, one group at a time, instead of facing a slot for every document.
  • The applicant never says which document they uploaded: the group lists the documents it accepts, and the server recognises which one it is from its text. Uploads are sent as { group, mediaId }. An upload saved in an earlier session before this change still fills its group and is sent by its type.
  • Each accepted document shows how recent it must be ("From the last 3 months") when the workflow sets a validity window (maxAgeMonths). The date is checked after submission.
  • A new screen: the groups are a vertical carousel. The open group's card is in front, the next group's card is tucked behind it at the top (showing its title and what it will ask for) and the previous group's card behind it at the bottom (its file, or Skipped, with Change to reopen it); a thin edge beyond each shows there are more groups that way. The open card shows its position ("2 of 5"), the documents the group accepts with how recent each must be on its own line, and a tall upload area that is itself the control: tap it to choose a photo, take one, or pick a file (there is no separate Choose or Take a photo button, so the button under the card is the only primary button). Once uploaded, a card shows the file with Replace and Remove. A new upload replaces the group's earlier one.
  • Moving on brings the next card down into the middle; Back brings the previous one up. The tucked cards fade in, and when the system asks for less motion nothing slides. Screen readers hear which group has opened ("2 of 5: Ownership structure").
  • The button reads Next on every group but the last and Continue on the last; an optional group with nothing uploaded reads Skip.
  • A finished group keeps its number, with a small tick on it, so the count stays visible. A file name that is a random id (as phone cameras often give) shows as Uploaded instead.
  • An optional group can be skipped with Skip. The back arrow walks back through the groups before leaving the step.
  • A refused submission (missing_documents) names the missing groups when the server sends missingGroups, else the missing documents.
  • Needs the matching server release, which accepts one document per group.

The whole document, corners included #

  • A document is photographed only when all four of its corners are in view, with a little space past each one. Passports were captured with the bottom edge, where the machine-readable zone is, cut off. The hint says what to change: "Fit all four corners of your ID inside the frame" or "Move back a little so there is space around your ID".
  • The shutter waits for the corners too, and the photo is cropped to the document plus that space rather than to the guide.
  • Android now finds the document's corners itself. A device that cannot (the camera-plugin fallback) captures as before.
  • Fixed: after a ready frame that was not used (the camera still settling, or the wrong document), auto-capture could fire on the next frame whatever was in view.

3.7.0 #

The entry point is now Verification, the flow carries the Toden brand, and Bricolage Grotesque ships inside the package. The package name is unchanged.

New names #

  • The entry points are Verification.show(), VerificationWidget, VerificationConfig and VerificationAppearance.
  • KYC-prefixed types are now Verification-prefixed: VerificationError, VerificationSubmission, VerificationResult, VerificationStep.
  • The presence classes are AddressPresence, BackgroundPresence and PresenceService.
  • The exported widgets and theme classes use a Ui prefix: UiButton, UiInput, UiColors, UiSpacing.

Every earlier name still works as a deprecated alias, so existing code compiles unchanged.

Fonts #

  • Text at 16px and up is set in Bricolage Grotesque. Smaller text and anything typed into a field stays Geist. Headings are unchanged. An organisation's own body font still replaces both.
  • Bricolage Grotesque is bundled. It was fetched from Google's font servers at first launch, which showed a fallback face first and left the flow in the system font with no connection.

Brand #

  • The flow says Toden where it said Myaza: the footer logo, the consent notice (which now links to toden.co/legal) and the default wording.
  • New default colours: a neutral grey scale in place of the purple-tinted one. Colours set through VerificationAppearance or a workflow are unchanged.
  • The NFC step uses the phone-and-chip icon, matching the dashboard.

API address #

The SDK calls the verification API under /api/v1 (for example /api/v1/verify). The earlier /api/kyc addresses keep working on the server, so older versions of the SDK are unaffected.

Fixes #

  • The dark header uses the same surface colour as the cards. It was a pale purple band.

3.6.0 #

A full-screen liveness camera, signing on screen, and no selfie review by default.

This version needs a native rebuild. It adds native code on iOS (pod install) and Android.

The SDK now asks for location all the time #

On iPhone, and on Android 11 and later, the SDK never asked the person to allow location all the time. MyazaBackgroundPresence.enable() and MyazaPresenceService.enable() answered backgroundDenied unless the person had already chosen it in Settings, so background presence monitoring did not start and checks collected only app-open reports.

The SDK now asks itself, on both platforms:

  • iPhone shows the "Change to Always Allow" prompt, once per install.
  • Android 11 and later opens your app's location settings page, where the person picks "Allow all the time". After two refusals Android shows nothing.

After a refusal, send the person to Settings with openLocationSettings().

People already being checked get background monitoring #

People who verified before this version were never asked for location all the time, and the SDK only asks right after a verification. MyazaAddressPresence.report(), the call your app already makes when it opens, now does it for them: when the person's check is still running (or their always-on monitoring is between two checks) and background monitoring is not on, the report switches it on.

  • The person sees the system's "allow all the time" prompt once. The SDK never asks again from a report, whatever they answer.
  • If they already allowed it in Settings, it is switched on with no prompt.
  • Nothing happens when the check has finished, monitoring was stopped, the server cannot be reached, or the workflow has background monitoring off.
  • The result carries background when the report tried, with the same reasons enable() gives.

Your app still needs the background location declarations, as before. To show your own explanation first, pass autoBackground: false to report() and call MyazaBackgroundPresence.enable() when you are ready.

A stay is reported sooner #

The background tier recorded a stay when the person left, or at a "still here" check-in once it had run three hours. Someone who came home and stayed in therefore showed nothing for three hours. The first check-in of a stay now comes after 35 minutes; later ones stay at three hours. Android schedules a check-in about 40 minutes after each arrival, and iOS asks for its background refresh at the same point when your app has opted in. The OS still decides when one runs.

presenceStay() returns the stay the phone has open (since and nextReportAt), or null, so your app can tell the person a report is on its way.

Reading the check's status #

fetchPresenceWatchStatus(apiKey:, externalUserId:) returns where the check stands on the server: its status, progress from 0 to 1, nights and days counted, and when it ends. It never throws; null means the server could not be reached.

The liveness camera is full screen #

While the liveness camera is live it now takes the whole screen. The camera runs edge to edge, sharp inside a tall window for the face and blurred around it, with the instruction above the window and the step count below. Back and close are drawn over the camera in the flow's own colours. The face is judged against the window, and a check that fails stays on the camera with the reason and Try Again.

A phone that cannot keep up with the blur gets a plain tint around the window instead.

The photo now waits for the person to face the camera and hold still, takes three frames and keeps the sharpest, and retakes by itself up to twice when the result is soft.

No change to your code.

No selfie review unless you ask for one #

This changes existing integrations. After the liveness capture the SDK used to show the selfie with Retake and Continue. It now hands straight on to the next step. A liveness selfie is evidence, not a portrait, and the capture already waits for a face that is in the window and still.

Switch the review back on with selfieReview on MyazaKYCConfig, or with the switch on the workflow's Presence Intelligence step. On a biometric workflow its own setting wins. A selfie that fails to upload still shows the review, which is where the retry is.

Going back to a finished liveness step #

Going back to the liveness step after the selfie is taken now shows "Selfie already taken" with the photo and Continue. There is no Retake, so the check runs once per session.

Sign a supporting document on screen #

A supporting document in a workflow can now be signed on screen. The workflow sets capture on the document: upload (the default, as before), draw (a signature drawn on screen) or draw_or_upload (either). The person signs in a box with Clear and an Expand button for more room, and "Use this signature" stays disabled until there is real ink. With draw_or_upload they can switch to "Upload a photo of your signature instead".

After saving, the card shows the signature with an Edit action that reopens the box with the signature in it. A session picked up later shows a mark that it was signed, not the drawing itself.

Existing workflows are unchanged: a document with no capture is uploaded as before. The server must be on a version that accepts drawn signatures.

The SDK stands down when monitoring is stopped #

When your organisation stops address monitoring for a user, the next MyazaAddressPresence.report() switches background location off and the Android foreground service, forgets the stored address and answers the new reason PresenceReportReason.stopped. Before this the phone kept reporting to a check that no longer existed.

standDownPresence(externalUserId) does the same on request. If your code switches over every PresenceReportReason, add a case for stopped.

The footer under every step now reads "Protected by" with the Myaza mark, as the web SDK does. It read "Powered by". A custom footer logo already read "Protected by".

One spinner everywhere #

Every loading state now shows the same spinner as the web SDK, in place of the platform's own. The pulsing loader is that spinner too.

A natural smile passes on iPhone #

The smile step on iPhone asked for a wider smile than most people give. It now accepts a natural one.

The iPhone's own name on results #

The device reported with a verification read "iPhone". It now reads the model's name, for example "iPhone 16 Pro Max". This raises device_info_plus to ^11.3.0.

The flash check tells the server when each colour came on #

The submission now carries the time each flash colour came on, measured from the start of the recording, so the server's own check of the recording looks in the right place. No change to your code, and an older server ignores the new field.

The hosted map gets longer to load #

The SDK waited 8 seconds for the hosted map before falling back to the built-in one. It now waits 20 seconds, which a slow connection needs. A picture or script on the map page that fails to load no longer sends the person to the built-in map.

3.5.0 #

Device integrity and app attestation signals, and a screen for a cancelled verification.

This version needs a native rebuild. It adds a native device-intelligence channel on iOS and Android.

Device integrity and app attestation #

When the workflow's Device Intelligence is on, the SDK now sends:

  • the same per-install device ID on every upload as in the submission's fingerprint;
  • a stable device ID that survives a reinstall (a Keychain value on iOS, ANDROID_ID on Android);
  • root, jailbreak and hooking checks, with no permission or prompt;
  • an attestation of the app: App Attest on iOS and the Play Integrity Standard API on Android, against a single-use challenge from the server, given at most about five seconds and left out if anything fails.

Attestation needs one-off setup in your app: the App Attest capability on iOS, and linking your app to Myaza's Google Cloud project in Play Console on Android. See "Device attestation" in the README. Without it, attestation is simply left out and the rest of the flow is unchanged.

A screen for a cancelled verification #

An organisation or Myaza support can now cancel a verification session midway. When the server says a session is cancelled (on start, on a progress save, on submission, or in the result check), the flow stops on a screen reading "This verification was cancelled", with the server's message and a Close button. There is no Try again or Go back: the session cannot continue until it is reopened from the dashboard. onError fires once with the new code session_cancelled.

A failed session start used to be ignored so the flow could carry on. A cancelled session is the one exception: the flow now stops instead of walking the person through steps the server will refuse.

3.4.1 #

Fixes for business applications, and a way back after a refused submission. No native rebuild is needed.

The applicant's own check reaches the server #

In a business application, the applicant's own identity check was sent without the application's session. The server refuses that, the refusal went unnoticed, and the flow ended on success with the applicant never verified; reopening the app resumed at the applicant's ID step. The check is now sent with the session, as the web SDK does.

Company documents survive a resume #

An applicant who closed the app partway through a business application came back with no company documents, and the submission was refused as missing them. The uploaded documents are now saved with the rest of the progress and restored as uploaded.

The success screen waits for the key-people list #

The business success screen now stays on the loader until the server has settled the key-people list (for up to 15 seconds), so Done never shows beside a list that is still loading. The key-people cards also have space between them, and a long role no longer cuts off mid-word: role, share and country read as one line.

Go back after a refused submission #

When the server refused a submission, the error screen offered only Close, even when its message asked the person to fix something earlier in the flow. It now also offers Go back, which returns to the step that can fix the refusal: company documents, company details, key people, supporting documents, questionnaire, proof of address, address, or the photo a refused upload names. When the refusal doesn't point at one step, Go back returns to the step before submission. Coming back to the end submits again. Refusals that going back can't fix (not enough credits, an invalid API key) still show Close alone.

3.4.0 #

Background presence now records a stay while the person is still at home, a visible sheet handle in dark mode, the progress bar as the default indicator, and fixes on the address confirmation screens.

The progress bar is now the default indicator #

A workflow or config that doesn't choose a progress indicator now shows the thin bar on the header's bottom edge instead of the numbered step circles. To keep the circles, set progressStyle: MyazaProgressStyle.steps (or choose Steps in the workflow builder). Workflows that already chose a style are unchanged.

"Edit" keeps clear of the entrance photo on the address review #

On the "Confirm your address" card, the "Edit" link sat right against the entrance photo that hangs over the card. When a photo is there, "Edit" now sits under the address instead; without one it stays where it was.

Sheet handles are visible in dark mode #

The grab handle on the verification sheet and on the smaller sheets inside the flow (address details, country picker, key people) was drawn in a dark grey that nearly disappeared on dark themes. On dark themes it now uses the theme's own text colour at 40%, which stays visible on any dark palette an organisation brands. Light themes are unchanged.

The address intro button now reads "Continue" #

The button on the "Let's confirm your address" screen said "Got it, let's go". Google Play's guidance for the disclosure shown before a background location request asks for a clear accept button rather than a vague "Got it", and a reviewer can treat this screen as that disclosure. The default is now "Continue". If you set your own text for address.intro.start, nothing changes for you.

"Still here" check-ins for background presence #

A geofence only reports when the person crosses its edge, so a stay used to be recorded only when they left: someone who hardly leaves home earned little background evidence, and one exit the phone failed to report capped a multi-day stay at 24 hours. The plugin now records a stay while the person is still there, once it has run three hours: on every app open (an inside MyazaAddressPresence.report() reading, and each iOS launch), on each reading of the Android foreground service, every two hours or so on Android through WorkManager (no manifest change), and on iOS through background refresh if you add the identifier and the fetch mode to Info.plist. Rebuild your app after upgrading.

3.3.0 #

Passive Liveness, customisable texts, the organisation's own footer logo, silent capture and a bright screen during liveness.

This release changes the plugin's native code on Android and iOS, so rebuild your app after upgrading.

These features need the Myaza server release of 2026-09-28. Against an older server the flow still completes: the new settings are simply ignored, and silent frames are refused at upload and left out.

Passive Liveness, and a head turn in every 3D Active Motion run #

livenessMode: 'passive' asks the person to hold still for a moment while the SDK records a short clip and takes the selfie. There are no prompts: Myaza's liveness model decides from the capture. 3D Active Motion now always includes a head turn, and the SDK reports the prompts it ran.

A bright screen during liveness #

While the liveness camera is on, the flow shows its light theme and raises the screen to full brightness, then restores both. Android changes the brightness of the SDK's own window only and iOS uses UIScreen.brightness, so no permission is needed. A workflow turns this off with livenessBrightScreen: false.

Customisable texts #

A workflow can reword the main text of each screen through its texts setting, on the same keys as the web SDK.

When a workflow uses custom trust branding, its logo replaces the Myaza mark in the footer, and the consent notice names Myaza Trust as the processor for the organisation.

Silent capture #

On the document review, the SDK briefly opens the front camera with no prompt, flash or shutter sound and takes one frame of the person holding the ID. It is on by default; a workflow turns it off with silentCapture: false.

Liveness is reported more honestly #

A flash sequence that could not be measured no longer counts as passed, a recording that fails to upload is reported with its reason, and a resumed session asks for the selfie again rather than reusing one it cannot show.

Selfie guidance #

The selfie primer asks for a bright spot with no glare and an uncovered face (glasses off), and no longer states a duration.

Fixes #

A resumed KYB application picks up at the applicant's own verification. The consent screen discloses supporting documents the flow may ask for. In development, a workflow's own logo and the footer logos now load over a USB tunnel (adb reverse), like the organisation logo already did.

Background monitoring is on by default, and the SDK turns it on #

When a presence flow is submitted, the SDK now asks the person to allow location all the time and arms the background geofence itself, unless the workflow switches Background monitoring off (presence.background: false; a workflow that does not mention it is now on). You no longer call MyazaBackgroundPresence.enable() for it. It still needs the background-location entries in your own manifest and Info.plist; without them the request comes back refused and the foreground reporter is the only source of evidence.

The SDK sends the first presence report itself #

When a workflow enables presence verification, the SDK now reports presence on its own the moment the flow is submitted, so the watch gets its first day (and night, when submitted at night) without any code in your app. Until now every observation depended on your app calling MyazaAddressPresence.report(), and apps that had not added that call produced watches that collected nothing and lapsed as inconclusive.

Later days still come from your app: keep calling MyazaAddressPresence.report() on app open, or enable background monitoring. A call you already make at submit is harmless, since one day's reports merge into one. The pin is stored under your userId, so pass one: without it there is nothing to report against, and the server now starts no watch.

3.2.2 #

A multi-region workflow no longer has its ID types narrowed by the host app.

  • A consumer's idTypes prop can no longer narrow a multi-region flow. Such a flow declares its offering inside countries[], where a country pinning nothing already means "every granted ID for that country", and leaves the top-level list unset. The merge read that unset value as "the flow did not define it" and kept the prop, which the picker then falls back to for any country pinning none of its own — so a hardcoded ['bvn','nin','passport'] reduced a 58-country flow to three Nigerian types, on every country. The prop is now dropped at the merge, so a flow that sets its OWN top-level list still wins and single-country flows are unchanged.
  • Retake draws a circular arrow, not a rotating hand. Lucide's rotateCcw is a circular arrow; Hugeicons reuses the name for a hand rotating an object, so every Retake and retry control drew a hand. The fourth name collision in this set found by comparing path data rather than names.

3.2.1 #

Icon and dark-mode corrections found after 3.2.0.

  • The back control draws a long arrow. 3.2.0 mapped it to Hugeicons' MoveLeft, which is a move affordance — an arrow trailing a dot — so it drew a stray circle. The set has no long-tailed arrow (its longest spans 13.5 of the 24-unit viewBox against Lucide's 20), so the glyph is drawn locally in widgets/icons/glyphs.dart, path for path with the web SDK.
  • The fullscreen toggle draws a real expand icon. Maximize02 is a pinch gesture in this set, not corner arrows; it now uses Expand, the glyph the dashboard and the web SDK draw.
  • The supporting-documents card is the lifted surface. The card and the wells inside it were the wrong way round against the web SDK, in both light and dark. Four surfaces are corrected: the card, the "what we read from it" well, the read chips and the Optional pill.
  • The restored-selfie note is readable in dark mode. It was the only string styled from Flutter's ambient Material theme, whose bodySmall is a dark grey meant for light backgrounds.

3.2.0 #

One icon set across the product #

The SDK now draws Hugeicons Stroke Rounded, the set the dashboard and the web SDK already use, so a step looks the same whichever surface renders it. Only React Native is still on the old set.

Every icon comes through lib/src/widgets/icons/, the same shape of boundary the web SDK uses, and MyazaIcons names each one as Lucide did — so the three SDKs stay in lockstep by the NAME a step picks rather than by the glyph. Where the web SDK already draws a name, the entry resolves to the same drawing: the mapping goes through the icon set's own alias table rather than being guessed from the name.

Nothing in the public API changes and an existing app needs no code edit.

  • lucide_icons_flutter is replaced by hugeicons.
  • MyazaIcon takes its icon positionally like Flutter's own Icon, inherits colour and size from IconTheme, and holds its space on a null icon, so a row of optional icons still does not shift.
  • The theme toggle was the last Material icon and joins the set, so nothing is left drawing a second language.

An icon keeps its own size inside a fixed-size parent #

MyazaIcon draws an SVG, and an SVG fills the box it is given, where Flutter's Icon draws a font glyph that stays its own size whatever box it is handed. A Container(width: 56, height: 56, child: MyazaIcon(..., size: 28)) passes tight constraints, so the glyph silently grew to 56 — about twice what the call site asked for. Affected every fixed-size container in the SDK, the consent hero among them.

The drawing is now pinned to the resolved size and centred, which is the structure Icon already has.

3.1.0 #

Supporting documents #

A new step collects the artefacts an organisation holds on file — a NIN slip, a signed mandate, a bank letter — as opposed to the identity evidence the verification is decided on. It sits after the identity checks and before proof of address, because the documents are resolved against the ID the person actually verified with.

There is no catalogue. The organisation names each document it asks for, so the SDK renders the title and guidance the workflow sent rather than captioning a key it recognises. A document with no title is not asked for at all.

Entirely workflow-driven (supportingDocuments on the resolved config), so nothing in the public API changes and an existing app needs no code edit to receive it.

  • One card per requested document, naming what the document is being taken for: the values the server will read off it appear as chips under the guidance, so a slot says more than a noun.
  • Per-document ID scoping. A document scoped to NG/nin is never demanded of a passport holder, which is what stops the step being a dead end.
  • alwaysAsk shows the slot to everyone while the scope decides only who must provide one, for an organisation that will take a document from anybody who has it.
  • The consent screen discloses the step, a scoped document included. Consent runs before an ID is picked, so a disclosure gated on the resolved step order would leave every scoped document unmentioned.
  • Where nothing is required, Continue reads Skip: pressing on is a deliberate choice to add nothing.
  • Uploads survive a resumed session, carrying the document and its media id rather than preview bytes.

The number matches the web SDK's 3.1.0, so both platforms carry the same one for the same release.

3.0.4 #

  • Backing out of the camera no longer strips the header. Opening document capture, pressing back, then picking the ID again rendered the step with no header and its content tucked under the status bar. The layout flag that lets a full-bleed camera take the whole sheet outlived the screen that raised it, so returning applied it to a screen with no camera on it. It is now cleared whenever the flow changes step. No app change is needed to pick this up.
  • The country flag now sits beside the document and chip steps. It already appeared on the ID-selection steps and then disappeared at exactly the point the applicant is holding the document it describes.

3.0.3 #

  • Workflow ID types on single-country flows. Publishing a workflow stores its ID selection per country, and a flow offering a single country is stored that same way. The ID picker ignored that list whenever it held one entry and offered every ID type the organisation had been granted instead. Republishing a single-country workflow therefore changed every other setting and never the ID types. Multi-region flows were unaffected, and no app change is needed to pick this up.
  • The loader now follows your appearance. The indicator shown while a workflowId mount resolves was always drawn in the built-in light theme, so a dark or brand-coloured flow repainted the moment it opened. It now uses the appearance passed to the SDK. Colours a workflow publishes still take precedence once it has loaded.

3.0.2 #

  • Migrated invite-link sharing to the share_plus 12 SharePlus API.
  • Requires share_plus >=12.0.0 <13.0.0, allowing host apps on share_plus 12.x to resolve cleanly.

3.0.1 #

  • Relaxed the share_plus dependency constraint to allow host apps on share_plus 12.x.

3.0.0 #

Two changes in this release need action from some apps, which is what makes it a major:

  • iOS dependency floor. device_info_plus now needs 11.2.1 or later. An app that pins it to 10.x must move to 11. See "Swift Package Manager on iOS".
  • Android ML Kit models are fetched, not bundled. This takes about 18.5 MB per device out of the APK, but the models now arrive through Google Play Services, so a build shipping to devices without it (Huawei, bare AOSP) must set myazaKycBundledMlKit=true to keep the offline models. See "A smaller Android app".

Everything else is additive. The version also matches the React Native SDK's 3.0.0, so the two platforms carry the same number for the same release.

Opting out of the NFC permission #

The SDK depends on flutter_nfc_kit for the eMRTD chip read, and that plugin's own manifest declares android.permission.NFC. Android merges a plugin's manifest into the host app's, so the permission appears in every build whether or not the workflows in use touch the chip step, and there was nothing in the README telling anyone how to remove it.

The platform-setup section now documents the removal:

<uses-permission android:name="android.permission.NFC" tools:node="remove" />

Nothing else changes. The chip step already checks for a radio at runtime and skips itself when there is none, so a build without the permission behaves exactly like a phone with no NFC hardware.

Documentation only — no code change, and no effect on apps that do read chips. Unlike the React Native SDK, Dart has no conditional dependencies, so flutter_nfc_kit still ships either way; the plugin carries no native library, so what it costs is the permission rather than the download size.

Swift Package Manager on iOS #

The iOS plugin now ships a Swift package beside its podspec. Flutter no longer warns that myaza_kyc_sdk_flutter does not support Swift Package Manager, and an app that uses Swift Package Manager (the default from Flutter 3.44) builds the plugin as a package instead of falling back to CocoaPods for it. Apps that still use CocoaPods need no change.

device_info_plus now needs 11.2.1 or later (it was 10.1.0), the first release that builds as a Swift package, so it drops off that warning too. An app that pins device_info_plus to 10.x needs to move to 11. flutter_tts and video_compress have no Swift Package Manager release yet, so Flutter still lists them and builds them through CocoaPods.

Document capture without the camera #

A workflow can now set allowDocumentScan: false (also a MyazaKYCConfig field). The document step then never opens the camera or asks for camera permission: the person picks a photo of each side from their device, and the usual preview, review and upload follow. At least one of allowDocumentScan and allowDocumentUpload stays on, so a config with both off uses the camera.

A smaller Android app #

On Android the SDK now fetches its two ML Kit models, face detection and text recognition, through Google Play Services instead of shipping them inside the host app. Measured on the example app, an arm64 phone now downloads 32.00 MB instead of 55.75 MB. Both are requested the moment the flow opens, and the manifest names them, so a Play Store install usually fetches them before the app first runs.

A model that has not arrived yet can no longer fail silently. The liveness step waits for the face model and says so if it cannot be set up. The passport scanner waits for the text model and lets the person continue without the chip when it cannot. Document auto-capture asks for the model but never waits for it, since the shutter works without it.

Apps that ship to phones without Google Play Services, such as Huawei devices, can bring the bundled models back with myazaKycBundledMlKit=true in android/gradle.properties.

Release builds no longer fail on this plugin #

The plugin now compiles against Android 36, which three of its dependencies require. On 34 every host app's release build stopped before reaching app code. Some third-party plugins in the tree still declare 34, so the README shows the override a host app needs until they catch up.

2.7.0 #

The address flow, complete #

Address Intelligence on Flutter now walks the same four steps as the web SDK: a search box (Google autocomplete where the org has it, an explicit search otherwise), a satellite map with the pin to place, an entrance step that frames the doorway in Street View imagery where coverage exists and falls back to a photo where it does not, and a confirmation card. The details sheet edits every part of the address, a workflow can require any of them, and the flow will not confirm until the required ones are filled. On a development key the confirmation card carries a test-result picker for the address verdict, and a sandbox key gets placeholder maps and a canned device fix rather than live vendor calls.

Proof of address knows its market #

The proof-of-address step names the document kinds the org accepts, per country, and asks for the applicant's country on the address scope so the right kinds are offered. Whether the applicant's name must appear on the document is now the workflow's rule (required, optional, or not needed), and the copy follows it.

Presence that reports #

The presence reporter waits for the server to mint its watch before posting (a report made straight after submission used to land on nothing), and takes the platform's last known position when a fresh fix does not arrive in time. The session start now sends the device block, so the dashboard knows the phone and SDK from the moment the flow opens rather than after it submits.

Biometric flows #

The face check and enrolment screens are one design with the React Native SDK: a selfie review that a workflow can switch off, one loading screen from the shutter to the verdict when the workflow delivers it in the app, the org's own words on the waiting and verdict screens, and a show() that takes the flash sequence length. The liveness ring builds in the workflow's brand colour rather than the default purple.

Smaller fixes #

A workflow can skip the opening consent screen, and a flow with no consent opens on its first real step (an address flow used to open on the pin instead of the search). The confirmation card falls back from the static picture to the framed Google map before the built-in tiles, without a second pin, and its address band fits a 360dp phone. Android map gestures no longer fight the page, and a review whose entrance image never arrives drops the empty frame.

2.6.0 #

Several IDs in one run #

A workflow can now ask for two or three IDs and get back one verification. The applicant picks each in turn, an ID already used disappears from the later choices, and one selfie covers the whole run — every ID is matched against it rather than asking for a new one each time. A position strip above the steps says which check they are on, because without it a three-ID run is three visits to the same-looking screen with nothing distinguishing them.

The KYB application catches up #

Business flows on Flutter collected a registration number and stopped. They now run the whole application: company documents requested by type before the people step, key people sectioned into beneficial owners, shareholders, and directors and representatives, corporate shareholders recognised as companies rather than filed as people, and the registry check running at the moment the applicant picks their company so the register's own list of officers is on screen before the form asks who they are.

A KYB submission is also no longer described as an identity check. It is a company being verified, and calling it "identity verification" told the applicant they were doing something other than what they were doing.

Coming back to where you left off #

Closing the app used to mean starting again. A remount now restores the step, the captures and what was typed, and an anonymous mount sends a device id so a session can be found again without an account. A partial or older snapshot restores less rather than breaking — the flow never fails because progress was saved by a different build.

A KYB applicant's job is not over when they submit: every director and owner still has to verify, and those invites outlive the session by days. The success screen now shows the server's reconciled list rather than the draft the applicant typed, so people the register added appear and roles it corrected are right. Tapping Done with checks outstanding offers a way back to the links instead of closing over them.

A refused contact code no longer loops #

Contact proofs are single-use and expire about half an hour after the code is checked, but they are saved with session progress and restored on resume. A returning applicant therefore carried a dead proof while the step still read "verified", the submission was refused, and Try Again resubmitted the same dead token forever. The SDK now reads which channels were refused, clears exactly those, and returns the applicant to that step with an explanation. Verifying goes straight back to the submission. Nothing else they entered is touched.

Redo only what was asked for #

When a reviewer sends an application back for one document, the applicant walks that step and no others. Previously the narrowing was collected and then ignored, so a request to retake one photo restarted the entire flow.

Smaller things #

A name that matches nobody on the register preselects "I'm not one of these people" rather than leaving the choice blank, which made claiming to be a stranger the easiest way forward. The wait while the register is read shows the roster it is about to become instead of a spinner. Sheets take the system's own corner radius and sit at the system's height, every one has a handle and a close button, and their corners run concentric with the device's display. Text that could not be read against its background is fixed, and a sheet no longer runs under the Dynamic Island.

Two fixes worth naming: the register's answers were being discarded after the lookup that paid for them, and a wrong type on the poll response stopped Flutter polling for results at all.

2.5.0 #

Non-production flows say so #

A sandbox flow is pixel-identical to a live one. That is the point — you are testing the real thing — and also the hazard: screenshots get mistaken for production incidents, testers wonder why a real passport was rejected, and a pk_test_ key shipped to production looks like it works right up until nobody is actually verified.

A strip above the header now names the environment. It reads from the server's config rather than sniffing the API key prefix, because a hosted handoff session authenticates with an hs_ token that carries no environment slot — key-sniffing would leave exactly the surface an end user sees unlabelled. Development is labelled too, and differently: it runs the real pipeline against staging provider credentials, so "test data only" would be untrue there.

Production flows are unaffected — nothing is drawn.

progressStyle: none #

A third option alongside steps and bar: no progress element in the header at all. For hosts whose own surface already communicates progress, or short flows where a step count is more noise than reassurance. The brand row and controls stay; only the progress element is dropped.

An unrecognised value still falls back to steps rather than throwing, so a newer server adding a fourth style will not break this SDK.

2.4.0 #

PACE chip access #

The eMRTD reader spoke Basic Access Control only, so passports issued with PACE as their sole access protocol — standard across the EU since roughly 2014, and spreading — could not be read at all. PACE is now implemented alongside BAC, and the session negotiates: PACE where the chip offers it, BAC where it does not.

Which protocol a read used is reported back rather than inferred. A chip that falls back to BAC because it offers nothing else is healthy; one that falls back because our PACE attempt broke is a bug, and the protocol alone cannot tell the two apart — so the outcome travels with the submission as a diagnostic.

The chip's printed details are parsed, and its photo renders on Android #

DG1 — the data page as the chip stores it — is now parsed and shown on the success screen, so the read confirms what it actually recovered instead of asserting that something was read.

DG2 portraits encoded as JPEG 2000 now decode on Android, which has no JPEG 2000 support of its own. Previously those chips produced a portrait the platform could not render.

progressStyle #

The header's progress indicator is now configurable:

  • MyazaProgressStyle.steps (default) — numbered circles, one per step. When a flow has more steps than fit, they collapse to a moving window rather than shrinking past legibility.
  • MyazaProgressStyle.bar — a single thin bar on the header's bottom edge. Quieter, and unaffected by step count, so it suits long flows.

Both convey the same fraction; the choice is how much room it takes. A published workflow can carry the setting, and an unrecognised value falls back to steps rather than throwing — a newer server adding a third style must not break an older SDK. Mirrors the React Native SDK's progressStyle.

Also #

Document capture handling and the dropdown anchoring were reworked.

2.3.0 #

The full business (KYB) application #

The business flow previously stopped at the registry lookup. It now runs the whole application section, each part appearing only when the resolved workflow configures it:

  • Directors & owners — name, role, ownership percentage, country and email per person, with minEntries gating Continue.
  • Supporting documents — one upload slot per configured document type; every required slot must be filled before the step will pass.
  • Applicant verification — the submitter declares their role, and can identify themselves as one of the people they just listed. Picking themselves links the two records, so one person is verified once rather than being both a key person and a separate applicant. Their own capture leg then runs as an ordinary individual verification.
  • Invite links — where a director or owner needs their own check, the success screen hands back their invite links, shareable through the native share sheet.

Contact verification and proof of address, rebuilt #

The email/phone OTP steps were split into composable parts (channel picker, entry, verified state) and gained a WhatsApp delivery channel alongside SMS. Proof of address accepts a wider range of documents and states its own recency window.

Also #

  • An NFC scan illustration that animates the document against the phone, so the chip step stops looking like a hang.
  • PoweredBy and brand-mark widgets, and a shared dashed-border painter.

2.2.0 #

country is optional when you launch from a workflow #

MyazaKYCConfig.country was required while its own documentation said a workflowId mount could omit it — so the documented usage did not compile. A workflow user had to invent a country purely to satisfy the constructor, then watch the resolved flow overwrite it.

It is now optional. Passing one is unchanged; omitting it is only valid alongside a workflowId, and MyazaKYC.show refuses to mount a config that reaches it without a country from either source, reporting onError with a stated reason rather than silently rendering an empty ID-type list.

Everything country-sensitive already read effectiveCountry(config, state); the remaining direct reads (business details, contact defaults, the business verify payload) now go through it too.

Existing code is unaffected: country: is still accepted exactly as before. The field's type widened from String to String?, so the rare caller that reads config.country back into a non-nullable String will need a ?? '' or a null check.

2.1.0 #

Android document capture rebuilt on native CameraX #

The document step no longer drives the camera through the Flutter camera plugin on Android. It now runs a single native CameraX session — preview, frame analysis and still capture — which fixes the four problems the plugin path had on devices like the Galaxy S24:

  • Faster to open, and no longer re-initialises the camera between the front and back of a two-sided document, or on a retake.
  • Sharper preview. The plugin needed a use-case combination many devices cannot serve, so CameraX quietly downgraded the streams.
  • Smooth capture. A still no longer tears down the video recording and reconfigures the camera surface.
  • No rotation drift. The preview no longer re-rotates itself off the accelerometer when the phone is held flat over a document.

iOS is unchanged; it keeps the plugin path, which was already stable.

Chip reading is now our own implementation #

The eMRTD reader no longer depends on the dmrtd package, whose licence does not permit redistribution inside a commercial SDK. The Basic Access Control handshake, secure messaging and file reading are implemented in the SDK and checked against the worked example published in ICAO 9303 Part 11 Appendix D — session keys, send-sequence counter and the protected command bytes all match the standard exactly.

Reading adapts to the document rather than assuming a fixed chunk size: chips disagree about how many bytes they will serve per read and about how to refuse, so the reader backs off on a wrong-length error, adopts a length the chip names for itself, keeps the data from a short read, and switches to extended reads for files past 32 KB. Nothing about the submitted data changed.

PACE support. Chips that have retired Basic Access Control can now be read. PACE uses the passport's printed details only to unlock a fresh random value and then agrees new session keys each time, so recording a session no longer reveals anything to someone who later photographs the page. Generic Mapping over elliptic curves is implemented, with 3DES and AES at 128, 192 and 256 bits.

BAC is still tried first and PACE only when a chip refuses it. That is the opposite of the standard's preference and deliberately so for this release: BAC has read real documents here for a long time and PACE has read none, so in this order PACE can only add documents that can be read, never take away one that already worked. The order flips once PACE is confirmed on real passports.

Two variants are not implemented and fall back to BAC rather than failing: Integrated Mapping, and PACE over finite-field Diffie-Hellman. Virtually all issued passports offer the elliptic-curve variants.

Full-screen document capture #

The camera fills the screen instead of sitting in a fixed box, so the guide — and therefore the document — occupies far more of the sensor. Controls moved in-frame: a back button, the document being captured (flag + type), the live framing hint, "upload a photo instead", and the shutter, with the torch beside it.

New #

  • Torch, on both platforms, for capturing documents in poor light.
  • Auto-capture now verifies the document. It checks that the recognised text identifies the document you asked for, so it no longer fires at anything text-dense (a screen, a book, another ID). Passports additionally require the machine-readable zone in frame, which also means the chip step no longer has to scan the document a second time.
  • Chip-read progress on Android. iOS gets a system NFC sheet from the OS; Android had nothing, so the SDK now shows an equivalent sheet with per-step detail — including that the security-data step is the long one.
  • Automatic chip retry. The first read attempt routinely failed on Android and an immediate retry succeeded with the phone untouched; the reader now does that itself instead of asking the user to.

Fixed #

  • Side videos that recorded correctly could be uploaded as zero bytes, when a late frame reconstructed the encoder over the finished file.
  • The back button and side badge overlapped the status bar in the full-screen camera.
  • The capture hint could sit behind the shutter button.

2.0.1 #

  • Sandbox and production now share one base URL (https://trust.myaza.app). The environment is still derived solely from the API key prefix (pk_test_… → sandbox, pk_live_… → production); only the host the sandbox keys resolve to changed — no integration code changes are required.

2.0.0 #

First release on pub.dev, under the package's final name.

  • Package renamed to myaza_kyc_sdk_flutter (import package:myaza_kyc_sdk_flutter/myaza_kyc_sdk_flutter.dart).
  • Environment is derived from the API key prefix — the environment config field is gone. pk_test_… → sandbox (sandbox.trust.myaza.app), pk_live_… → production.
  • Flutter 3.27+ / Dart 3.6+ is now the minimum supported toolchain.
  • Docs: added a Requirements section (iOS 13.0, Android minSdk 21, camera permission setup).

1.0.0 #

Initial public release of the Myaza KYC Flutter SDK — ID capture, document scan, and on-device active liveness (Apple Vision on iOS, Google ML Kit on Android), talking to the Myaza KYC API.

Robustness & UX:

  • Typed errors. onError receives a KYCError with a stable code (network_error, invalid_api_key, insufficient_credits, upload_failed, camera_permission_denied, feature_disabled, unknown) — identical to the React SDK.
  • Camera permission. A denied camera shows a dedicated screen with an Open Settings action and reports camera_permission_denied; document capture keeps a gallery-upload fallback there.
  • Network resilience. Uploads + verify retry transient failures (network / timeout / 5xx) with exponential backoff + jitter; onError fires only after retries are exhausted, with "retrying (n/3)…" feedback.
  • Multiple faces. Liveness pauses ("Make sure only your face is visible") when more than one face is in frame and resumes automatically.
  • Lighting. Live too-dark / too-bright detection during liveness, with guidance; auto-capture is discouraged until lighting is acceptable.
  • Voice guidance. Spoken liveness instructions (TTS output, no microphone) via VoiceGuidanceConfig — toggle with VoiceGuidanceConfig.off, or set a voice language (e.g. fr-FR).
  • allowDocumentUpload. Hide the device-gallery document option when set to false (still offered on the permission screen as an escape hatch).