Introduction

The KYC web SDK is a versatile component that allows you to easily handle verification submission process in your web application. The purpose of the SDK is to simplify the integration of our clients to the KYC app. Using the SDK customisable configuration, the end user would be able to complete the KYC process using either the mobile app or the web app.

How the SDK works

The main highlights of KYC web SDK are as follows:

• The KYC web SDK can be easily embedded in any web application as a reusable web component, declared just like any other HTML element. By using the SDK as an embedded component, the entire journey can be handled within your own domain without the need for redirection to a new domain.

• The SDK supports two operational modes to accommodate different use cases:

  • Create mode initiates a new verification session, allowing full customisation of the verification journey through configurable options.

• Retrieval mode enables access to an existing verification session, allowing users to resume a session that was newly created or previously initiated.

• With a customised configuration object, you can set up the SDK according to your preferences. For example, you can determine the dimensions of the SDK placeholder to make it fill the entire screen or give it a partial view on your page.
• By providing a channel name (mobile or web) in the SDK configuration data, the end user can proceed with the verification submission process either through a web browser or by installing the KYC mobile app on their phone.
• The SDK event broadcast is a useful tool that provides visibility into user activity from the beginning to the end of the verification submission journey. It allows you to respond to user interactions during the verification submission journey by implementing a desired event handler.

SDK Integration Guide

Integrating the KYC Web SDK into your web application is a simple and straightforward process. You can follow the integration steps outlined in the following recipe:

How to generate the token

**Note: **To use the token service, please contact truuth team to setup the same before following the below step in your code`

1. Use the below endpoint to generate the temporary token and to use the same in below SDK initialisation flow
   Access token endpoint: https://XXXX-prod.auth.ap-southeast-2.amazoncognito.com/oauth2/token
   Method : POST
   Authorization: BASIC
   Note : the alias ‘XXXX’ in the access token URL needs to be replaced with the alias of your tenancy
   (where ‘XXXX’ is the alias name)
2. Request parameters in header

3. Request parameters in body (Form URL Encoded)

   Parameter	Required	Value
   grant_type	Required	client_credentials
   client_id	Required	truuth team will share this
   scope	Required	websdk/websdk:run

4. Note: Store the username and password into your backend service and call this token service. Then pass the token back to frontend to send the same to the SDK initialisation.

How to initialise the SDK

To initialise the SDK, you can use the truuthKYCWebSdk.init(config) method, which takes a configuration JSON object as input.

The SDK operates in two distinct modes—create and retrieval—based on the presence of a verification ID in the configuration object:

• Retrieval mode: When a verification ID is included in the configuration object, the SDK enters retrieval mode. In this mode, any additional settings provided in the config field are disregarded, and the SDK loads the verification journey associated with the provided ID.
• Create mode: If no verification ID is supplied, the SDK defaults to create mode. In this case, the config object is required to initialize a new verification session and define its behavior and appearance. In the config object, you can provide specific values for the properties based on your requirements. Adjust the property names and values accordingly to customise the initialisation of the SDK for your web application.

The customised configuration used to initialise the SDK. The JSON object schema is defined as follows:

Configuration

Options

Custom Framework

Security Check

Logging Event Information

As mentioned, the SDK Event broadcast helps provide visibility into user activity from the beginning to the end of the verification submission journey and allows you to respond to user interactions in the verification submission journey by implementing a desired event handler in your code.

The "detail" property of each event provides details about that event. The fields of the "detail" property dispatched by the SDK are as follows:

• type: It specifies the main event types triggered during the verification submission process. You can find a full list of event types in the following table.
• tenant: It indicates the tenant alias on which the SDK has been set up.
• verificationId: This can be transaction identifier.
• timestamp: It indicates event's creation date.
• body: This is an optional field that provides additional details about the event type. You can find more information about the body structure in the following table.

{
  "currentStatus": "string",
  "previousStatus": "string"
}

{
  "abortedReasonCode": "string"
}

JSON
        [
          {
            "proofingType": {
              "code": "string",
              "name": "string"
            },
            "proofingStatus": "string",
            "userBehaviourChecks": [
              {
                "name": "string",
                "type": "string",
                "status": "string"
              }
            ],
            "documents": [
              {
                "status": "string",
                "securityChecks": [
                  {
                    "name": "string",
                    "type": "string",
                    "status": "string"
                  }
                ]
              }
            ]
          }
        ]

JSON
{
  "name": "string",
  "message": "string"
}

• Aborted Reason Codes

• Error Codes

SDK Completion Scenarios and Broadcast Events

The timeout allows the client to move the user onto next screens in cases where the result is not yet received. The timeout is the ending of SDK connection to the truuth backend and no more interaction is expected so, it is upto the client to decide if they wait for the result however long it is, or if after the timeout they move the use on and then control the experience to take further actions within their own web app. The client can then wait for the results from the callback to further inform their flow.

The SDK finishes working in one of the following situations:

1- Getting the result from backend -> broadcasting VERIFICATION_COMPLETED

2- Not getting any results from backend and timeout -> broadcasting VERIFICATION_PROCESSING_TIMEOUT

3- Error -> broadcasting ERROR

4- Come back by user -> broadcasting VERIFICATION_SUBMISSION_ABORTED (The event is broadcast when the user tries 'Come back later' option in the middle of verification submission journey and the client can move the user onto next screens in their own web site.)

Mobile and Desktop Browser Support

The KYC Web SDK supports the following browsers on different platforms:

• iOS: iOS Safari (version >= 13.0) and Chrome.
• Android: Chrome and Samsung Internet browser.
• Desktop: Firefox, Chrome, Samsung Internet, and Safari.

Please ensure that the specified browser versions are met for optimal compatibility and functionality with the KYC Web SDK.

Compatibility and Versioning

If the channel is selected as "mobile" in the SDK configuration, the KYC mobile app needs to be installed on the end user's phone as the KYC app platform.

• The KYC mobile app is compatible with Android devices running version 5.0 and above, with android:minSdkVersion="21" and android:targetSdkVersion="33" specified.
• For iOS devices, the KYC mobile app is compatible with iOS version 11.0 and above.

Also, the latest version of KYC web SDK is '1.0'.