Versions Compared

Old Version 1

changes.mady.by.user shyam prasad

Saved on

compared with

New Version 2

changes.mady.by.user shyam prasad

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This API is used to create an EKYC Request in order to use the EKYC and it will check whether the requester has the authorization to use the provided EKYC solution.Request EKYC API will provide a successful result with a unique EKYC Request Id and encrypted Html page content based on the EKYC Provideronboard a customer via eKYC by authorized entities associated with Lulu. The API provides encrypted HTML page content with a unique eKYC request Id as a response. The sequence diagram below provides further insight into the rich customer onboarding experience.

...

 

API

/api/v1/request

Authorization

 Bearer Token

Method

POST

Headers

Content-Type:application/json

Payload

Code Block
{
  "channel": "BRANCH",
  "agentLocationId": "784101",
  "ekycProvider": "EFR",
  "ecrn": "123456789",
  "primaryMobileNumber": "+971502106707",
  "emailId": "irfanmtp1@gmail.com"
}

Success Response

Code Block
{
    "status": "success",
    "statusCode": 200,
    "data": {
        "ekyc_request_id": "4e41d40a-6f16-4874-977b-017798d1e583",
        "ekyc_request_data": {
            "ekyc_portal_html": "<<encrypted_base_64_ekyc_portal_html_if_any>>"
        }
    }
}

Authentication Failure

Code Block
{
  "timestamp": "2022-12-05T13:44:31.557+00:00",
  "status": 401,
  "error": "Unauthorized",
  "path": "/api/v1/request"
}

Other Failure Response

Code Block
{
  "status": "failure",
  "statusCode": 400,
  "errorCode": 40000,
  "message": "Payload not readable or corrupt"
}

...