Skip to main content
POST
/
api
/
canary
/
authentication
/
forget-password
Forget Password
curl --request POST \
  --url https://api.cashful.africa/api/canary/authentication/forget-password \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "john.doe@example.com"
}
'
{
  "success": {
    "success": true
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.cashful.africa/llms.txt

Use this file to discover all available pages before exploring further.

Body

application/json
​
email
string
required

The email address of the user

Example:

"john.doe@example.com"

Response

Password reset email sent

​
success
boolean
required

Password reset email sent

Example:
{ "success": true }