The Incode Flutter SDK adds identity verification, onboarding, and authentication flows to your Flutter app. This section walks you through installing the SDK, initializing it, and configuring it for your use case.
Start here
If you're new to the SDK, follow these steps in order:
- Install the SDK in your Flutter project, including platform-specific setup for iOS and Android.
- Choose an SDK mode based on whether your app captures and validates online, or captures only.
- Choose an implementation pattern based on where your onboarding flow is configured and how much control your app needs.
The remaining pages in this section cover specific setup options, advanced configurations, and maintenance tasks that you may or may not need depending on your integration.
Your first flow
Once the SDK is installed and initialized, a minimal onboarding flow looks like this:
IncodeOnboardingSdk.init(
apiKey: 'YOUR_API_KEY',
apiUrl: 'YOUR_API_URL',
testMode: false,
onError: (String error) {
print('Incode init failed: $error');
},
onSuccess: () {
OnboardingSessionConfiguration sessionConfig = OnboardingSessionConfiguration();
OnboardingFlowConfiguration flowConfig = OnboardingFlowConfiguration();
flowConfig.addIdScan();
flowConfig.addSelfieScan();
flowConfig.addFaceMatch();
IncodeOnboardingSdk.startOnboarding(
sessionConfig: sessionConfig,
flowConfig: flowConfig,
onSuccess: () {
print('Incode Onboarding completed!');
},
onError: (String error) {
print('Incode onboarding error: $error');
},
);
},
);
To react to individual modules as they complete, add the corresponding optional callback to your startOnboarding call:
IncodeOnboardingSdk.startOnboarding(
sessionConfig: sessionConfig,
flowConfig: flowConfig,
onSuccess: () { /* ... */ },
onError: (String error) { /* ... */ },
onSelfieScanCompleted: (SelfieScanResult result) {
print(result);
},
);
For the full integration walkthrough including session configuration, error handling, and the available listener callbacks, see Configure Flows Locally and Run End to End.
Optional and advanced setup
These pages cover specific scenarios you may or may not require:
- End-to-End Encryption (E2EE): enable end-to-end encryption of capture artifacts.
- Token-Based Setup: use the SDK without an API key by passing a backend-created token.
- Delete Local Session Data: clean up locally stored onboarding data.