The Incode Onboarding Cordova Plugin lets your Cordova, Capacitor, or Ionic app run identity verification and onboarding flows on iOS and Android. This section walks you through installing the plugin, choosing an SDK mode, and picking an implementation pattern.
Start here
- Install the plugin and complete per-platform setup for Android and iOS.
- Choose an SDK mode based on whether your app captures and validates online, or captures only. (Android only)
- Choose an implementation pattern based on whether your flows run locally or are configured from the Dashboard.
Your first flow
After the SDK is installed and initialized, the minimal call to run an onboarding flow with startOnboarding() looks like this:
cordova.exec(
function (result) { console.log("Onboarding completed:", result); },
function (error) { console.log("Onboarding error:", error); },
"Cplugin",
"startOnboarding",
[
{ region: "ALL" },
[{ module: "addId" }, { module: "addSelfieScan" }, { module: "addFaceMatch" }],
{ recordSession: "false" }
]
);
This captures an ID, takes a selfie, and matches the two. For the full argument breakdown and every available method, see the API Reference.
Optional and advanced setup
- End-to-End Encryption (E2EE): encrypt session data in transit between the SDK and Incode's backend.
- Token-based Setup: initialize the SDK using a short-lived token instead of a long-lived API key.
- Delete Local Session Data: clear session data stored on the device.
- Troubleshooting: common install and build issues.