Request a password reset email

Developing

POST

/auth/forgot-password

Initiates the password reset process by generating a secure, time-limited password reset link and sending it to the user’s registered email address. The reset link allows the user to securely create a new password without requiring access to their current password.

Constraints:

The user can request one verification code email every 60 seconds.

Request

Body Params application/jsonRequired

Examples

Responses

🟢200Success

application/json

Headers

Bodyapplication/json

🟠400Validation Error

🟠403Account Locked

🟠403Account Not Verified

🟠429Rate Limit Exceeded (reset link)

🟠429Rate Limit Exceeded

🔴500Internal Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location 'http://localhost:3000/api/v1/auth/forgot-password' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "michele_armstrong@gmail.com"
}'

Response Example

200 - Example

{
    "status": "success",
    "message": "We have sent you a password reset link. Please check your email.",
    "data": {
        "request_after": "2026-07-14T11:33:58.648Z"
    }
}

Modified at 2026-06-12 01:07:52

Logout user

Verify password reset token