Get Customer
Description: This API allows to retrieve detailed information about a customer. |
Base URL: https://apidev-sdk.iserveu.online/{EndPoint} |
Endpoint: /common/dmt-lite/unified/customer/get-customer |
Headers
Content-Type: application/JSON |
client_id: To be shared during integration |
client_secret: To be shared during integration |
Request Body Parameters
Parameters | Description | Data Type | Validation with Sample | Mandatory/ Optional |
mobileNumber | Mobile Number | String | 10 digit mobile number E.g.8765432345 |
Mandatory |
username | User name | String | isutestapi1 | Mandatory |
latlong | Latitude Longitude | String | 123,234 | Mandatory |
publicIP | Public IP | String | 123.123.123.133 | Mandatory |
Sample Request Body
Sample Request Body(Encrypted)
Response Body Parameters
Parameters | Description | Data Type |
status | Status of transaction | String |
statusDesc | Status Description | String |
statusCode | Code of the transaction status | String |
name | Name of Customer | String |
mobileNumber | Customer Mobile Number | String |
KYCTypeFlag | KYC Type Flag | Boolean |
Sample Response Body
Success:
{
"name": "Chandan Pradhan", "mobileNumber": "8144094480", "statusCode": "0", //customer Not Exits,kindly onboard "statusDesc": "customer Not Exits,kindly onboard", "KYCTypeFlag": false, "status":"SUCCESS" } ……………… { "name": "Chandan Pradhan", "mobileNumber": "8144094480", "statusCode": "1", //customer created but not verified "statusDesc": "Customer created but not verified", "KYCTypeFlag": false, "status":"SUCCESS" } ……………… { "name": "Chandan Pradhan", "mobileNumber": "8144094480", "statusCode": "2", ////customer is created and verified, OVD is also verified. (This is for new Customer) "statusDesc": "Customer verified successfully", "KYCTypeFlag": true, "status":"SUCCESS" } ………………. { "name": "Chandan Pradhan", "mobileNumber": "8144094480", "statusCode": "3", ////customer created and verified but OVD not verified. "statusDesc": "Customer verified successfully", "KYCTypeFlag": false, "status":"SUCCESS" } |
Notes -
|
Failed:
{
"mobileNumber": "8144094480", "statusCode": "-1", "statusDesc": "Invalid mobile number", "KYCTypeFlag": false, "status":"FAILED" } ……………… { "mobileNumber": "8144094480", "statusCode": "-1", "statusDesc": "Username Must not be Empty", "KYCTypeFlag": false, "status":"FAILED" } ……………….. { "mobileNumber": "8144094480", "statusCode": "-1", "statusDesc": "User not onboarded", "KYCTypeFlag": false, "status":"FAILED" } ………………… { "mobileNumber": "8144094480", "statusCode": "4", "statusDesc": "Internal Server Issue", "KYCTypeFlag": false, "status":"FAILED" } |
Sample Response Body(Encrypted)
Response Codes
Status Code | Response Type | Description | HTTP Status Code |
0 | SUCCESS | customer Not Exits,kindly onboard | 200 |
1 | SUCCESS | Customer created but not verified | 200 |
2 | SUCCESS | Customer verified successfully | 200 |
3 | SUCCESS | Customer verified successfully | 200 |
-1 | FAILED | Username Must not be Empty | 200 |
4 | FAILED | Internal Server Issue | 200 |
Process Customer
Description: This API enables businesses to create new customer profiles by collecting essential information. |
Base URL: https://apidev-sdk.iserveu.online/{EndPoint} |
Endpoint: /common/dmt-lite/unified/customer/process-customer-registration |
Headers
Content-Type: application/JSON |
client_id: To be shared during integration |
client_secret: To be shared during integration |
Request Body Parameters
Parameters | Description | Data Type | Validation with Sample | Mandatory/ Optional |
mobileNumber | Mobile Number | String | 10 digit mobile number E.g.8618743463 |
Mandatory |
name | Customer name | String | Sangram Keshari pradhan | Mandatory |
address | Address | String | Bhubaneswar | Optional |
pincode | Pin Code | String | 6 digit pin code E.g-751002 |
Optional |
ovdType | OVD Type | String | Aadhaar Card | Optional |
ovdData | OVD Data | String | 12 digit Aadhaar number E.g-765386439745 |
Optional |
otp | OTP (One Time Password) | String | 898943 | Mandatory |
username | User name | String | isutestapi1 | Mandatory |
latlong | Latitude Longitude | String | 123,234 | Mandatory |
publicIP | Public IP | String | 123.123.123.133 | Mandatory |
paramA | To be used as per client requirement | String | to be used as per descretion | Optional |
paramB | To be used as per client requirement | String | to be used as per descretion | Optional |
paramC | To be used as per client requirement | String | to be used as per descretion | Optional |
Sample Request Body
Sample Request Body(Encrypted)
Response Body Parameters
Parameters | Description | Data Type |
status | Status of transaction | String |
statusDesc | Status Description | String |
statusCode | Status Code | String |
name | Customer Name | String |
mobileNumber | Customer Mobile Number | String |
KYCTypeFlag | KYC Type Flag | Boolean |
paramA | To be used as per the client requirement | String |
paramB | To be used as per the client requirement | String |
paramC | To be used as per the client requirement | String |
Sample Response Body
Success:
{
"name": "Sangram Keshari pradhan", "mobileNumber": "8658733463", "statusCode": "2", "statusDesc": "Customer verified successfully and Ovd Data Updated", "KYCTypeFlag": true, "status":"SUCCESS" "paramA": "", "paramB": "", "paramC": "" } |
Failed:
{
"name": "Sangram Keshari pradhan", "mobileNumber": "8658733463", "statusCode": "-1", "statusDesc": "Name Must Not Be Empty or Null", "status":"FAILED" "paramA": "", "paramB": "", "paramC": "" } …….. { "name": "Sangram Keshari pradhan", "mobileNumber": "8658733463", "statusCode": "-1", "statusDesc": "Mobile number must Not Be Empty or Null", "KYCTypeFlag": false, "status":"FAILED" "paramA": "", "paramB": "", "paramC": "" } ……… { "name": "Sangram Keshari pradhan", "mobileNumber": "8658733463", "statusCode": "4", "statusDesc": "Internal Server Issue, Kindly Try After Sometime", "KYCTypeFlag": false, "status":"FAILED" "paramA": "", "paramB": "", "paramC": "" } ……… { "name": "Sangram Keshari pradhan", "mobileNumber": "8658733463", "statusCode": " 4", "statusDesc": "Internal Server Issue, Kindly Try After Sometime", "KYCTypeFlag": false, "status":"FAILED" "paramA": "", "paramB": "", "paramC": "" } ………. { "mobileNumber": "8144094480", "statusCode": "-1", "statusDesc": "User not onboarded", "KYCTypeFlag": false, "status":"FAILED" "paramA": "", "paramB": "", "paramC": "" } |
Sample Response Body(Encrypted)
Response Codes
Status Code | Response Type | Description | HTTP Status Code |
2 | SUCCESS | Customer verified successfully and Ovd Data Updated | 200 |
-1 | FAILED | Mobile number Must not Be Empty or Null | 200 |
4 | FAILED | Internal Server Issue, Kindly Try After Sometime | 200 |
-1 | FAILED | User not onboarded | 200 |