Comment on page
Overview & Integration Guide
Here you will find an overview of the major steps required to integrate elKYC (Allpass) into your application. You can find more details on each step in the relevant sections.
elKYC (Allpass) Technical Implementation
In order for your application to communicate with elKYC (Allpass) you need to signup for an account in our workplace and retrieve your development API keys from
Integration > App Key. You'll use your application App Key for all client-side SDKs (e.g. your web App or mobile Applications).
You'll use your company private API key for all server-side libraries (e.g. your backend server).
Depending on your requirements, you can integrate elKYC (Allpass) via our client-side SDK.
The client-side integration process can be summarized in 3 steps:
- 1.Install and import our client-side SDK in your application
- 2.Customize UI and localisations (if needed) in your view
- 3.Initialize SDK and our users will complete a Verification through the Verification flow - on completion, you need to track the Verification in your dashboard in workplace and handle it accordingly via the callbacks (e.g. onComplete function)
elKYC (Allpass) uses webhooks to notify your backend when an event happens in your client-side SDK. Webhooks are useful for asynchronous events like when a user completes a Verification, or passes some step. You should specify your backend endpoint url and import public RSA key
For security purposes, we recommend you to minimize the Data points stored on your server. That being said, if you need to retrieve information related to a Verification you can do so via the elKYC (Allpass) API. You can retrieve the following types of data:
- Data points collected and shared during a Verification (E.g. first name, last name, document number, identity score)
- Metadata related to the Verification (i.e. user agent, timestamp, user references)