@verifai/websdk

Verifai WebSDK

Install

# with npm
npm install @verifai/websdk --save

# or with yarn
yarn add @verifai/websdk

Usage

HTML

<div id="verifai-mount"></div>

ES modules

import WebSDK from '@verifai/websdk'

const config = {
  // For the token look at: https://docs.verifai.com/sdk/web/
  token: '<OTP_TOKEN>',

  onSuccess: sessionID => {
    // Here you can get the Verifai result.
    // And also clear the Verifai session.
  },

  onCanceled: sessionID => {
    // Here your customer canceled the Verifai flow
    // And you can clear the Verifai session
  }
}
// Get the element Verifai should be mounted on
const elem = document.getElementById('verifai-mount')

// Create a WebSDK object
const webSDK = new WebSDK(config, elem)

// Start the SDK
webSDK.start()

UMD

Load the SDK UMD

<script src="verifaiSDK/umd/verifai-websdk.js"></script>

By loading the UMD script the Verifai global is made available

Now you can create the config and start the SDK

See ES Modules for an example config object

const config = {...}
const elem = document.getElementById('verifai-mount')

// Create a WebSDK object
const webSDK = new Verifai.WebSDK(config, elem)

// Start the SDK
webSDK.start()

WebSDK methods

Constructor

WebSDK(config: Object, elem: DOMElement)

Creates instance of the webSDK

Example:

See ES Modules for an example config object

const config = {...}
const elem = document.getElementById('verifai-mount')
const webSDK = new WebSDK(config, elem)

setConfig

setConfig(config: Object)

Shallow merges the given config with the already set config on the sdk instance.

Example:

const webSDK = new WebSDK({
  onSuccess: sessionID => console.info(sessionID),
  onCanceled: sessionID => console.warn(sessionID)
}, elem)

webSDK.setConfig({
  token: '<OTP_TOKEN>'
})

webSDK.start()

start

start()

Starts the sdk flow (opens modal)

Example:

See ES Modules for an example config object

const config = {...}
const elem = document.getElementById('verifai-mount')
const webSDK = new WebSDK(config, elem)

webSDK.start()

More documentation

For more configuration and options you can see the documentation.

Demo

Want to try it out first? There is a demo available at: demo.websdk.verifai.com.

About Verifai

Please visit our website for more information about this and our other products: verifai.com.