# WebSDK

# Introduction

The easiest way to get started with our solution is by using our WebSDK. We've put a lot of effort into improving the conversion rate of your users and have thought about even the little details that make a big difference. Here are a few reasons why you will love the WebSDK:

• It is highly customizable, so you can choose the steps you want, change the styles or even copy it entirely.
• It features a face liveness module that improves conversion rates and minimizes fraud.
• The design is adaptive and mobile friendly, so it's easy to use on any device.
• It gives users hints on how to better pass the flow, making it a smoother experience.
• You can continue using it on mobile so you're not tied to a desktop computer.
• It automatically refreshes when the status is changed, so you're always up-to-date.

# Integration

# Steps overview

To get started with our solution, follow these 3 simple steps:

• Step 1: [Dashboard] Set up your applicant levels or pick a predefined one from the options available (e.g. basic-kyc-level).
• Step 2: [Backend] Generate an Access token which you will pass to the WebSDK later.
• Step 3: [Frontend] Install an NPM package or use CDN version of the script. We also have a package for React. Then launch the SDK initialization function with the accessToken you generated in step 2.

# Generating access token

To initialize a WebSDK, you must generate a temporary access token, which you will pass to the WebSDK when you initialize it. This action must be performed on the server side. You also have to provide a unique and meaningful userId query parameter. It can be an external user ID in your system, or an email address. Do not randomly generate these IDs, unless you are testing.

# Frontend integration (general)

# 1a) Install the package - NPM

npm i @sumsub/websdk --save
# OR
yarn add @sumsub/websdk

Import the module

import snsWebSdk from '@sumsub/websdk';

# 1b) Install the package - Standalone

<script src = "https://static.sumsub.com/idensic/static/sns-websdk-builder.js"></script>

# 2) Create a container for the WebSDK on your page

<!-- iframe will be inserted as a child element -->
<div id="sumsub-websdk-container"></div>

# 3) Initialize a WebSDK

/**
 * @param accessToken - access token that you generated on the backend in Step 2
 * @param applicantEmail - applicant email (not required)
 * @param applicantPhone - applicant phone, if available (not required)
 * @param customI18nMessages - customized locale messages for current session (not required)
 */
function launchWebSdk(accessToken, applicantEmail, applicantPhone, customI18nMessages) {
    let snsWebSdkInstance = snsWebSdk.init(
            accessToken,
            // token update callback, must return Promise
            // Access token expired
            // get a new one and pass it to the callback to re-initiate the WebSDK
            () => this.getNewAccessToken()
        )
        .withConf({
            lang: 'en', //language of WebSDK texts and comments (ISO 639-1 format)
            email: applicantEmail,
            phone: applicantPhone,
            i18n: customI18nMessages, //JSON of custom SDK Translations
            uiConf: {
                customCss: "https://url.com/styles.css"
                // URL to css file in case you need change it dynamically from the code
                // the similar setting at Customizations tab will rewrite customCss
                // you may also use to pass string with plain styles `customCssStr:`
            },
        })
        .withOptions({ addViewportTag: false, adaptIframeHeight: true})
        // see below what kind of messages WebSDK generates
        .on('idCheck.stepCompleted', (payload) => {
            console.log('stepCompleted', payload)
        })
        .on('idCheck.onError', (error) => {
            console.log('onError', error)
        })
        .build();

    // you are ready to go:
    // just launch the WebSDK by providing the container element for it
    snsWebSdkInstance.launch('#sumsub-websdk-container')
}

function getNewAccessToken() {
  return Promise.resolve(newAccessToken)// get a new token from your backend
}

# ATTRIBUTES OF withConf PARAMETER

# ATTRIBUTES OF uiConf PARAMETER

# STRUCTURE OF documentDefinitions PARAMETER

documentDefinitions is a key-value object, where keys are idDocSetType and values are documentDefinition

{ idDocSetType: documentDefinition }

# Example

documentDefinitions: {
  IDENTITY: {idDocType: 'PASSPORT', country: 'GBR'}
}

# POSSIBLE idDocSetType VALUES

# ATTRIBUTES OF documentDefinition PARAMETER

# ATTRIBUTES OF withOptions PARAMETER

# Standalone working example

Below is a fully working example. Just substitute $ACCESS_TOKEN with the appropriate value (see steps above), save it to an HTML file and open it in your browser.

<html>
 <head>
  <title>WebSDK CDN Example</title>
 </head>
 <body>
	<script src="https://static.sumsub.com/idensic/static/sns-websdk-builder.js"></script>
	<div id="sumsub-websdk-container"></div>
</body>
</html>
<script>

function launchWebSdk(accessToken, applicantEmail, applicantPhone) {
    let snsWebSdkInstance = snsWebSdk.init(
            accessToken,
            () => this.getNewAccessToken()
        )
        .withConf({
            lang: 'en',
            email: applicantEmail,
            phone: applicantPhone,
            i18n: {"document":{"subTitles":{"IDENTITY": "Upload a document that proves your identity"}}},
            onMessage: (type, payload) => {
                console.log('WebSDK onMessage', type, payload)
            },
            uiConf: {
                customCssStr: ":root {\n  --black: #000000;\n   --grey: #F5F5F5;\n  --grey-darker: #B2B2B2;\n  --border-color: #DBDBDB;\n}\n\np {\n  color: var(--black);\n  font-size: 16px;\n  line-height: 24px;\n}\n\nsection {\n  margin: 40px auto;\n}\n\ninput {\n  color: var(--black);\n  font-weight: 600;\n  outline: none;\n}\n\nsection.content {\n  background-color: var(--grey);\n  color: var(--black);\n  padding: 40px 40px 16px;\n  box-shadow: none;\n  border-radius: 6px;\n}\n\nbutton.submit,\nbutton.back {\n  text-transform: capitalize;\n  border-radius: 6px;\n  height: 48px;\n  padding: 0 30px;\n  font-size: 16px;\n  background-image: none !important;\n  transform: none !important;\n  box-shadow: none !important;\n  transition: all 0.2s linear;\n}\n\nbutton.submit {\n  min-width: 132px;\n  background: none;\n  background-color: var(--black);\n}\n\n.round-icon {\n  background-color: var(--black) !important;\n  background-image: none !important;\n}"
            },
            onError: (error) => {
                console.error('WebSDK onError', error)
            },
        })
        .withOptions({ addViewportTag: false, adaptIframeHeight: true})
        .on('idCheck.stepCompleted', (payload) => {
            console.log('stepCompleted', payload)
        })
        .on('idCheck.onError', (error) => {
            console.log('onError', payload)
        })
        .onMessage((type, payload) => {
            console.log('onMessage', type, payload)
        })
        .build();
    snsWebSdkInstance.launch('#sumsub-websdk-container')
}

function getNewAccessToken() {
  return Promise.resolve($NEW_ACCESS_TOKEN)
}

    launchWebSdk($ACCESS_TOKEN)
</script>

# React integration

# 1) Install websdk-react

import SumsubWebSdk from '@sumsub/websdk-react'

# 2) Initialize WebSDK

<SumsubWebSdk
  accessToken={accessToken}
  expirationHandler={accessTokenExpirationHandler}
  config={config}
  options={options}
  onMessage={messageHandler}
  onError={errorHandler}
/>

# WebSDK messages

When providing the on handler you will receive messages from the WebSDK for selected message type (all of them are prefixed with idCheck.):

// id of the iframe in the current context 
{}

{}

{
  "idDocSetType": "$idDocSetType",
  "types": ["$idDocType1", "$idDocType2"] 
  }

{"step": "$idDocSetType"}

{"applicantId": "$id"}

{}

{
 "reprocessing": false,
 "levelName": "$levelName",
 "createDate": "$createDate",
 "expireDate": "$expireDate",
 "reviewStatus": "$reviewStatus",
 "autoChecked": false
 } 

{}

{}

{
  "action": "$actionType"
  "applicantActionId": "$id"
  "answer": "$answer"
}

{
  "answer": "GREEN" 
}

{
  "height": 159 
}

{}

{}

{}

{
  "code": "$error",
  "msg": "Error message"
}

{
  "code": "$warning",
  "msg": "Warning message"
}

# Receiving verification results

Your backend receives results via a web-hook mechanism. You can get the results via email, Slack or Telegram. But for production mode, we recommend setting up a web-hook endpoint that we would call when necessary:

• We need a webhook URL from you where we can send your results. You can set up webhooks in developer's space.
• We may send several types of webhooks, but the one that will be important to you is the one described in the "Getting verification results" section. We encourage you to carefully get accustomed to this section, since there are quite a few options for what the results may look like.
• If you want to manually check the applicant status, you can always do it by this method. However, we don't recommend using polling as base method for getting verification results but rather strongly encourage the webhook mechanism. If for some reason you missed the webhooks, don't worry: we make a note of everything that was attempted to be sent, and can resend failed webhooks at any point in time. If the webhook request fails, we attempt to resend it four times: after 5 minutes, 1 hour, 5 and 18 hours until request succeeds. Check the createdAt field of webhook payload to make sure that you're getting relevant applicant status.
• You can monitor webhook statuses and resend them manually on the API Health page of the dashboard.

# Getting the production key

# How can we get the production key?

Ensure that:

• Integration on the sandbox environment is completed, works and meets your requirements
• There are no dev console errors or warnings
• You saved our applicantIds to your database and matched your users
• You received and successfully processed test webhooks from our side
• You know how to correlate results received in the webhook payload with your users

# Moving to production

Please provide us with information on expected amount of incoming users per hour/day/month if possible.

Note that settings won't be transferred from sandbox environment to production automatically. So remember to:

• Set up webhooks at the Dev Space tab of the production dashboard
• Tune regulation rules at Global settings tab of the dashboard
• Create and use production App Token and Secret Key for API authorization

# Customization

All customizations are done from our dashboard. You can customize styles (via custom CSS), navigation, etc. To change all SDK texts by locales, you should use SDK Translations tab. See hints and guides in the dashboard for more details.

# Twilio integration

If you want your users to send verification links via SMS to their mobile devices or use your Twilio credentials for Phone verification, you have to set it up at the dashboard and make sure that target regions are enabled in your twilio account here.

# Tips & Tricks

# WebView usage

For initializing WebSDK within mobile app using WebView make sure that

• WebView is able to access device local storage and initialize camera (for older iOS versions camera can be accessed only from Safari browser or WebView withSFSafariViewController)
• Make sure that HTML5 video playback is allowed (we're using some instructions within <video> tags): if video-instructions are not played, try using WebChromeClient to enable video playback
• Autoplay in fullscreen mode is disabled and allowsInlineMediaPlayback is set as true for WebView with running SDK

# Camera access

If you're experiencing troubles with camera access for liveness, please make sure that

• Feature-Policy header for your webpage/frame or any other container with SDK doesn't have any restrictions for initializing camera like value camera 'none'.
• Permissions-Policy header doesn't restrict access to a camera and microphone (for some cases) and if allow is set check for "camera; microphone" values.
• Your website is being run on secure https connection.

# Placement

For the best conversion, try to initialize SDK by the center of the screen, so it would be easier for users to pay attention to instructions during verification process.

# FAQ

# How can we get the applicantId?

Two ways:

• When user completes a first page, an applicant is created. At this moment, we send webhook to your endpoint with type applicantCreated. Its payload will contain the applicantId
• GET /resources/applicants/-;externalUserId=${externalUserId}/one

# Where can I find a list of supported locales?

For more information on the supported languages, refer to this article.