GBG Developers

Guides   |   Web Identity Solution SDK Overview

Web Identity Solution SDK Overview


The GBG Identity Solution offers a suite of verification functionality for integration into your solution. Software Development Kits (SDKs) are available for web-based, iOS, and Android applications. A HTTP REST based API is also available for use with any programming language and platforms. This guide explains how to make use of the Web SDK.
The Identity Solution Web SDK provides a very rapid way to get going with identity verification. There are pre-built activities that will display text input fields, and document capture buttons, in order to guide the user through the process. Very little coding is required.

SDK Overview

The SDK version and release notes can be found in the section here.  Please review this information if you already have an implementation of the Web SDK.  Other than that section about the versions, the other pages in this guide all reflect the latest version information.

The SDK provides a number of services or activities to access Identity Solution functionality. Using the services is as simple as calling the service (also known as an activity) method for the desired identity verification feature and passing in any required or optional information.

The SDK will automatically render a web page, or the page can be modified if desired using CSS and templates for deep control of features including HTML content, input validation, localisation and callbacks. The rendered content will automatically allow the user to provide documents via local files or the device camera, and this is configurable too.

The activity response meta content or object contains the verification information. It is possible to perform identity verification with just a few lines of code; see the JavaScript example file on GitHub

If you’re not familiar with the Identity Solution, once the account is set up, the basic procedure to interact with it using the HTTP REST API is:

  1. Obtain an IDP access token (using either Delegated Authentication, or a Pre-generated token)
  2. Exchange it for a GBG access token from GBG’s Identity Solution servers
  3. Attach the GBG access token to any verification request made to the Identity Solution
  4. Handle the verification responses in your application code as required

The Web SDK provides a higher layer of functionality so that individual HTTP calls are not needed:

  1. Obtain an IDP access token in the same manner as above
  2. Use the SDK’s Authenticate Service to obtain a GBG access token
  3. Use any additional SDK services (examples include person verification, document image and face matching services) as required for handling your verification workflow. Inputs can be text based or file or image (bitmap) based.
  4. Handle the verification responses in your application code as required

The services within the SDK class are:

Authentication Service - This service provides a method to send the identity provider (IDP) access token to the GBG Identity Solution servers to obtain a GBG access token in return. A SDK class method called authenticate is used to pass the IDP token and in return a GBG access token is received. The GBG access token acts like a key to allow verification functionality in subsequent requests. The token is automatically stored in the SDK, ready for use by the other services as required.

Address Service – Use this service’ AddressLookup activity to find a list of addresses which match particular search criteria, and then to drill-down to retrieve a full address.
Once the user has submitted a completion from the returned list of addresses, the application can obtain the full detail by examining the activity returned meta data.

Verify People Service – Use this service to send text based details of a person to be verified.
The details are sent using the SDK class PeopleVerify activity. The activity returned meta data contains the result for that verification and the combined decision so far.

Documents Service – The CaptureDocument activity can be used to perform a verification of a document image and return extracted and analyzed text details.
The activity meta data will contain pass or failure detail. Save the verificationID from the meta data to use it for any subsequent Facematch requests.

Facematch Service – This service can be used to see if a photo matches the one from the prior document verification.
Once you have done a document verification, you can use the FaceMatch activity. Typically the photo would be captured in a mobile app using the built-in camera and is application-dependent. The default camera application could be used as an example. Alternatively a local image file can be used. As with all the other services, use the activity returned meta data for the verification results.

Using the Guides

Now that you have an overview of the SDK, proceed to the following guides. They can be read in any order, although the first few guides are in the order of a typical first workflow. The Debugging guide is useful when troubleshooting run-time issues for tokens or for any of the services. There is additional supporting material (including Web SDK code examples) on the Identity Solution GitHub site.

Working with the Web SDK: Next Steps
Add Web SDK to your Project
Obtain an IDP Access Token
Configure SDK and obtain a GBG Access Token
Using the Address Service
Using the Verify People Service
Using the Documents Service
Using the Facematch Service
Debugging Web SDK Applications