Incode React Native SDK reference
Orientation and routing hub for the Incode React Native SDK - identity capture, liveness, NFC, face authentication, dashboard flows, and native UI modules for Android and iOS.
The Incode React Native SDK exposes Incode's native onboarding SDKs through a typed JavaScript API. Apps initialize IncodeSdk, configure a dashboard flow or local flowConfig, subscribe to step events, and then launch native UI for ID capture, selfie, face match, NFC, consent, scoring, approval, and other verification modules.
This page routes you to the page you need next. If you are starting fresh, begin with Getting Started and Common Implementation Patterns.
Start here
| If you want to... | Go to |
|---|---|
| Add the SDK to your project | Getting Started |
| Get an onboarding flow running | Common Implementation Patterns |
| Upgrade an existing integration | Migration Guide |
| Check the available modules | Modules |
| Check the module results | Results |
| Customize colors, text, and UI | Customization |
| Browse the full public API | API Reference |
| Solve a build problem | Known Issues |
How the SDK fits together
The SDK supports three integration paths. They differ in where the flow is configured and how much orchestration your app owns.
Path 1: Online flow
Build a flow on the Incode Dashboard, pass its configurationId through sessionConfig, and call startFlow() or startWorkflow(). The SDK owns the native UI from the first screen to the last and returns progress through listeners.
See Common Implementation Patterns.
Path 2: Local full onboarding flow
Build a local flowConfig array with modules such as IdScan, SelfieScan, and FaceMatch, then pass it to startOnboarding(). The SDK runs the configured modules in order and returns the final flow status.
See Common Implementation Patterns.
Path 3: Section-by-section flow
Create a session with setupOnboardingSession(), run one or more startOnboardingSection() calls, and close the session with finishOnboardingFlow(). Use this when your app needs to show custom screens or business logic between Incode modules. You can start multiple sections, but only one at a time; startOnboardingSection accepts the same config and modules as startOnboarding.
See Common Implementation Patterns.
Variants
Install the package variant that matches the features you need.
| Variant | Package version suffix | Description |
|---|---|---|
| Standard | none | Base SDK package. |
| Streaming | -vc | Enables streaming camera frames during ID and Selfie capture. |
| Face Login | -l | Adds Face Login APIs. |
| NFC | -nfc | Adds NFC scanning for passports or supported ID chips. |
What the SDK can do
- Identity capture - ID scan, document capture, OCR extraction, and manual review screens.
- Liveness and biometrics - selfie, video selfie, face match, face authentication, and Face Login.
- NFC / e-passport - read and validate supported NFC chip data.
- Compliance steps - consent, government validation, watchlists, AES, user score, and approval.
- Customization - theming, localization, close-button behavior, UX config, and dynamic strings.
Need help?
- Hit a build or runtime error? See Known Issues.
- Looking for a method or parameter? See API Reference.
- Looking for a module payload? See Results.
- Still stuck? Contact your Incode representative or email [email protected].