DocumentationAPI Reference
SDK reference

SDK Reference

The SDK Reference documents the API surface of each Incode SDK — method signatures, parameter definitions, session configuration, result schemas, and runtime methods. This is reference material for developers who are already integrated and need to look something up, or who want deeper technical detail beyond what's covered in the integration guides.

For first-time setup and integration walkthroughs, see Integrate by Platform. For module behavior and per-module configuration parameters, see the Module Configuration Reference below.

In this section

  • Web SDK Reference: JavaScript API for the Incode Web SDK: create, initialize, renderCaptureId, renderCaptureFace, renderCamera, and all other methods.
  • iOS SDK Reference: IncdOnboardingManager API: initialization, session configuration, startOnboarding, startWorkflow, delegate protocol, and result types.
  • Android SDK Reference: OnboardingSessionConfiguration parameters and OnboardingListener callback methods.
  • React Native SDK Reference: IncodeSdk JavaScript API: initialize, startOnboarding, startFlow, startWorkflow, flow listeners, runtime methods, Sections API, and result schemas.
  • Flutter SDK Reference: Dart wrapper API: IncodeOnboardingSdk.init, startOnboarding, and session configuration.
  • Xamarin SDK Reference: C# wrapper API: IncodeOnboarding.Initialize, StartOnboarding, and session configuration.
  • Cordova SDK Reference: JavaScript plugin API: IncodeSdk.initialize, startOnboarding, and session configuration.

What belongs here vs. elsewhere

This section covers API-level reference material only — method signatures, parameters, return values, and result schemas. It does not cover:


Was this page helpful?