eKYC Example Project

Overview

A brief introduction to the project:

• This example app demonstrates how to integrate IDLive Face Capture and IDLive Document Capture libraries.
• It shows how to make a network request to the eKYC REST API.
• MainActivity manages the UI logic, while EnrollRepository manages network calls.
• DocCaptureActivity and FaceCaptureActivity manage capturing process and lifecycle of Camera.

---

Prerequisites

• Android studio Ladybug(2024.2.1) or later. Because the project uses AGP 8.7.0
  • Android Gradle plugin and Android Studio compatibility

---

Obtaining Libraries & Licenses

1. IDLive Face Capture and IDLive Document Capture Libraries

   • Download them from our developer portal. Specifically, you’ll need:
     • idlive-document-capture-android-vVERSION_NUMBER.tar.gz – IDLive Document Capture library
     • idlive-face-capture-android-vVERSION_NUMBER-release.tar.gz – IDLive Face Capture library
   • After extracting these archive files, place the resulting .aar files into the module folder:
     • Place the extracted .aar file of the face library into the face-capture folder
     • Place the extracted .aar file of the document library into the doc-capture folder

2. Licenses

   • The same portal page also provides licenses for the detectors:
     • idlive-face-detector-eval-license-yyyy-mm-dd.zip – License for Face Detector IDLiveFaceDetection
     • idlive-document-detector-eval-license-yyyy-mm-dd.zip – License for Document Detector DocSdkMobile
   • Each library requires a valid license key.

3. Obtaining an API Key

   • Sign in to ID R&D’s Customer Portal to obtain your API key.

4. Api endpoint

   • Use default url https://ekyc-rest-api.idrnd.net/check or your own for api endpoint

5. Filling values in local.properties

• Put your Licenses (face and document) api-key and api endpoint to file local.properties below sdk.dir

  local.properties

  faceLicense=LicenseFace....
  docLicense=LicenseDoc....
  apiKey=ApiKey....
  apiEndpoint=https://....
  

---

Build & Run Instructions

1. Open the Project in Android Studio

   • Android studio Ladybug(2024.2.1) or later

2. Connect an Android device

   • This example app uses the device camera for face/document capture.
   • If you want to use an emulator follow this instruction.

3. Build & Run

   • Press Run > Run 'app'

---

Support

For issues or questions:

• Check our Developer Portal.
• Or contact us.

---

License

This example project is distributed under the MIT License.
See LICENSE.md for details.