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.
Create elKYC (Allpass) Account
In order for your application to communicate with elKYC (Allpass) you need to sign up for an account in our workplace. You have to provide some information about yourself and a company.
Once you have registered, our system will automatically create an application and flow for you. This ensures that you can start using our platform immediately without any additional setup. In addition to the default application and flow created for you, you have the flexibility to create new applications and flows or customize the default ones according to your needs.
Integrate the Verification Flow
Depending on your requirements, you can integrate elKYC (Allpass) via our client-side SDK.
The client-side integration process can be summarized in 2 steps:
Install and import our client-side SDK in your application
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)
You can find more details in the integration section of our documentation.
Setup Webhooks
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 an applicant completes an Applicant's verification or passes some step. You should specify your backend endpoint url and import public RSA key
You can find more details in the application section of our documentation and how to use it in webhooks section.
Retrieve Data From the API
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 an Applicant you can do so via the elKYC (Allpass) API. You can retrieve the following types of data:
Data points collected and shared during an Applicant (E.g. first name, last name, document number, identity score)
Metadata related to the Applicant (i.e. user agent, timestamp, user references)
You can find more details on the endpoints and the response format in the Open API section of our documentation.
System interaction with UBKI integration
Last updated
