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

# Request a password reset token

> Generates a one-time reset token for the given email. The raw token should be delivered to the user via email.



## OpenAPI

````yaml /api-reference/openapi.json post /api/v1/auth/forgot-password
openapi: 3.0.0
info:
  title: PlugToPay API
  description: API to make payments easy in multiple gateways.
  version: 1.0.0
servers:
  - url: http://localhost:7701
    description: Test Server
security: []
paths:
  /api/v1/auth/forgot-password:
    post:
      tags:
        - Auth
      summary: Request a password reset token
      description: >-
        Generates a one-time reset token for the given email. The raw token
        should be delivered to the user via email.
      operationId: 2371555a87ccdfc5cf349111759901a9
      parameters:
        - $ref: '#/components/parameters/XClientId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
                - client_id
                - email
              properties:
                client_id:
                  type: string
                  example: client_a1b2c3d4e5f6g7h8
                email:
                  type: string
                  format: email
                  example: john@example.com
              type: object
      responses:
        '200':
          description: Reset token generated (or silent success if email not found)
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                    example: >-
                      Password reset token generated. Deliver it to the user via
                      email.
                  reset_token:
                    type: string
                    example: a1b2c3d4e5f6...
                    nullable: true
                  expires_in:
                    type: string
                    example: 1 hour
                    nullable: true
                type: object
        '422':
          description: Validation Error
components:
  parameters:
    XClientId:
      name: x-client-id
      in: header
      description: Client identifier for the company in the request.
      required: true
      schema:
        type: string
        example: client_abc123

````