Skip to main content
cr3dentials_zktls is a thin plugin over the native iOS and Android SDKs: the native SDK does the work, and Dart drives it through one API on both platforms. This page takes you from an empty project to your first test webhook, with your test key and the demo platform zktls-demo, so you need no real account anywhere.

Before you start

  • Your test key (zk_test_…) from Register your app.
  • A webhook endpoint that checks the signature, and its signing secret. Webhooks has the code for Node and Python.
  • Dart 3.13 or later.
  • iOS 15.0 or later, and Android 7.0 (API 24) or later.

1. Install

Android needs nothing more: Gradle fetches the SDK from Maven Central. On iOS, with Swift Package Manager, Flutter’s default, the plugin’s package brings the SDK. If your app uses CocoaPods instead, the SDK’s releases repository is its own spec source. Keep it first in your Podfile, because CocoaPods takes a pod from the first source that has it:

2. Configure

Call Zktls.configure once, when your app starts:
The app key is publishable, so it can live in your code or be passed at build time, for example with --dart-define. Use the test key in debug builds and the live key in release builds.

3. Verify

Zktls.verify takes the platform ids and your reference, and returns when the user leaves the flow:
The outcome tells your app only how each platform ended. The results go to your server, by webhook. Don’t wait in the app for them: show your own next step as soon as verify returns. The fields are in The outcome, and the refusal codes are in Errors. To finish later, call verify again with the platforms that were not started. It is a new verification, and you can pass the same reference. To start from your server, have your server create a token with POST /partner/verification-tokens and pass it to the app:

4. Test with zktls-demo

1

Run your app

Run it on a simulator, an emulator or a phone, with your test key, and tap the button that calls Zktls.verify(['zktls-demo'], reference).
2

Choose the demo platform

Tap it on the platform list. On its consent screen, tick both boxes and tap Continue to verification.
3

Sign in to the demo bank

Enter any user name and the password demo, which the page shows.
4

See the outcome

The SDK hands the run to an attester, and the list shows the platform as Verified. Tap Done: verify returns with zktls-demo as PlatformStatus.done.
5

Get the webhooks

Within seconds, your endpoint receives a platform.finished with "test": true and the demo bank’s latest transfer, and a verification.finished, in either order. Both carry your reference.

5. Theme and strings

configure also takes a theme and the screens’ words:
ZktlsTheme is the native SDK’s name, so it doesn’t clash with Material’s Theme. Colours are exactly #RRGGBB or #AARRGGBB (alpha first). logo names an image in your app: an Android drawable and an iOS asset of that name. A field you leave null keeps the SDK’s default. The platform list and the consent screens are in Cr3dentials’ colours, with your logo at the top; your colours apply to the refusal screen. The string keys are the native SDK’s, the same on both platforms: see the table on the iOS or Android page. Keep the words in braces, which the SDK fills in. A colour in another form makes configure throw a PlatformException with the code InvalidArgument and a message naming it, such as theme.accent must be #RRGGBB or #AARRGGBB. The SDK’s configuration is then left as it was.

Things to know

  • The screens. On Android, verify shows them over the current activity, which must stay in front until it returns. On iOS, over the key window’s top-most view controller.
  • One verification at a time. A verify called while another runs waits for it to finish.
  • Errors. A failed call throws a PlatformException whose code is the SDK’s error name, as listed in Errors; sdkErrorCodeOf(e) turns it into an SdkErrorCode. For a refusal, refusalOf(e) gives the reason, such as device_not_verified. InvalidArgument is the plugin’s own. Internal is a fault inside the SDK: report it to us.
  • The notification. On Android, the SDK’s foreground service shows a notification reading “Verifying”. To translate or rebrand it, define zktls_session_notification_title, zktls_session_channel_name and the drawable zktls_session_notification_icon in your app’s resources.
  • Logging. Log the verificationId, the statuses, the reasons and the refusal codes. Your Partner API key and webhook secret never belong in the app at all.

Before you submit

The native requirements apply to your app: App Attest on iOS and Play Integrity on Android for live keys, your registered bundle ID and package name, and the privacy answers. See Before you submit on the iOS and Android pages, then work through the release checklist. Version 2 of the plugin wraps version 2 of the SDK: it depends on 2.2.0 or later, within 2.x. The package and its changelog are on pub.dev: cr3dentials_zktls.