Verification (1.0.0)

Endpoints associated with creating and managing user accounts.

Forgot Username

Forgot username

Requires the user to pass either the email registered to an account or the phone number, not both

Properties

Name Type Required Restrictions Description
email 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.

This endpoint does not require authentication
Request
header Parameters
Content-Type
string
Example: application/json
Request Body schema: application/json
object
Responses
200

Successful response

put/v3/forgot-username
Request samples
application/json
{
  • "email": "test@test.com"
}
Response samples
application/json
{
  • "http_code": 200,
  • "response_code": "SUCCESS",
  • "response_msg": "An email notification has been sent.",
  • "data": [ ]
}

Forgot Password

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.

Properties

Name Type Required Restrictions Description
username string true none Username belonging to account

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint does not require authentication
Request
header Parameters
Content-Type
string
Example: application/json
Request Body schema: application/json
object
Responses
200

Successful response

put/v3/forgot-password
Request samples
application/json
{
  • "username": "test"
}
Response samples
application/json
{
  • "http_code": 200,
  • "response_code": "SUCCESS",
  • "response_msg": "An email notification has been sent.",
  • "data": [ ]
}
Copyright © ClickSend 2024. All right reserved.