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

# Check Email Connection Status

> Verify if an `inbox_token` is still valid and check connection status.

Use this to check if the user needs to re-authenticate (e.g., if they
revoked access in their email provider settings).




## OpenAPI

````yaml /api-reference/openapi.yaml post /v4/inbox/status
openapi: 3.1.0
info:
  title: CAS Parser - Track Portfolios from CDSL, NSDL, CAMS, KFintech
  description: >-
    API for parsing and analyzing CAS (Consolidated Account Statement) PDF files
    from NSDL, CDSL, and CAMS/KFintech, with a unified response format
  version: 4.0.0
  contact:
    name: Sameer Kumar
    email: sameer@casparser.in
servers:
  - url: https://api.casparser.in
    description: Production server
  - url: https://portfolio-parser.api.casparser.in
    description: Legacy production server (still supported)
  - url: http://localhost:5000
    description: Local development server
security: []
tags:
  - name: CAS Parser
    description: Endpoints for parsing CAS PDF files from different sources.
  - name: RTA Sync
    description: >-
      Endpoints for reading CAMS and KFintech RTA files and returning clean
      canonical records.
  - name: CAS Generator
    description: >-
      Endpoints for generating new CAS documents via email mailback (KFintech
      and CAMS).
  - name: CAS Fetch
    description: |
      Endpoints for fetching CAS documents with instant download.
      Currently supports CDSL via OTP authentication.
  - name: Email Import
    description: >
      Endpoints for importing CAS files directly from user email inboxes.


      **Supported Providers:**


      - **Gmail** (`gmail`, default) — `@gmail.com` and Google Workspace domains

      - **Microsoft** (`outlook`) — personal Microsoft accounts: `@outlook.com`,
        `@hotmail.com`, `@live.com`, `@msn.com`, and localised variants such as
        `@hotmail.co.uk`, `@live.in`, `@hotmail.fr`. Any other address registered
        as a personal Microsoft account also works, including custom domains.
      - **Zoho Mail** (`zoho`) — Zoho-hosted mailboxes, including custom domains


      **How it works:**

      1. Call `POST /v4/inbox/connect` to get an OAuth URL

      2. Redirect user to the OAuth URL for consent

      3. User is redirected back to your `redirect_uri` with an encrypted
      `inbox_token`

      4. Use the token to list/fetch CAS files from their inbox
      (`/v4/inbox/cas`)

      5. Files are uploaded to temporary cloud storage (URLs expire in 24 hours)


      **Security:**

      - Read-only access (we cannot send emails)

      - Tokens are encrypted with server-side secret

      - User can revoke access anytime via `/v4/inbox/disconnect`
  - name: Inbound Email
    description: >
      Create dedicated inbound email addresses for investors to forward their
      CAS statements.


      **Use Case:** Your app wants to collect CAS statements from users without
      requiring OAuth or file upload.


      **How it works:**

      1. Call `POST /v4/inbound-email` to create a unique inbound email address

      2. Display this email to your user: "Forward your CAS statement to
      ie_xxx@import.casparser.in"

      3. When user forwards a CAS email, we verify sender authenticity
      (SPF/DKIM) and call your webhook

      4. Your webhook receives email metadata + attachment download URLs


      **Sender Validation:**

      - Only emails from verified CAS authorities are processed:
        - CDSL: `eCAS@cdslstatement.com`
        - NSDL: `NSDL-CAS@nsdl.co.in`
        - CAMS: `donotreply@camsonline.com`
        - KFintech: `samfS@kfintech.com`
      - Emails failing SPF/DKIM/DMARC are rejected

      - Forwarded emails must contain the original sender in headers


      **Billing:** 0.2 credits per successfully processed valid email
  - name: Contract Note Parser
    description: >-
      Endpoints for parsing Contract Note PDF files from various SEBI brokers
      like Zerodha, Groww, Upstox, ICICI etc.
  - name: Authorization
    description: |
      Endpoints for checking API quota and credits usage.
      These endpoints help you monitor your API usage and remaining quota.
  - name: Portfolio Connect
    description: >
      Endpoints for managing access tokens for the Portfolio Connect SDK.

      Use these to generate short-lived `at_` prefixed tokens that can be safely
      passed to frontend applications.

      Access tokens can be used in place of API keys on all v4 endpoints.
  - name: Agent Auth
    description: >
      Endpoints for coding agents to obtain API keys via a browser-based
      approval flow.


      **How it works:**

      1. Agent generates a random token locally (e.g. `openssl rand -hex 32`).
      No API call needed.

      2. Agent asks the user to open
      `https://app.casparser.in/agent-auth?token=<token>&client_name=<name>`

      3. User signs in via the browser and clicks Approve.

      4. Agent polls `GET /v1/agent-auth/token/{token}` every 5 seconds until
      the key is delivered.


      **Security:**

      - Token must be 16-128 characters (recommended: 64 hex chars / 256 bits)

      - Approved keys are delivered once (one-shot) and then deleted

      - Tokens expire after 10 minutes if not approved
  - name: KYC
    description: >
      Endpoints for verifying KYC (Know Your Customer) status of Indian
      investors.


      **Data source:** CVL KRA public inquiry portal (cvlkra.com), which
      aggregates

      records from all five SEBI-registered KRAs: CVL, NDML, CAMS, Karvy, and
      KFin.


      **Status normalization:** Raw CVL portal strings are normalized into clean
      enums.

      See the `kyc_status` property on `KycPanStatusResponse` for the full list.


      **Credits:** 0.25 per successful lookup. Failed lookups are not billed.
  - name: Verification
    description: |
      Verify the regulatory registration of a financial intermediary — a yes/no
      check rather than a directory search.

      - **`/v1/verify/sebi`** — any SEBI-registered intermediary (Investment
        Adviser, Research Analyst, Portfolio Manager, Stock Broker, Mutual Fund,
        AIF, and more). Send a `registration_number` and the category is
        auto-detected from its sequence; or send a `name` with an explicit `type`.
      - **`/v1/verify/mfd`** — AMFI mutual-fund distributors by ARN, including a
        screen against AMFI's suspended / terminated / terminated-EUIN lists.

      A "not found" result is a successful verification (HTTP 200,
      `verified: false`) and is billed. Upstream failures surface as 5xx and are
      not billed.

      **Credits:** 0.25 per successful verification.
paths:
  /v4/inbox/status:
    post:
      tags:
        - Email Import
      summary: Check Email Connection Status
      description: |
        Verify if an `inbox_token` is still valid and check connection status.

        Use this to check if the user needs to re-authenticate (e.g., if they
        revoked access in their email provider settings).
      operationId: inboxStatus
      parameters:
        - name: x-inbox-token
          in: header
          required: true
          schema:
            type: string
          description: The encrypted inbox token
      responses:
        '200':
          description: Token status retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: success
                  connected:
                    type: boolean
                    description: Whether the token is valid and usable
                    example: true
                  provider:
                    type: string
                    example: gmail
                  email:
                    type: string
                    format: email
                    description: Email address of the connected account
                    example: user@gmail.com
        '401':
          description: Token is invalid, expired, or revoked. User must reconnect.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: error
                  msg:
                    type: string
                    example: Email access revoked. Please reconnect.
                  requires_reconnect:
                    type: boolean
                    example: true
      security:
        - ApiKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: |
        Your API key for authentication.
        Use `sandbox-with-json-responses` as Sandbox key.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.