Headers
Request Body Parameters
| Parameters | Description and Example | Validation and Size Constraints | Data Type | Mandatory/Optional |
| bcagentid | BC Agent ID. E.g. - "matm12" |
Alphanumeric. Min - 2 and Max - 25 |
String | Mandatory |
| mobilenumber | Mobile Number. E.g. - "8093098069" |
Numeric. Exactly 10 digits. |
string | Mandatory |
Sample Request Body
Sample Request Body(Encrypted)
Response Body Parameters
| Parameters | Parameter description | Data type |
| status | Status Code | string |
| message | Response Message | string |
| bcagentid | Unique ID assigned to the BC agent. | string |
| data | Contains the following data | Object |
| user_name | User Name | string |
| mobilenumber | Contact number of the agent. | String |
| status | Status of the operation (SUCCESS/FAILED) | String |
| substatus | Sub status corresponding to the above status | String |
| created_date | Date of Transaction Creation (timestamp) | String |
| additional_info | Additional details | String |
| bank_onboard_status | Onboarding Status from the bank’s end | Object |
| errorres | Errors | Object |
| status | Status Code | String |
| description | Description of the error status | String |
Sample Response Body
SUCCESS:
Sample Response (Encrypted)
Sample Error Response:
Status Details
| Status | Message |
| 0 | Agent already onboarded |
| 1 | The agent is not onboarded yet |