The Incode Web SDK integrates identity verification directly into your custom web application. You host the verification UI inside your own app, using the SDK's JavaScript methods to control the flow, handle events, and customize the user experience.
This approach gives you the most control of any web integration method. It also requires the most development effort and is best suited to teams with dedicated front-end and back-end developers.
How it works
- Your backend starts an onboarding session and returns a session token to your front end.
- Your front end initializes the Web SDK with that token.
- The SDK renders verification modules (ID scan, selfie, and so on) directly inside your web app.
- You handle module completion events and control flow progression in your application code.
- Your backend fetches results once the session is complete.
Prerequisites
Complete the Dashboard setup steps in Web Integration Overview before starting this integration. These cover creating a Workflow, adding the Data Sharing Consent module, enabling redirect desktop to mobile, and obtaining your API credentials.
In addition, you'll need:
- A front-end web application (framework-agnostic; React, Vue, Angular, and vanilla JS are all supported).
- HTTPS (required for camera and microphone access in browsers).
Get started
For installation, initialization, method reference, and full integration walkthroughs, see the Web SDK 2.0 Reference. If you are still using Web SDK 1.x, refer to Web SDK Reference and the considerations below.
Web SDK 1.x Considerations
Consider the following as you decide whether the Incode Web SDK is right for your implementation:
- Integrating the Web SDK is best suited for experienced front-end and back-end development teams. If you're unfamiliar with web development, using our low-code or no-code integration guides might better suit your needs.
- The Incode Web SDK is compatible with most front-end development frameworks. However, some project configurations might require specific settings.
- Full SDK integration is only compatible with Flows. Workflows are not currently supported.
- Ensure you use the latest version of the Incode Web SDK in your integration to access all features, benefits, and security updates.
- Your web application and development server must run over HTTPS to ensure correct execution of all SDK methods.
Supported browsers
The Web SDK is designed for mobile devices and mobile browsers:
- Google Chrome for Android
- Safari for iOS
While it works on desktop browsers, it is not recommended for desktop-focused web applications. Webviews and browsers launched inside social media or email apps are NOT supported.