Guides

E-KYC SDK API Usage

An Example usage of Case-keeper-apis to use with E-KYC SDK

Suggest Edits

Overview

E-KYC Native SDK is used to render a web view that the client sees and performs E-KYC in the application. To do that, it requires to be initiated with a verification Id that is unique to that case.

The main steps to integrate and use our E-KYC flow are:

  1. Get auth token
  2. Create a case/proprietor (to get verification ID to be used in SDK)
  3. Client performs the E-KYC flow
  4. Get E-KYC data

Prerequisites

📘

To start off, you will need to have the following credentials:

  • CLIENT_ID: Provided by AppMan and used for authenticating
  • CLIENT_SECRET: Provided by AppMan and used for authenticating

1. Authentication

You will need to get authenticated to use any other APIs

🦉
Authentication
Open Recipe

2. Create Case

Now that we have the token we have to create a case where we will put in the configuration you can learn about the API spec more by going through Create Case Api

3. Client performs the E-KYC flow

After creating a case, you will get the id of the verification from the response. The id can then be used as verificationId to integrate with the Native E-KYC SDK.

Follow the steps to setup and initialize EKYC SDK in these guides:

4. Getting the data from AppMan

After the client performed the E-KYC process in the application, the data will be uploaded to AppMan's server.

The data can be retrieved using these 2 methods:

4.1. Using REST API

The first method is using the GET method to fetch data from our service.

We support getting data by these 3 APIs. You can look through the API spec and choose the one that best matches your use case.

  • Get Case by ID: This includes all the data from the case, proprietor, and verification. Best when you have various proprietors.
  • Get Proprietor by ID: This includes all the data from the proprietor and verification. Best when you have multiple verifications in a single proprietor
  • Get Verification by ID: This includes only the EKYC data from verification. Best when you only need the results

4.2. Using webhook events

Clients can provide an endpoint that supports the POST method, to be configured in the AppMan configuration service. The endpoint will receive data from AppMan when data has been altered in the E-KYC service. Webhook Explaination

To request setting up the webhook endpoint, please contact our support team.

Updated almost 2 years ago