🌐OnBoarding

1. Create Session Token :

First Step When Customer Click On Sign Up or Register You Have To Initialize Session First By Creating Session Token Using The Following API :

post

Body

application/json

tenantIdstringRequired

Organization tenantId

Example: A9C3E5D7-4B2F-47AC-9D61-3F1B1A1E87C6

tenantSecretstringRequired

Organization tenantSecret

Example: A9C3E5D7-4B2F-47AC-9D61-3F1B1A1E87C6

deviceIdstring | nullableOptional

Client's mobile deviceId

Example: A9C3E5D7

correlationIdstring | nullableOptional

correlationId is a unique identifier to trace and query requests by it.

Example: A9C3E5D7-4B2F-47AC-9D61-3F1B1A1E87C6

requestIdstring | nullableOptional

Request Id can be provided to continue the onboarding steps of specific request

Example: 1700398203730

kycRequestTypeIdstring | nullableOptional

KYC Request Type Id can be provided to pick witch Option we will apply such as (OCR - Manual - Upload Excel Sheet)

Example: '1' -> OCR , '2' -> Manual Entry , '3' -> Upload Excel Sheet

userIdstring | nullableOptional

user Id Who Loged into the Application

Example: 1700398203730

userNamestring | nullableOptional

user Name Who Loged into the Application

Example: [e-mail]

Responses

200

Success

application/json

400

BadRequest

application/json

401

Unauthorized

application/json

404

NotFound

application/json

post

/Onboarding/api/v1/Auth/GenerateOnboardingSessionToken

HTTPcURLJavaScriptPython

POST /Onboarding/api/v1/Auth/GenerateOnboardingSessionToken HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 349

{
  "tenantId": "A9C3E5D7-4B2F-47AC-9D61-3F1B1A1E87C6",
  "tenantSecret": "A9C3E5D7-4B2F-47AC-9D61-3F1B1A1E87C6",
  "deviceId": "A9C3E5D7",
  "correlationId": "A9C3E5D7-4B2F-47AC-9D61-3F1B1A1E87C6",
  "requestId": "1700398203730",
  "kycRequestTypeId": " '1' -> OCR  ,  '2' -> Manual Entry , '3' -> Upload Excel Sheet",
  "userId": "1700398203730",
  "userName": "[e-mail]"
}

{
  "token": "text",
  "expirationDate": "2025-12-22T08:44:17.625Z"
}

2. Import eNROLL JS File in index.html :

1KB

eNROLL.min.zip

archive

Open

<script src="eNROLL.min.js"></script>

3. Add Div Element With Specifying Id For This Div

<div id="myDiv">
</div>

4. Initialize eNroll Component Any Where In Your JS File After Document Is Loaded:

eNROLL.init({
   elementId:"myDiv", // The Id We Set Before For Our Div
   url:"{{environment.url}}", // this parameter is sent to you by email after acceptiong your org 
   sessionId://Token We Got In Step 1 From The API,
   disableTutorials:true, //(optional)this value is to hide and skip tutorials, default value is false.
   mainColor: "#FF2255" // (optional) this value of main theme color of plugin will be send in url 
   secondaryColor:"#FF2255" // (optional) this value of secondry theme color of plugin will be send in url 
   lang: "en" // (optional) this value of the language en || ar
   onExit:(error)=>{ // error type is {message:"string",errorCode:"string"} | null
     // define What Happen When User Exit From eNROLL Plugin
  },
  onSuccess:(data)=>{
         // data contain {applicantId:"string"} | null
        // after onBoarding success also call onExist 
  }
});