# Redeem Password Reset

`POST /gate/password-reset/redeem` · Identity & Access · Sign-in & Sessions

Completes a password reset by accepting the single-use reset token and the new password. On success, the end-user's password hash is updated, all existing sessions and refresh tokens are revoked, and a fresh Gate JWT is issued. Returns `K9O_PASSWORD_RESET_TOKEN_EXPIRED` (410) if the token is expired or already used.

## Parameters

| Name | In | Required | Description |
|---|---|---|---|
| `projectSlug` | path | yes | The project's slug: the path segment after `@`. It is unique within the org. Example: `"storefront"`. |

## Request body

| Field | Type | Required | Description |
|---|---|---|---|
| `token` | string | yes | The reset code from the email. It works once and expires one hour after it was sent. |
| `newPassword` | string | yes | The new password, at least 12 characters. A password found in known data breaches is refused. |

```json
{
  "token": "EXAMPLE-reset-token-not-a-real-secret-0000",
  "newPassword": "correct-horse-battery-staple"
}
```

## Responses

- **200**: Success

| Field | Type | Required | Description |
|---|---|---|---|
| `data` | object | yes | Either `session` or `mfa`, never both. |
| _one of_ | | |  |
| `data.redeemed` | enum (true) | yes | Always `true`: the password is changed and every earlier session of the end user has ended. |
| `data.session` | object | yes | The tokens for the new session. Keep the refresh token for `POST /@{projectSlug}/gate/refresh` and send the access token on API calls. |
| `data.session.accessToken` | string | yes | A signed JWT that authenticates the end user to this project's API. Send it as `Authorization: Bearer <accessToken>`. Its subject (`sub`) is the end user's id (`eu_...`), its audience (`aud`) is the project id (`proj_...`), and its issuer is the API origin of the region that holds the end user. It lives for the project's end-user access token lifetime: 30 minutes by default, settable from 5 to 60 minutes. `expiresAt` is when it expires. It cannot be revoked early: signing out or revoking sessions stops the next refresh, but a token already issued stays valid until `expiresAt`. |
| `data.session.refreshToken` | string | yes | An opaque secret (43 base64url characters) that gets a new access token from `POST /@{projectSlug}/gate/refresh`. Store it securely and never send it anywhere else. It is single use: every refresh returns a new refresh token, and sending the one it replaced a second time ends the whole session. It stops working when the session ends: on sign-out, a password reset, a revoke-all, or when the project's session limits are reached (by default 30 days without a refresh, or 90 days after sign-in, whichever comes first). |
| `data.session.expiresAt` | string (date-time) | yes | When `accessToken` expires. Refresh before this time to keep the end user signed in. |
| `data.endUserId` | string | yes | The end user whose password changed (`eu_...`). |
| _or_ | | |  |
| `data.redeemed` | enum (true) | yes | Always `true`: the password is changed and every earlier session of the end user has ended. |
| `data.mfa` | object | yes | Present instead of `session` when the end user has a confirmed authenticator app: the sign-in needs a code first. |
| `data.mfa.required` | enum (true) | yes | Always `true`: the end user has a confirmed authenticator app, so this sign-in needs a code before it gets a session. |
| `data.mfa.challengeId` | string | yes | An opaque, single-use id for this sign-in (43 base64url characters). Send it with a current code from the end user's authenticator app to `POST /@{projectSlug}/gate/mfa/challenge`, on the origin in `resident.origin`, to get the session. A new sign-in by the same door replaces it, and it dies after 5 wrong codes. |
| `data.mfa.expiresAt` | string (date-time) | yes | When the challenge expires, 5 minutes after it was issued. After that the end user signs in again. |
| `data.mfa.methodsAvailable` | array of enum ("totp") | yes | The second factors that can answer this challenge. Always `["totp"]`: a time-based code from an authenticator app. |
| `data.mfa.resident` | object | yes | Where the challenge lives. |
| `data.mfa.resident.region` | string | yes | The region that holds the end user and this challenge. |
| `data.mfa.resident.origin` | string | yes | That region's API origin. Send the challenge answer here: no other region has the challenge. |
| `data.endUserId` | string | yes | The end user whose password changed (`eu_...`). |
| `meta` | object | yes | Request metadata: cost, timing and the request and trace ids. |


## Errors

| HTTP | Code | When |
|---|---|---|
| 400 | `K9O_INVALID_REQUEST_SHAPE` | The new password is shorter than the minimum length required by the request schema. |
| 404 | `K9O_END_USER_NOT_FOUND` | No end-user record matches the identity associated with the supplied password-reset token. |
| 400 | `K9O_INVALID_FIELD_VALUE` | The password-reset token is invalid, has expired, or has already been used. |
| 400 | `K9O_PASSWORD_COMPROMISED` | The new password appears in a known data breach at or above the project's threshold (the project's have-i-been-pwned install, with its Gate block on). Choose a different password; context is empty. |

## Code samples

### cURL

```bash
curl -X POST 'https://<org>.api-<region>.k9o.io/@storefront/gate/password-reset/redeem' \
  -H 'Content-Type: application/json' \
  -d '{
  "token": "EXAMPLE-reset-token-not-a-real-secret-0000",
  "newPassword": "correct-horse-battery-staple"
}'
```

### fetch

```javascript
const res = await fetch('https://<org>.api-<region>.k9o.io/@storefront/gate/password-reset/redeem', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  "token": "EXAMPLE-reset-token-not-a-real-secret-0000",
  "newPassword": "correct-horse-battery-staple"
}),
});
const { data, meta } = await res.json();
```

### @k9o/core

```typescript
// const k9o = new K9o({ orgSlug: 'playground', projectSlug: 'storefront', apiKey: 'k9o_…' })
const { data } = await k9o.gate.passwordReset.redeem({
  token: 'EXAMPLE-reset-token-not-a-real-secret-0000',
  newPassword: 'correct-horse-battery-staple'
})
```


Canonical page: https://docs.kilimanjaro.dev/api-playground/identity-access/redeem-password-reset
