Forgot Password

POST

/api/v1/auth/forgot-password

const url = 'https://api.qeychain.xyz/api/v1/auth/forgot-password';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"email":"hello@example.com"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.qeychain.xyz/api/v1/auth/forgot-password \
  --header 'Content-Type: application/json' \
  --data '{ "email": "hello@example.com" }'

Send a password reset email. Always returns success (no email enumeration).

The reset link expires in 1 hour.

Request Body^required

application/json

ForgotPasswordRequest

object

email

required

Email

string format: email

Example^generated

{
  "email": "hello@example.com"
}

Responses

200

Successful Response

application/json

Example^generated

example

422

Validation Error

application/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}

Forgot Password

Request Bodyrequired

Examplegenerated

Responses

200

Examplegenerated

422

Examplegenerated

Request Body^required

Example^generated

Example^generated

Example^generated