Skip to main content

Forgot password

Forgot password request​

Email​

Intro​

Get a link to reset your email. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec vel dolor lacinia, pellentesque ligula vitae, ultrices dui. In tincidunt velit sit amet neque aliquet, a vulputate purus lobortis.

Request Headers​

Origin: <CLIENT_APP_URL>
client_id: <API_CLIENT_ID>

Request body​

{
  "email":"String",
}

Body Validation​

  1. email - User Email

Request​

POST
http://localhost:5501/api/v1/auth/forgotpass

Response​

{
    "status": "String",
    "id": "String",
    "message": "String",
}

Response Validation​

  1. status - request status
  1. id - user ID
  1. message - response message

Example​

Headers​

Origin: http://localhost:3000
client_id: pSpisBrYn4yIP1vGILcdZ

Body​

{
  "email"::"user@example.com";
}

Response​

{
    "status": "success",
    "id": "629ad74878103d4e4a74e9e6",
    "message": "Reset password token was sent"
}

Mobile​

Intro​

A verification sms will be sent. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec vel dolor lacinia, pellentesque ligula vitae, ultrices dui. In tincidunt velit sit amet neque aliquet, a vulputate purus lobortis.

Request Headers​

Origin: <CLIENT_APP_URL>
client_id: <API_CLIENT_ID>

Request body​

{
  "phone":"String"
}

Body Validation​

  1. phone - User phone

Request​

POST
http://localhost:5501/api/v1/auth/forgotpass/mobile

Response​

{
    "status": "String",
    "id": "String"
    "message": "String"
}

Response Validation​

  1. status - request status
  1. id - User ID
  1. message - response message

Example​

Headers​

Origin: http://localhost:3000
client_id: pSpisBrYn4yIP1vGILcdZ

Body​

{
    "phone":"254710xxxxxx"
}

Response​

{
    "status": "success",
    "id": "62d4e9bf167f537cf7db8c44",
    "message": "Reset password token was sent"
}