Skip to main content
POST /api/v1/forgot-password No authentication required. Initiates the password reset flow. A one-time reset token is generated and sent to the provided email address.
This endpoint always returns { "sent": true } regardless of whether the email address is registered. This prevents account enumeration.

​
Request body

​
email
string
required
Email address of the account to reset. Must be in valid email format.

​
Response

​
sent
boolean
required
Always true.

​
Errors

StatusWhen
400The email field is missing or not a valid email format

​
Example

curl -X POST http://localhost:8080/api/v1/forgot-password \
  -H "Content-Type: application/json" \
  -d '{
    "email": "[email protected]"
  }'

{
  "sent": true
}

Build docs developers (and LLMs) love

Get started for freeTalk to us