Introduction to Modules

Modules are the individual building blocks of a workflow that help you authenticate and onboard your users.

Each module performs a unique function such as an 'ID card validation' or a 'database check'. You can configure a workflow with specific modules and arrangements that best suit your business requirements.

Some of the modules we support can be used in any country(eg: selfie liveness) and some are specific to certain countries(eg: database checks).

Below are the modules supported:

• Global Modules (for any country)
• Country specific modules:
  • India
  • Nigeria
  • USA
  • Vietnam

Key concepts related to modules

Module ID

module_id is a unique identifier of a module. If you use the Results API, you can use module_id to uniquely identify each module of your workflow

Module Name

Module name is just a human readable name for every module. The name can be found in the dashboard's workflow page, as part of Results API output(module) and on the application's page.

Note: Do not use module name in your code. Use module_id instead

Module Input

• Some module might require inputs from previous modules or inputs from the parent app to function
• For example:
  • 'Face Match API' needs to know the two faces that should be matched
  • Database checks usually require ID number & other user details
• For a workflow to function correctly, inputs required by every module in the workflow should be handled. These inputs should either be provided by other modules in the workflow or as a 'workflow input' passed to the SDK during integration

Module Configurations

• Many modules support configurations to help you tweak the module implementation to meet your requirements
• For example:
  • You can hide the 'instructions screen' shown as part of 'ID Card Validation' module
  • You can enable 'face quality checks' as part of the 'Selfie Validation' module
• If you want to change the configurations of any module in your workflow, please reachout to our integrations team

Module Output

• Every module provides certain outputs after performing its designated function.
• For example:
  • 'Face Match API' module tells whether the two faces have matched or not
  • 'ID card validation' module gives out the fields extracted from the ID card, results of quality checks etc

Using the Outputs

In the workflow:
Any part of the module's output can be used by rest of the workflow - either as inputs of other modules or to take a decision on the application For example:

• Use 'ID number' from 'ID card validation' module as an input for database check module
• If 'Face Match API' returns "not match", auto-decline user

SDK Response:

If your application requires using any module output (for example, to auto-populate fields), the workflow can be configured to provided such specific fields as part of the SDK response.

Note

If you only intend to forward the workflow response to your backend, you should use the Logs API.

Logs API Response:

The Logs API provides the complete module response in an application. You can see refer these module specific responses under the relevant module's page.

Module Summary

Summary is the final verdict from a module based on various checks performed as part of the module's implementation.

For example, in the ID Card Validation module, it is evaluated based on all the quality checks performed on the identity document's image and the associated confidence with which the textual information was extracted from it.

info

Not all modules have a summary. For simple modules, the status code reflects it's a success (with code 200) or a failure (with any other code) response.

Summary object inturn contains two fields - action and details

There are 4 values possible for action:

• pass: Everything is fine with this ID image
• fail: Some flag was found with this ID image
• manualReview: Requires manual intervention
• retake: Requires user to retake the image. This retake flow is automatically handled by the SDK (this is only applicable for modules with user interaction - eg: selfie_validation & id_card_validation)

The 'action' of various modules are used by the workflow to determine the next steps or to tag an application as auto approved, auto declined or needs review