Skip to content

Capture Libraries

The IDLive® eKYC Toolkit includes two separate client-side libraries known as Document Capture Library and Face Capture Library. These libraries are designed to enhance the user experience by capturing high-quality images without the need for re-capturing. They can be integrated into an end-to-end user journey to ensure smooth processing of both document and face images for KYC verification.

By default, the typical workflow begins with the client-side application calling the Document Capture Library to acquire an image of the document. Once the document image is captured, the application then calls the Face Capture Library to acquire a face image. These captured images are then sent to the backend servers for further processing.

In general, both libraries provide the business logic and user interface (UI) necessary for data acquisition. When the libraries are invoked, they present a UI that guides the user through the process of capturing the required images and finishes by outputting the collected data back to the calling application. It is important to note that the Capture Libraries themselves do not initiate direct communication with backend servers. Instead, it is assumed that the client-server communication is already established, and developers will need to integrate the data exchange with their backend within their existing business logic, as per their specific requirements.

The Capture Libraries implement the following functionalities to ensure successful KYC image acquisition:

  • Image Quality Assessment: The libraries assess the quality of images captured from the device camera, ensuring they meet the requirements for successful KYC processing.
  • Auto-Capturing: Automatically captures images once they meet the necessary quality criteria, minimizing user interaction and ensuring consistency in captured data.
  • Protection Against Data Tampering: Implements robust measures to protect the image capture process from data substitution or tampering, providing reliable data for KYC checks.
  • Data Encryption: Encrypts captured data to ensure secure transmission over the network, preventing unauthorized access during the data transfer phase.
  • Code Obfuscation and Anti-Debugging: Implements code obfuscation and anti-debugging techniques to protect the library from reverse engineering and unauthorized manipulations, enhancing the overall security of the application.

Both the Document Capture Library and Face Capture Library are available for three major platforms: iOS, Android, and Web. These platform-specific libraries ensure that developers can integrate capture functionalities seamlessly across different environments, providing a consistent user experience regardless of the platform.

This documentation provides the following resources for developers:

  • System Requirements: Detailed information about the system prerequisites for each component of the Capture Libraries.
  • Integration Guides: Comprehensive guidelines to help developers integrate the Document Capture Library and Face Capture Library into their applications.
  • Implementation Guides: Step-by-step instructions on implementing the libraries within an end-to-end workflow, covering both client-side and server-side aspects.