Forgot Password API
Welcome to the documentation for the Forgot Password API. This API helps user's recieve an OTP in their email address to help recover or create a new password.
Base URL
{baseURL}/v1/users/forgot-password | POSTRequest Payload
| Field | Type | Source | Required | Description |
|---|---|---|---|---|
| string | body | ✅ Yes | User's email address |
Sample Request
curl -X POST {baseURL}/v1/users/forgot-password \
-H 'Content-Type: application/json' \
-d '{
"email": "[email protected]"
}'Sample 200 Response
{
"message": "A verification token has been sent to your email address",
"success": true
}