Headers
Request Body Parameters
| Parameters | Parameter description with examples | Validation | Data type | Mandatory/Optional |
| bcagentid | Unique ID assigned to the business correspondent (BC) agent. E.g.- "AOISU0003435" |
Alphanumeric Min 2, Max 25 | String | Mandatory |
| bcagentname | Name of the BC agent. E.g.- "Rahul" |
Alphanumeric Min 2, Max 25 | String | Mandatory |
| lastname | Last name of the agent. E.g.- "dash" |
Alphanumeric Min 2, Max 25 | String | Mandatory |
| mobilenumber | Contact number of the agent. E.g.- "8989897650" |
10 digit number | String | Mandatory |
| Contact email of the agent. E.g.- "[email protected]" |
Proper email format as example | String | Mandatory | |
| pancard | PAN card number of the agent. E.g.- "ERFPP0988S" |
Alphanumeric and all in caps | String | Mandatory |
| aadhar_no | Aadhar number of the agent. E.g. -"345098761234" |
12 digit number | String | Mandatory |
| companyname | Name of the company providing the service. E.g.- "Iserveu" |
Alphanumeric Min 2, Max 55 middle space allowed | String | Mandatory |
| address | Registered address of the agent. E.g.- "KIRTI NAGAR DELHI" |
Alphanumeric Min 2, Max 255 middle space allowed | String | Mandatory |
| area | Agent’s area of location. E.g.- "KIRTI NAGAR DELHI" |
Alphanumeric Min 2, Max 50 middle space allowed | String | Mandatory |
| pincode | Postal code of the agent's address. E.g. – 759012 |
6 digit number | Integer | Mandatory |
| shopaddress | Address of the agent’s shop. E.g.- "KIRTINAGARDELHI" |
Alphanumeric Min 2, Max 255 middle space allowed | String | Mandatory |
| shoparea | Area where the shop is located. E.g.- "KIRTI NAGAR DELHI" |
Alphanumeric Min 2, Max 50 middle space allowed | String | Mandatory |
| shopcity | City where the shop is located. E.g.- "Delhi" |
Alphanumeric Min 2, Max 100 middle space allowed | String | Mandatory |
| shopdistrict | District where the shop is located. E.g.- "Delhi" |
Alphanumeric Min 2, Max 100 middle space allowed | String | Mandatory |
| shopname | Name of the shop. E.g.- "Rj Shop" |
Alphanumeric Min 2, Max 25 middle space allowed | String | Mandatory |
| shoppincode | Postal code of the shop’s location. E.g.- "758093" |
6 digit number | Integer | Mandatory |
| shopstate | State where the shop is located. E.g.- "Delhi" |
Alphanumeric Min 2, Max 100 middle space allowed | String | Mandatory |
| lat | Latitude coordinate of the shop location. E.g. - "72.8711" |
Accepts Decimal number | String | Mandatory |
| long | Longitude coordinate of the shop location. E.g. - "19.0760" |
Accepts Decimal number | String | Mandatory |
| customerreferenceno | Customer reference number. E.g. - "342543664657" |
Alphanumeric Min 5, Max 20 | String | Mandatory |
| piddata | Encrypted PID data. E.g. - "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz…" |
Encrypted data | String | Mandatory |
Sample Request Body
Encrypted Sample Request Body
Response Body Parameters
| Parameters | Parameter description with examples | Data type |
| status | Status of the operation (SUCCESS/FAILED) | String |
| statusCode | Status Code | String |
| statusDesc | Status Description. | string |
| bcagentid | Unique ID assigned to the BC agent. | String |
| token | A temporary code used for authentication or verification. E.g.- "854162978825042025" |
String |
Sample Response Body
SUCCESS:
FAILED:
Sample Response Body(Encrypted)
Status Codes
| Status | Status Code | Description |
| SUCCESS | 0 | OTP sent successfully. |
| FAILED | 1 | ERROTP001:- Mobile number already registered |