Migrate from WebSDK 1.0 to WebSDK 2.0

Achieve better performance by using WebSDK 2.0.

The WebSDK 2.0 represents a complete rewrite of the entire SDK, incorporating new technologies and introducing changes that could not be implemented within the framework of the old codebase. While we have strived to maintain maximum compatibility with the old SDK to facilitate a smooth transition between versions, some actions on your part are still required.

Migration steps

  1. Ensure you are using the latest version of our library.
    • This should be version 2.3.1 or higher.
    • This step does not upgrade your SDK to WebSDK 2.0, meaning you can update the library version and continue using the old SDK while experimenting with the new one.
  2. If you are using any SDK events, verify that you are using compatible versions.
    • stepCompleteonStepCompleted
    • applicantStatusonApplicantStatusChanged
  3. CSS customizations are no longer supported. Now, you can customize the SDK via the customization editor in our Dashboard.
    • CSS customizations will continue to work in the old SDK.
    • Many CSS customizations can be automatically converted to the new format. To do this, you can create a new customization and select Import stylesImport styles from WebSDK 1.0 in the top-right corner.
    • You can also import website styles through the Import styles menu.
  4. Once you have completed the previous steps, you can enable the new SDK for a specific level. To do this, go to the level settings and select Enable WebSDK 2.0 for this level.

📘

The following are not yet supported in the WebSDK 2.0:

  • Selfie with a document checks.
  • Videoident.
  • Verification levels that have the Module option selected in the level settings.
  • Full KYB (the launch is expected at the end of July, 2024).

Gradual migration

If you are already using the WebSDK, you likely want to migrate gradually, level by level. This can easily be achieved as the activation of the WebSDK 2.0 is done through a toggle in the settings of each level. Thus, you can complete the first three steps from the section above and then gradually switch your levels to the new SDK.