This API call creates a user under your Account.
The API service endpoint for making the Create User API call is:
https://developer.lipisha.com/index.php/v2/api/create_user
The API request is made via HTTP POST and must be url encoded. Some of the parameters are required while others are optional. The parameters are:
Parameter | Description | Example |
---|---|---|
api_key | Unique string specifying merchant's Lipisha API key. This should match the api key that you have generated for your Lipisha account |
3aa67677e8bf1d4c8fe886a38c03a860 |
api_signature | Unique string specifying merchant's Lipisha API signature. This should match the api signature that you have generated for your Lipisha account |
SYetmwsNnb5bwaZRyeQ..........KhZNNkCoEx+5x= |
api_version | String specifying the version of the API in use | 1.3.0 |
api_type | String specifying the type of handshake or IPN call | Callback |
full_name | The Full Name of the user | John Doe |
role | The role which the user will be assigned to | Accountant |
mobile_number | The mobile number of the newly created user | 254712345678 |
The email of the user | john@doe.com | |
user_name | The user name to be used when logging in to the system by the new user | johndoe |
password | Password of the new user | john123 |
The API reponse will be returned as JSON. Each response will contain a status and content section. The parameters are:
Parameter | Description | Example |
---|---|---|
Status | ||
status | String specifying whether API Call executed successfully or failed | SUCCESS |
status_code | Integers specifying status code of the API Call result | 0000 |
status_description | String containing description of the status | User created successfully |
Content | ||
user_name | The user name of the newly created user | johndoe |
full_name | The full name of the newly created user | John Doe |
role | The role assigned to the newly created user | Accountant |
mobile_number | The mobile number of the newly created user | 254712345678 |
The email address of the newly created user | john@doe.com |
{
"status": {
"status_code": "0000",
"status_description": "User created",
"status": "SUCCESS"
},
"content": {
"user_name": "johndoe",
"full_name": "John Doe",
"role": "Accountant",
"mobile_number": "254712345678",
"email": "john@doe.com"
}
}