Endpoints associated with creating and managing user accounts.
Forgot username
Requires the user to pass either the email registered to an account or the phone number, not both
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
string | true | none | Email belonging to account | |
phone_number | string | true | none | Phone belonging to account |
Refer to Status Codes for definitions of HTTP status code responses.
Successful response
{- "email": "test@test.com"
}
{- "http_code": 200,
- "response_code": "SUCCESS",
- "response_msg": "An email notification has been sent.",
- "data": [ ]
}
Forgot password
A user can send their username to this endpoint to be sent an email with their registered email address that will have a verification code.
Once you have this verification email containing the code you can send it to the forgotten-password/verify endpoint along with a new password and the ID of that subaccount.
Ask your administrator if you do not know your subaccount id.
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
username | string | true | none | Username belonging to account |
Refer to Status Codes for definitions of HTTP status code responses.
Successful response
{- "username": "test"
}
{- "http_code": 200,
- "response_code": "SUCCESS",
- "response_msg": "An email notification has been sent.",
- "data": [ ]
}