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

# Start password recovery

> Start password recovery



## OpenAPI

````yaml openapi.oms.en.json POST /api/auth/recovery/start
openapi: 3.0.3
info:
  title: VOS OMS Public API
  version: 1.0.0
  description: >-
    Public REST API surface for Vero OMS. Authentication requests use
    platform.verolabs.co. REST API requests use api-oms.verolabs.co.
servers:
  - url: https://platform.verolabs.co
    description: Authentication host
  - url: https://api-oms.verolabs.co
    description: REST API host
security: []
tags:
  - name: Authentication
    description: Account authentication and password recovery.
  - name: Trading
    description: Order entry, quote, IOI, and trading activity APIs.
  - name: Portfolio & Risk
    description: Accounts, holdings, mappings, and risk-rule read APIs.
  - name: Administration
    description: Permissions, groups, workflow, reference data, and audit APIs.
  - name: System & Diagnostics
    description: Health and latency endpoints.
paths:
  /api/auth/recovery/start:
    post:
      tags:
        - Authentication
      summary: Start password recovery
      description: >-
        Sends a one-time recovery code to the account email address and creates
        a short-lived recovery session. Preserve the response cookie for the
        verify and reset requests.
      operationId: post_api_auth_recovery_start
      requestBody:
        required: true
        description: Account email address.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthRecoveryStartRequest'
      responses:
        '200':
          description: Recovery code accepted for delivery
          headers:
            Set-Cookie:
              description: >-
                Short-lived recovery session cookie required by the next
                recovery request.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthRecoveryStartResponse'
        '400':
          $ref: '#/components/responses/AuthError'
        '502':
          $ref: '#/components/responses/AuthError'
      servers:
        - url: https://platform.verolabs.co
components:
  schemas:
    AuthRecoveryStartRequest:
      type: object
      properties:
        email:
          type: string
          format: email
          description: Email address associated with the Vero OMS account.
      required:
        - email
      description: Request to send a one-time password-recovery code.
      additionalProperties: false
    AuthRecoveryStartResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - code_sent
          description: Indicates that the recovery code request was accepted.
      required:
        - status
      description: Password-recovery start status.
      additionalProperties: false
    AuthError:
      type: object
      properties:
        error:
          type: string
          description: Machine-readable error code or error category.
        message:
          type: string
          description: Human-readable error message.
        status:
          type: integer
          format: int32
          description: Status value returned by the API.
      required:
        - error
        - message
        - status
      description: AuthError schema.
  responses:
    AuthError:
      description: Authentication error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AuthError'

````