Forgot Password

​

POST /api/auth/forgot-password

​

Authentication

​

Request Body

​

Request Example

{
  "email": "[email protected]"
}

​

Response

​

Success Response (200 OK)

"Check your email for instructions"

​

Error Responses

​

404 Not Found - User Does Not Exist

{
  "error": "User not found"
}

​

400 Bad Request - Validation Errors

{
  "errors": [
    {
      "msg": "Email not valid",
      "param": "email"
    }
  ]
}

​

cURL Example

curl -X POST https://api.example.com/api/auth/forgot-password \
  -H "Content-Type: application/json" \
  -d '{
    "email": "[email protected]"
  }'

​

Notes

• Generates a new 6-digit token for the user
• Sends password reset email with the token
• Token is stored in the user’s record for validation
• Rate limiting is applied to this endpoint
• Use the token with the /reset-password/:token endpoint to complete the reset