This API is used to onboard 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.
.jpeg?version=1&modificationDate=1670938542761&cacheVersion=1&api=v2)
API | /api/v1/request |
Authorization | Bearer Token |
Method | POST |
Headers | Content-Type:application/json |
Payload | {
"channel": "BRANCH",
"agentLocationId": "784101",
"ekycProvider": "EFR",
"ecrn": "123456789",
"primaryMobileNumber": "+971502106707",
"emailId": "irfanmtp1@gmail.com"
}
|
Success Response | {
"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 | {
"timestamp": "2022-12-05T13:44:31.557+00:00",
"status": 401,
"error": "Unauthorized",
"path": "/api/v1/request"
}
|
Other Failure Response | {
"status": "failure",
"statusCode": 400,
"errorCode": 40000,
"message": "Payload not readable or corrupt"
}
|
Header
Name | Data Type | Max Length | Mandatory | Description |
|---|---|---|---|---|
Content-Type | String | 36 | Yes | Content type |
Payload
Name | Data Type | Max Length | Mandatory | Description |
|---|---|---|---|---|
channel | String | 20 | Yes | Channel |
agentLocationId | String | 6 | Yes | Unique Identifier to identify the requester |
ekycProvider | String | 30 | Yes | EKYC Provider |
ecrn | String | 255 | Yes | Customer Number |
primaryMobileNumber | String | 20 | No | Primary Mobile Number |
emailId | String | 120 | No | Email ID |
Response
Name | Data Type | Max Length | Description |
|---|
Name | Data Type | Max Length | Description |
|---|---|---|---|
status | String | 255 | status description |
status_code | Int | - | Status code |
message | String | 255 | Message |
data | Object | - | Data object |
ekyc_request_id | String | 50 | EKYC Request unique identification number |
ekyc_request_data | Object | - | Data object |
ekyc_portal_html | String | 4000 | Base 64 Encrypted EKYC Portal Html content |
0 Comments