POST/auth/reset-password

Set a new password

Completes a password reset by checking the emailed code against the address and replacing the account's password with the one supplied.

AccessNo sign-in required

Call this after POST /auth/request-password-reset has emailed a code. Send the address, the code from that email, and the new password in one request. The code is the reset code, not the two-factor code that POST /auth/otp-validate uses, and it belongs to the address it was issued for.

Once the call reports success, the old password no longer works and the holder can sign in with the new one through POST /auth/login. If the code is no longer accepted, ask for another with POST /auth/request-password-reset rather than retrying this call.

Body parameters

emailstringrequired

The address the reset code was requested for.

otpstringrequired

The reset code from the email, as a string.

new_passwordstringrequired

The password the account will sign in with from now on.

bash

curl -X POST "$SQRL_API/auth/reset-password" \
  -H "content-type: application/json" \
  -d '{
        "email": "operator@example.com",
        "otp": "739164",
        "new_password": "<new-password>"
      }'

const res = await fetch(`${process.env.SQRL_API}/auth/reset-password`, {
  method: "POST",
  headers: { "content-type": "application/json" },
  body: JSON.stringify({
    email: "operator@example.com",
    otp: "739164",
    new_password: "<new-password>",
  }),
});
const { Success } = await res.json();

rust

let res = client
    .post(format!("{}/auth/reset-password", api_base))
    .json(&serde_json::json!({
        "email": "operator@example.com",
        "otp": "739164",
        "new_password": "<new-password>",
    }))
    .send()
    .await?;

Response200 OK

{
"Success": true
}

Was this page helpful?