@iproov/html5 v2.0.1

iProov Web SDK v2.0.0

📖 Table of contents

• Introduction
• Contents
• Upgrading from earlier versions
• Registration
• Installation
• Get started
• Options
• Slots
• Events
• Localization
• Help & support

🤳 Introduction

The iProov Web SDK is the iProov client for web browser based authentication. It can be integrated in a number of ways to support your web journeys for onboarding and authentication. How to use iProov web in your user journey.

Please note that to use the Web SDK you will require Service Provider credentials. You can set these up automatically after registering your company on our portal.

You will need to generate a token from your back-end to use with the iProov Web SDK. You can use the API documentation to make the relevant API calls and return the token to your front-end.

📖 Contents

This repository contains a demo showing an example of a backend and frontend integration. In these examples, the token is generated and validated using AJAX (in the register/login demo) and form submission (for the integration examples) by passing the following data to the backend:

• user_id - the email address provided by the user
• action - the specific endpoint to call:
  • token - generate a unique 64 character token for the client
  • validate - check the validity of the result provided by the client

⬆️ Upgrading from earlier versions

Please note that there is new name for the NPM package and URL for the script tag. If you are upgrading from v1 or v2-beta, please ensure you update you integration to use the new name or URL as described in the installation section below.

A few of the options have changed from easiler versions so be sure to check the current supported list of options when upgrading.

✍️ Registration

You can obtain API credentials by registering on the iProov Portal.

📲 Installation

Script Tag

The simplest and fastest method of integrating with the iProov Web SDK is to reference it in a script tag using our NPM package hosted on a CDN such as jsDelivr or UNPKG.

jsDelivr

<script src="https://cdn.jsdelivr.net/npm/@iproov/web"></script>

UNPKG

<script src="https://unpkg.com/@iproov/web"></script>

NPM Package

The npm package @iproov/web allows for integration of the iProov Web SDK. It makes use of the Web Components APIs which are supported by most modern browsers and uses the Polymer Project to add support where they are not yet available.

Setup

Install the package as a dependency. You can use Yarn or NPM to do this.

yarn add @iproov/web

npm i @iproov/web --save

After you have installed the @iproov/web package, you must then include the code into your project ideally at the root of your application:

require("@iproov/web")

It's as simple as that to include the iProov Web SDK. You now need to inject the web component by one of the integration methods shown below.

🚀 Get started

Backend

To make use of this SDK you will require integration with the back-end iProov service. To access credentials and an integration guide, please visit portal.iproov.com.

When starting an iProov transaction (or claim), you would first need to generate an enrolment or verification token, which can be done as part of the page load or with AJAX. You would then need to pass the token to your frontend to initialise the iProov Web SDK.

After receiving the result from the SDK, you must then confirm its authenticity by calling the validate API from your backend on page submission or with AJAX.

⚠️ The REST API should always be called from your backend so as to never expose your secret to your client application.

Always call the validate API from your backend after receiving a result; never trust the result provided directly from the HTML client.

Frontend

Once an iProov token has been generated by your backend, you should pass it as an attribute to the custom element using one of the integration methods described below. After a successful iProov, the result must be validated by the backend before granting the user any privileges.

HTML

The simplest way to pass the token to iProov is to include it as an attribute to the <iproov-me> HTML tag as shown here:

<iproov-me token="***YOUR_TOKEN_HERE***"></iproov-me>

JavaScript

The <iproov-me> element can alse be injected into the page with the token:

window.addEventListener("WebComponentsReady", function(event) {
  const iProovMe = document.createElement("iproov-me")
  iProovMe.setAttribute("token", "***YOUR_TOKEN_HERE***")
  document.getElementById("your-container-id").appendChild(iProovMe)
})

jQuery

The HTML can also be injected directly onto the page as in this jQuery example:

window.addEventListener("WebComponentsReady", function(event) {
  $("#your-container-id").append($('<iproov-me token="***YOUR_TOKEN_HERE***"></iproov-me>'))
})

There are also the following framework specific example integrations available on the wiki:

• Angular v7
• React v16
• Vue v2

Note that JavaScript methods are run after the WebComponentsReady event to ensure that the SDK is ready to be injected.

⚙ Options

The behaviour of the iProov Web SDK can be altered by setting the following options as attributes of the <iproov-me> tag in the same way as the token.

Base URL

You can change the backend server you are attempting to iProov against by passing the base_url property. This needs to point to the same platform used for generating tokens (defaults to the EU platform if not defined). Reverse proxies are supported and a custom path to the WebSocket endpoint can be used, for example: https://custom.domain.com/custom-path/socket.io/v2/

<iproov-me token="***YOUR_TOKEN_HERE***" base_url="https://eu.rp.secure.iproov.me"></iproov-me>

Assets URL

Currently, external resources are loaded from our CDN at iproov.app. This may cause issues with firewall rules and custom reverse proxy configurations and therefore this option is available to use.

These resources include WASM files, UI assets, animations, and web workers relevant to encoding and face finding on the client side.

Some of these files cannot be packaged as part of a JS bundle, and in some cases it makes sense for us to be able to ship updates without requiring code changes the integrator's end.

<iproov-me token="***YOUR_TOKEN_HERE***" assets_url="https://cdn.iproov.app/assets"></iproov-me>

Logo

You can use a custom logo by simply passing a relative link or absolute path to your logo. Ideally, the logo would be in an SVG format for scaling but you can use any web safe image format. If you don't pass a logo, the iProov logo will be shown by default. If you do not want a logo to show pass the logo attribute as null.

<iproov-me token="***YOUR_TOKEN_HERE***" logo="https://www.iproov.com/images/iproov_logo.svg"></iproov-me>

Custom Title

Specify a custom title to be shown. Defaults to show an iProov-generated message. Set to empty string "" to hide the message entirely. You can also pass in %@ characters which will be mapped in this order to type (Enrol or Verify), user_name (the user_name you passed when generating the token), sp_name (the service provider you used to generate the token).

Note: iProov-generated messages are passed through our translators. Passing a custom title will prevent this and you will need to provide the translated version.

<!-- Set the title to a plain string -->
<iproov-me token="***YOUR_TOKEN_HERE***" custom_title="iProov Ltd" />

<!-- Hide the title, empty string, "null" or "false" can be used. Must be a string! -->
<iproov-me token="***YOUR_TOKEN_HERE***" custom_title="" />

<!-- Build dynamic string with type, user_name and sp_name-->
<!-- i.e. Below would generate "Enrol AS andrew@iproov.com TO iProov" -->
<iproov-me token="***YOUR_TOKEN_HERE***" custom_title="%@ AS %@ TO %@" />

Colours

You can customise the look and feel of the main layout by changing the following options. You can pass a literal value i.e. red, RGB i.e. rgb(230, 245, 66) or a hex value i.e. #e6f542.

loading_tint_color = "#5c5c5c" // The app is connecting to the server or no face found. Default: grey (#5c5c5c)
not_ready_tint_color = "#f5a623" // Cannot start iProoving until the user takes action (e.g. move closer, etc). Default: orange (#f5a623)
ready_tint_color = "#01bf46" // Ready to start iProoving. Default: green (#01bf46)

The example below changes the default grey no face to #4293f5 (blue), giving feedback like "Move Closer" to red rgb(245, 66, 66) and starting to purple.

<iproov-me
  token="***YOUR_TOKEN_HERE***"
  loading_tint_color="#4293f5"
  not_ready_tint_color="rgb(245, 66, 66)"
  ready_tint_color="purple"
></iproov-me>

Prefer App

Use this collection of settings to handle launching a native app containing the iProov SDK on mobile devices.

• prefer_app
• prefer_app_options

The prefer_app setting converts the scan button into an app launch URL which will launch the iProov app or iProov SDK when within a WebView. The following values are allowed and multiple can be used when separated by a comma:

• always
• ios
• android
• ios-webview
• android-webview

<iproov-me token="***YOUR_TOKEN_HERE***" prefer_app="android-webview,ios-webview"></iproov-me>

The prefer_app_options setting accepts a base64 encoded JSON object of iProov native SDK options as defined in the iOS and Android documentaion:

iProovMe.setAttribute(
  "prefer_app_options",
  btoa(JSON.stringify({ ui: { scan_line_disabled: true, filter: "classic" } }))
)

Allow Landscape

Mobile devices are by default prevented from iProoving while in landscape. This feature can be disabled by passing allow_landscape true with your component as shown below.

<iproov-me token="***YOUR_TOKEN_HERE***" allow_landscape="true"></iproov-me>

Show Countdown

By setting show_countdown to true, a countdown will be shown to the user before scanning actually starts. If this is set to false, when the users face becomes properly aligned the scanner will start in 2 seconds as long as the users face is still properly aligned. By default, show_countdown is false. The example below shows how to enable the countdown.

<iproov-me token="***YOUR_TOKEN_HERE***" show_countdown="true"></iproov-me>

Kiosk Mode

Note this setting enables a feature which is in alpha and still under active development.

For deploying iProov on tablets or fixed hardware such as laptops and desktop devices. Enables snap to face and increases matchable range.

Set to true to enable; omit the setting to keep disabled.

A known issue is that kiosk mode currently has display issues in portrait mode, this will be resolved in a later release.

<iproov-me token="***YOUR_TOKEN_HERE***" kiosk_mode="true"></iproov-me>

📥 Slots

Slots allow the HTML content shown before and after the iProov fullscreen experience to be customised and styled for a more seamless visual integration. The folloing examples show different ways to include some of the most commonly used slots.

HTML

The simplest way to add a slot is to include it within the <iproov-me> HTML tag as shown in the example below:

<iproov-me token="***YOUR_TOKEN_HERE***">
  <div slot="ready">
    <h1 class="iproov-lang-heading">Ready to iProov</h1>
  </div>
  <div slot="button">
    <button type="button">Scan Face</button>
  </div>
</iproov-me>

In order to style and manipulate your slots, you can add custom classes and IDs which can be accessed from your CSS and JavaScript.

JavaScript

You can also build up the slots with JavaScript before injecting the Web Component:

window.addEventListener("WebComponentsReady", function(event) {
  const iProovMe = document.createElement("iproov-me")
  iProovMe.setAttribute("token", "***YOUR_TOKEN_HERE***")
  const ready = document.createElement("div")
  ready.setAttribute("slot", "ready")
  ready.innerHTML = '<h1 class="iproov-lang-heading">Register your face</h1>'
  iProovMe.appendChild(ready)

  const button = document.createElement("button")
  button.setAttribute("slot", "button")
  button.innerText = "Start face scan..."
  iProovMe.appendChild(button)

  document.getElementById("your-container-id").appendChild(iProovMe)
})

With jQuery, the entire Web Component can be injected with slots using HTML syntax, for example:

window.addEventListener("WebComponentsReady", function(event) {
  const iProovMe = $('<iproov-me token="***YOUR_TOKEN_HERE***"></iproov-me>')

  iProovMe.append('<div slot="ready"><h1 class="iproov-lang-heading">Register your face</h1></div>')
  iProovMe.append('<button type="button" slot="button">Start face scan...</button>')

  $("#your-container-id").append(iProovMe)
})

To allow language keys to be dynamically applied to slots, special class names must be applied to your slots when customising. Headings must have .iproov-lang-heading and terms (message, reason etc) must have .iproov-lang-term.

h3 tags and the div element are allowed without classes, this functionality has been deprecated and will be removed in 2.1.0

<div slot="passed">
  <h3 class="iproov-lang-heading">Passed</h3>
  <div class="iproov-lang-term">You have iProoved successfully</div>
</div>

When customising any slots with button elements the type must be set to button

The following is the complete list of slots can be used with the <iproov-me> web component and have associated events:

Slots can be embedded as HTML or injected with JavaScript.

📆 Events

There are a set of CustomEvents that can be used to integrate bespoke functionality. Events are bound directly to the <iproov-me> element after the WebComponentsReady event is called on the window.

Details

Every event has a detail property which contains data relating to that event. The token is present for every event:

{
  "token": "Your Generated Token"
}

The available events are detailed below with any extra properties that are supplied:

All possible properties of the event's detail property are described below:

† - Not available when running with the prefer_app setting in native bridge mode.

In the case of the aborted, failed, error and unsupported events, the feedback code can be used for dealing with special cases and the reason can be displayed to the user. The following are some of the possible responses:

Listeners

It is recommended that you listen for at least the ready and unsupported events as one of them will always be called so you can determine if iProov is supported or not:

document.querySelector("iproov-me").addEventListener("ready", function(event) {
  console.log("iProov is ready")
})
document.querySelector("iproov-me").addEventListener("unsupported", function(event) {
  console.warn("iProov is not supported: " + event.detail.reason)
})

As all of the event details follow the same structure, they can be handled by a single function if desired:

const iProovMe = document.querySelector("iproov-me")
iProovMe.addEventListener("ready", iProovEvent)
iProovMe.addEventListener("started", iProovEvent)
iProovMe.addEventListener("aborted", iProovEvent)
iProovMe.addEventListener("streamed", iProovEvent)
iProovMe.addEventListener("progress", iProovEvent)
iProovMe.addEventListener("passed", iProovEvent)
iProovMe.addEventListener("failed", iProovEvent)
iProovMe.addEventListener("error", iProovEvent)
iProovMe.addEventListener("unsupported", iProovEvent)
iProovMe.addEventListener("permission", iProovEvent)
iProovMe.addEventListener("permission_denied", iProovEvent)

function iProovEvent(event) {
  switch (event.type) {
    case "aborted":
    case "error":
    case "unsupported":
    case "permission":
    case "permission_denied":
      console.warn("iProov " + event.type + " - " + event.detail.reason)
      break
    case "progress":
      console.info(event.detail.message + " (" + event.detail.progress + "%)")
      break
    case "passed":
    case "failed":
      console.log("iProov " + event.detail.type + " " + event.type)
      break
    default:
      console.log("iProov " + event.type)
  }
}

If using jQuery, you can attach to all the events in one go:

$("iproov-me").on("ready started aborted streamed progress passed failed error unsupported", iProovEvent)

🌎 Localization

The Web SDK ships with English strings only. If you wish to customise the strings in the app or localize them into a different language, you can do this by supplying language overrides as JSON configurations. All language files have the same keys and only the values of those keys will be shown.

• View the default language file with all keys and langauge striengs

You can customise the language by supplying the language key as an attribute to your iProov component. The keys value must be valid JSON and passed as a string. This is then converted and merged with the default language overriding any given keys. See below for some examples.

Override language strings

window.addEventListener("WebComponentsReady", event => {
  const iProovMe = document.createElement("iproov-me")
  iProovMe.setAttribute("token", "***YOUR_TOKEN_HERE***")

  const customLanguage = `{
    "iproov_success": "You passed!",
    "prompt_loading": "Its loading"
  }`
  element.setAttribute("language", customLanguage)

  // inject iproov element into page
  document.getElementById("your-container-id").appendChild(iProovMe)
})

Load language file

window.addEventListener("WebComponentsReady", async event => {
  async function getLanguage(path) {
    const response = await fetch(path)
    const language = await response.text()

    return language
  }

  const iProovMe = document.createElement("iproov-me")
  iProovMe.setAttribute("token", "***YOUR_TOKEN_HERE***")

  const languageFile = "" // local or external path to language file
  const customLanguage = await getLanguage(languageFile)
  element.setAttribute("language", customLanguage)

  // inject iproov element into page
  document.getElementById("your-container-id").appendChild(iProovMe)
})

There are also some framework specific examples on the Angular and React wiki pages.

🌐 Browser Support

iProov's Web SDK makes use of the following technologies:

• WebGL
• WebSockets
• WebAssembly
• WebComponents

It also requires a front facing camera with permission granted to use it.

The table below is a best-effort representation of minimum feature support across browsers:

If the device attempting to iProov doesn't meet the minimum requirements, the unsupported event is emitted. See the events section for more details.

Developers can use the IProovSupport check component to ensure their users have the correct hardware and software to use the Web SDK before embedding the web component. If the user device is unsupported, the integrator can send the user down an althernative journey.

IProovSupport is a slim and separate component to the main IProovMe web component.

To benefit from tree-shaking in a module-based build environment you can use the named import:

// Just load the support component:
import { IProovSupport } from "@iproov/web"
const optionalLogger = console
const supportChecker = new IProovSupport(optionalLogger)

For script tag integrations, IProovSupport is available on the window object once included:

const supportChecker = new IProov.IProovSupport()

IProovSupport can check just for the required APIs on the user's browser, using either event or Promise based APIs:

const supportChecker = new IProovSupport()
supportChecker.addEventListener("check", ({ supported, granted }) => {
  if (supported === false) {
    // go to fallback UX
  }
  if (supported && granted) {
    // full permission and granted, we can definitely iProov!
  }
  if (supported && granted === null) {
    // browser API support, but we haven't run a permission check (see checkWithPermission)
  }
  if (supported && granted === false) {
    // browser API support, but camera access denied - try again or advise user before proceeding
  }
})
const { supported, granted } = await supportChecker.check()

...or to carry out a complete lightweight check for camera access with user interaction, this can pre-set the required permissions for iProoving, save some bandwidth, and provide a cleaner user journey if camera access isn't possible:

const supportChecker = new IProovSupport()
document.querySelector("#check-button").addEventListener("click", async () => {
  const { supported, granted } = await supportChecker.checkWithPermission()
})

If .checkWithPermission() is run and permission is granted and cached within the browser, future interaction is often not required and we can tell if permission has been granted using a soft .check().

Note that browsers have varying regimes to protect against device fingerprinting and to ensure user privacy. Repeated calls to getUserMedia or the Permissions API can result in prompt blockage, or the redaction of media devices, which can return inaccurate results. Our advice is therefore to avoid running multiple checks, in quick succession, on the same page. Therefore, please avoid automatic or accidental repeat calls to check or checkWithPermission, especially without user interaction.

The following events can be emitted from IProovSupport:

const supportChecker = new IProovSupport()
const onCheckResult = ({ supported, granted, tests }) => ({})
const onUnsupported = ({ supported, tests }) => ({})
const onPermissionWasGranted = ({ tests }) => ({})
const onPermissionWasDenied = ({ tests }) => ({})
supportChecker.addEventListener("check", onCheckResult)
supportChecker.addEventListener("unsupported", onUnsupported)
supportChecker.addEventListener("granted", onPermissionWasGranted)
supportChecker.addEventListener("denied", onPermissionWasDenied)
// The `tests` object consists of the following options:
// null if unchecked, true if supported, false if not supported:
const possibleTests = {
  videoInput: null,
  wasm: null,
  userMedia: null,
  mediaStreamTrack: null,
  frontCamera: null,
  fullScreen: null,
  webgl: null,
}

Using the support checker is the best and canonical way to detect whether a browser is supported.

WebViews

The iProov SDKs can work with WebView based apps using the Native Bridge feature which allows the Web SDK to seamlessly launch the native SDKs embedded within the app. Use this approch for the best results by setting the Prefer App option.

On Andrid, it is possible to use the Web SDK directly inside a WebView. For it to work as expected, the app must correctly allow fullscreen mode, otherwise the user interface will not display correctly. These WebView examples demonstrate how to ensure fullscreen is allowed and configured correctly inside your Android app.

For more information on using iProov within a WebView based app, see the following Wiki pages:

• Java Fullscreen WebView Example
• Kotlin Fullscreen WebView Example
• iOS Native Bridge Intergration Guide

❓ Help & support

You may find your question is answered on our Wiki pages.

For further help with integrating the SDK, please contact support@iproov.com.