🔑Authentication

1. First We Need To Setup Level Of Trust :

This Setup Allow Us To Configure How Customer Can Authunticate When Using The Plugin.

A. Go To Level Of Trust Page In Your Admin Panel And Click Add new Level Of Trust Button

B. Enter A Name For Level Of Trust And Select Steps To Authenticate Customers:

Hint : If You Select A Step That The Customer Did not Enter While Onboarding This Customer

Must Update this Information First Using Update Plugin Before Authentication.

C. After Creation Of New Level Of Trust Just Copy The Level Of Trust Id To Use In Next Steps:

2. Create Session Token For Authentication:

Second Step When Customer Needs To Verfy (his/her) Identity You Have To Initialize Session By Creating Session Token Using The Following API :

level of Trust token Is The One You Copied In The Previous Step

Applicant Id : You Have To Determine The ID Of The Applicant To Authenticate You Can Find This Id In The Data Returned Back To You In The Callback URL

POST/api/v1/Auth/GenerateAuthRequestSessionToken

Header parameters

Body

application/json

tenantIdnullable string

tenantSecretnullable string

applicantIdnullable string

levelOfTrutTokennullable string

Response

200400

Success

Body

text/plainapplication/jsontext/json

tokennullable string

expirationDatestring (date-time)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/api/v1/Auth/GenerateAuthRequestSessionToken', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400

{
  "token": "text",
  "expirationDate": "2025-01-22T05:13:45.558Z"
}

3. Import eNROLL JS File in index.html :

908B

eNROLL.min.zip

archive

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

4. Add Div Element With Specifying Id For This Div

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

5. 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 
   mode:"auth",
   sessionId://Token We Got In Step 1 From The API,
   onComplete:()=>{
     // define What Happen When User Complete Auth
  },
   onError:(errorCode,message)=>{
     // define What Happen When User Fild At Auth
     // You Can Check For This Code To Take the Correct Action 
  },
  onExit:()=>{
     // define What Happen When User Exit From eNROll Plugin
  }
});

You Can Check For Available Error Codes At Errors

6. As A FInal Step You Can Verfiy The Current Status Of this Authentication Using The Following API:

POST/api/v1/authentication/AuthenticationRequest/GetAuthenticationReport

Header parameters

Response

200400

Success

Body

text/plainapplication/jsontext/json

applicantIdnullable string

applicantNamenullable string

nationalIdNumbernullable string

passportDocumentNumbernullable string

levelOfTrustIdnullable string

levelOfTrustNamenullable string

statusAuthenticationRequestStatus (enum)

123

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/api/v1/authentication/AuthenticationRequest/GetAuthenticationReport', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "applicantId": "text",
  "applicantName": "text",
  "nationalIdNumber": "text",
  "passportDocumentNumber": "text",
  "levelOfTrustId": "text",
  "levelOfTrustName": "text",
  "status": 1
}

You Can Check For Available Status Codes At Status