Generate OTP
PURPOSE
This method is a helping method that IIFL extends to the partner in case they want to use OTP validation for client click wrap process.
Request URL
https://apisandbox.iifl.in/fintech/GenerateOTPRequest 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 | PLRQST01 |
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) |
Validation | Sample Value |
---|---|---|---|---|
ProspectNo | Prospect Number provided while prospect creation | Varchar (10) | Yes | 78946123 |
MobileNo | Mobile number of the client | Varchar (10) | Yes | 9876543210 |
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 response | Int | 1- Success 0 - fail |
REQUEST:
{
"head": {
"requestCode": "FTRQGOTP01",
"key": "xxxxxxx",
"appVer": "1.0",
"osName": "WebAPI",
"appName": "ALLIANCE",
"source": "xxxxxx"
},
"body": {
"ProspectNo": "SL252xxx",
"MobileNo": "987xxxxx10"
}
}
Response (Success)
{{
"head": {
"status": "0",
"success_user_status": "0",
"response_code": "FTRSGOTP01",
"status_description": "OTP Successfully send",
"source": "xxxxxx"
},
"body": {
"Status": "0"
}
}
Response (Failure)
{
"head": {
"status": "1",
"success_user_status": "1",
"response_code": "FTRSGOTP01",
"status_description": "Mobile number entered is not valid register number",
"source": "xxxxxx"
},
"body": {
"Status": null
}
}