Click Wrap Process
PURPOSE
This method allows the partner to register a client into the system using OTP and image provided along with client’s mobile number and IMEI number of his device. This process is done to authenticate that the client is using this device and the required person to contact when need arises.
Request Method: POST
Request format: JSON
Request Header
Content-Type: application/json
Ocp-Apim-Subscription-Key: provided by IIFL
REQUEST BODY
HEADER
| Field Name | Description | Data Type (max length) |
Mandatory | Sample Value |
|---|---|---|---|---|
| requestCode | Request Code of the API called | Varchar | Yes | PLRQCL01 |
| appVer | Developer App Version | Varchar | Yes | 1.0 |
| key | UserKey generated at the time of registration | Varchar | Yes | ABpyyGUh1nsbesSlup3VKURkI4tQDe8y |
| osName | Channel of order | Varchar | Yes | WebAPI, Android, iOS |
| appName | App Name provided at the time of registration | Varchar | Yes | ALLIANCE |
| source | Source provided at the time of registration | Varchar | Yes | 321 |
BODY
| Field Name | Description | Data Type (max length) |
Mandatory | Sample Value |
|---|---|---|---|---|
| ProspectNo | Prospect Number provided while prospect creation | Varchar (10) | Yes | 78946123 |
| MobileNo | Mobile No | Varchar(10) | Yes | 9876543210 |
| IMEIno | IMEI no | Varchar(25) | No | 1478523690123 |
| IPno | IP no | Varchar(50) | No | 123.123.123.123 |
| GeoTagging | Geo Tagging | Varchar(50) | No | GeoTag |
| ImageName | Name of the image | Varchar(20) | No | Image |
| Extension | Extension | Varchar(4) | No | jpg |
| Base64String | Base64String | Varchar(MAX) | No | Base64String |
| OTP | OTP | Int(4) | Yes | 0420 |
RESPONSE BODY
HEAD
| Field Name | Description | Data Type (max length) |
List of Values | Sample Value |
|---|---|---|---|---|
| responseCode | This is the response code of API | Varchar(20) | - | PLRQCL01 |
| status | This is the response code of API | Varchar(10) | 0 - Success 1 - Fail |
0 |
| Source | This is the Partner’s name | Varchar(20) | - | Partner_Name |
| statusDescription | Description of the response status | Varchar(50) | - | - |
| success_user_status | Status of the user for a partner | Varchar(10) | 0 - Success 1 - Fail |
0 |
BODY
| Field Name | Description | Data Type (max length) |
Sample Value |
|---|---|---|---|
| Status | Status of the request | Int | 0 - Sucess 1 - null |
REQUEST:
{
"head": {
"requestCode": "FTRQCW01",
"key": "xxxxxx",
"appVer": "1.0",
"osName": "WebAPI",
"appName": "ALLIANCE",
"source": "xxxx"
},
"body": {
"ProspectNo": "SL25xxxx0",
"MobileNo": "9820xxxxxx",
"IMEIno": "",
"IPno": "192.1xx.1xx.1xx",
"GeoTagging": "Geo Tag",
"ImageName": "Image",
"Extension": "jpg",
"Base64String": "Base64String",
"OTP": "1833"
}
}
Response (Success)
{
"head": {
"status": "0",
"success_user_status": "0",
"response_code": "FTRSCW01",
"status_description": "Success",
"source": "xxxxx"
},
"body": {
"Status": "0"
}
}
Response (Failure)
{
"head": {
"status": "1",
"response_code": "FTRSCW01",
"status_description": "MobileNo should not exceed 10 digits",
"source": "xxxxx"
},
"body": {
"Status": "null"
}
}