> ## Documentation Index
> Fetch the complete documentation index at: https://docs.truscan.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Request a password-reset link

> Always answers 200, whether or not the address has an account. Reporting the difference would let anyone test which emails are registered.



## OpenAPI

````yaml /api-reference/auth.json post /api/auth/forgot-password
openapi: 3.1.0
info:
  title: truscan auth
  version: 1.0.0
  description: >-
    Identity: accounts, sessions, password resets and API keys.


    This is the only service that verifies a credential, because it is the
    service that issues them. Every other service decodes the identity the edge
    already verified.


    Protected routes accept either credential, a dashboard session JWT or an
    `tru_` API key, on the same path. There is no key-only variant of any route.
servers:
  - url: https://api.truscan.co
    description: Production
security: []
tags:
  - name: session
    description: Sign up, sign in, password reset
  - name: keys
    description: API key management
paths:
  /api/auth/forgot-password:
    post:
      tags:
        - session
      summary: Request a password-reset link
      description: >-
        Always answers 200, whether or not the address has an account. Reporting
        the difference would let anyone test which emails are registered.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - email
              properties:
                email:
                  type: string
                  format: email
      responses:
        '200':
          description: Handled.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Envelope'
                example:
                  success: true
                  result:
                    sent: true
                  message: If that email has an account, a reset link is on its way.
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    Envelope:
      type: object
      required:
        - success
        - result
        - message
      properties:
        success:
          type: boolean
        result: {}
        message:
          type: string
    Failure:
      type: object
      required:
        - success
        - result
        - message
      properties:
        success:
          type: boolean
          const: false
        result:
          type: object
          properties:
            code:
              type: string
        message:
          type: string
          description: Written for a person. Safe to show as-is.
  responses:
    RateLimited:
      description: Too many attempts. On this surface the limit is a brute-force control.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Failure'

````