Migrate from version 3 to 4

Learn how to migrate to the latest version of Smart UI if you have already integrated with version 3.

Migrate to version 4 of Smart UI in order to benefit from the following:

  • Faster loading due to a dramatically reduced bundle size.
  • Support for digital driver's licences (opt-in).
  • Improved error handling and reporting.
  • Support for uploading supporting documents.

Version 4 also updates the end-user experience for users in Indonesia:

  • When inputing an Indonesian document, users will be prompted to add their name, they will be provided with a second name screen where they can review their input.

Prerequisites

These instructions assume that you have already integrated with version 3 of Smart UI. If this is not the case, explore the migration guides for other versions.


Step 1: Update your <script> element

Update your <script> element to reference the latest version of Smart UI.

If you were using the minified bundle, your <script> element should look like:

<script src="https://assets.frankiefinancial.io/onboarding/v4/ff-onboarding-widget.umd.min.js"></script>

If you were using the non-minified bundle, your <script> element should look like:

<script src="https://assets.frankiefinancial.io/onboarding/v4/ff-onboarding-widget.umd.js"></script>

Step 2: Update your Content Security Policy

If your website uses a Content Security Policy (CPS) you will need to update it to allow img-src content from assets.frankiefinancial.io.


Step 3: Allow digital driver's licences

Update the configuration object that is passed to the initialiseOnboardingWidget() method to opt-in to allowing digital driver's licences.

If your configuration object does not contain the documentTypes key or you do not wish to allow digital driver's licences then you can safely ignore this step.

Replace the string value "DRIVERS_LICENCE" with the following object:

{
  "type": "DRIVERS_LICENCE",
  "digital": true
}
Before:
frankieFinancial.initialiseOnboardingWidget({
  config: {
    documentTypes: [
      "DRIVERS_LICENCE",
      // Other document types
    ],
    // Other configuration parameters
  },
  // Other initialisation parameters
});
After:
frankieFinancial.initialiseOnboardingWidget({
  config: {
    documentTypes: [
      {
        "type": "DRIVERS_LICENCE",
        "digital": true
      },
      // Other document types
    ],
    // Other configuration parameters
  },
  // Other initialisation parameters
});

Next steps

Version 4 can allow your users to upload supporting documents. To make use of this feature we recommend speaking to our team first.


What’s Next

Please read our configuration page for the full config

Did this page help you?