Web Client

Jumio provides a turnkey web client that you can provide to your end users to guide them through the customer journey. The URL to the web client is available from the web:href value of the response from the account creation or update call, as shown in the following example:

Copy
Example Web Client URL

{
   "timestamp": "2022-11-28T23:45:02.536Z",
   "account": {
      "id": "572ac7b5-9f83-409d-ba8e-f0014e411c7e"
   },
   "web": {
      "href": "https://greenunion.web.amer-1.jumio.ai/web/v4/app?authorizationToken=eyJhbGciOiJIUzUxMiIsInppcCI6IkdaSVAifQ.H4sIAAAAAAAA_5XOMQ7CMAwF0LtkxpKdOk7MxsjKDRInYWkBiUogIe5O2huw_v_09T-uvU-rOzoSUYka0XNSd3DZ7FxHHqLPFksA7WkCRq1QcmrQEYkbE1lsG98xU4-k5IFMCnDzHcrECFWqEVoVLWngV2__cLu0PvTj_lyXfIP1vlzB8jz7rduHvHRGDAmIMQB7GSeFK0zGOan2ZiG57w9fvJLI7AAAAA.0NpDK192_6kMSYfxFuqHPFkhdsKQBqieRvSqt3XAGLWRe7Y8u0aJalMa8TLEY8eA0XEw4TqRapVLDraRHUz4kQ"
    },

   ...
You need to define a subdomain in the Jumio Portal under Settings > Identity Verification > Application Settings > Domain Name in order to successfully generate a web.href. See also: Application Settings.

You can provide this URL to your customer in several ways:

  • Within an iFrame on a web page in your own application.

    See Embedding in an iFrame.

  • As a link on your web page that opens a new browser tab or window.
  • As a link shared securely with the end user.
  • In a native webview.

    See Embedding in a WebView.

What is presented to the end user in the web client depends on:

  • The workflow that was specified in the account creation or update API call. Different workflows require different credentials. The web client will guide the user to capture and upload the credentials that are required for the workflow.

  • The Identity Verification Settings that have been configured in the Jumio Portal. See About the Identity Verification Settings.

    It is also possible to override some of the Identity Verification Settings on a per-transaction basis. See Overriding the Default Settings.

When the customer journeyClosed The end-user experience for uploading required credentials. Customers can integrate the Jumio Web Client and/or SDKs into their apps, or implement the customer journey themselves and use Jumio APIs to upload credentials and initiate transactions. is complete the end user is redirected to either the successUrl or the errorUrl (defined in the Settings or the Account request). Information about the transaction is appended to the URL. See Acquisition Status and Error Codes.

See Supported Environments for details on supported browsers and operating systems.