DocumentationAPI Reference
SDK reference · Incode Web SDK 2 Reference / Reference

Reference

This section provides reference material for WebSDK 2.0: exact function signatures, config and state shapes, and fixes for problems integrators commonly hit. Use it alongside the guided pages, not instead of them.

  • API Reference: The full API surface: setup(), createSession(), initializeSession(), the <incode-flow> component and its FlowConfig, and pointers to every headless manager and module component. Start here when you need exact parameter names, types, and defaults.

  • TypeScript Types: The SDK's type definitions: how to import per-module Config/State/Manager types, the discriminated-union pattern used for state (with PhoneState as the worked example), and SDK-wide types like WarmupConfig, SessionInitOptions, Features, SpinnerConfig, and FinishStatus.

  • Troubleshooting: Symptom-to-fix tables organized by area: camera access, WASM loading, session/token errors, iframe embedding, mobile Safari quirks, Content Security Policy, styling, build/TypeScript errors, networking, and flow-level edge cases, such as a selfie stuck in closed or an ID capture stuck on capture.success.

Where to start

  • If you know what you're building and just need the exact call signature, go to API Reference.

  • If you're wiring up type-safe state handling, go to TypeScript Types.

  • If something isn't working, check Troubleshooting before opening a support ticket. That page covers most integration issues, including camera permissions, WASM MIME types, CSP, and CORS.

Was this page helpful?