Email Inbox Import

Overview

Email Inbox Import lets users import CAS statements directly from their email — no file uploads or password sharing needed. Supports Gmail, Outlook, and Zoho Mail. Security features:

Read-only access (cannot send emails)
OAuth-based consent flow
User can revoke access anytime
Tokens encrypted server-side

Supported providers

Pass provider in the connect request to choose the mail service. Defaults to gmail.

Provider	Value	Covers
Gmail	`gmail`	`@gmail.com` and Google Workspace domains
Outlook	`outlook`	Personal Microsoft accounts: `@outlook.com`, `@hotmail.com`, `@live.com`, `@msn.com`, localised variants (`@hotmail.co.uk`, `@live.in`, `@hotmail.fr`), and custom domains registered as personal Microsoft accounts
Zoho Mail	`zoho`	Zoho-hosted mailboxes, including custom domains

Any unrecognised value is treated as gmail. The resolved provider is returned in the connect response and reported by /v4/inbox/status.

Integration flow

Step 1: Initiate OAuth

import requests

response = requests.post(
    "https://api.casparser.in/v4/inbox/connect",
    headers={"x-api-key": "YOUR_API_KEY"},
    json={
        "redirect_uri": "https://yourapp.com/oauth/callback",
        "provider": "outlook",  # "gmail" (default), "outlook", or "zoho"
    }
)

data = response.json()
oauth_url = data["oauth_url"]
# data["provider"] == "outlook"

# Redirect user to oauth_url

The user is redirected to their provider’s OAuth consent screen. After granting access, they’re redirected back to your redirect_uri with an inbox_token:

https://yourapp.com/oauth/callback?inbox_token=eyJhbGciOiJIUzI1NiIs...

The inbox_token is long-lived — it stores an encrypted refresh token. A single OAuth connect gives ongoing access to both historical and future CAS statements in the user’s inbox. Reuse the same token for every /v4/inbox/cas call until the user revokes access via /v4/inbox/disconnect or their provider’s account settings.

Step 3: List CAS files from inbox

inbox_token = request.args.get("inbox_token")

response = requests.post(
    "https://api.casparser.in/v4/inbox/cas",
    headers={
        "x-api-key": "YOUR_API_KEY",
        "x-inbox-token": inbox_token
    }
)

data = response.json()
for cas_file in data["files"]:
    print(f"Found: {cas_file['filename']} ({cas_file['cas_type']})")
    print(f"Download URL: {cas_file['url']}")
    
    # Parse the CAS file
    parse_response = requests.post(
        "https://api.casparser.in/v4/smart/parse",
        headers={"x-api-key": "YOUR_API_KEY"},
        json={
            "pdf_url": cas_file["url"],
            "password": "YOUR_PAN_NUMBER"
        }
    )
    parsed_data = parse_response.json()
    print(f"Portfolio value: ₹{parsed_data['summary']['total_value']:,.2f}")

Step 4: Disconnect (optional)

requests.post(
    "https://api.casparser.in/v4/inbox/disconnect",
    headers={
        "x-api-key": "YOUR_API_KEY",
        "x-inbox-token": inbox_token
    }
)

API endpoints

Endpoint	Description
`POST /v4/inbox/connect`	Get OAuth URL for user consent
`POST /v4/inbox/status`	Check if inbox_token is still valid
`POST /v4/inbox/cas`	List and optionally parse CAS files
`POST /v4/inbox/disconnect`	Revoke access and delete tokens

Response format

{
  "status": "success",
  "files": [
    {
      "message_id": "18d4a2b3c4d5e6f7",
      "filename": "cdsl_20250115_a1b2c3d4.pdf",
      "original_filename": "CDSL_CAS_Statement.pdf",
      "message_date": "2025-01-15",
      "cas_type": "cdsl",
      "sender_email": "ecas@cdslstatement.com",
      "size": 245000,
      "url": "https://cdn.casparser.in/email-cas/user123/cdsl_20250115_a1b2c3d4.pdf",
      "expires_in": 86400
    }
  ],
  "count": 1
}

Download URLs expire in 24 hours. The response contains URLs only — parse each file with /v4/smart/parse.

Credit usage

Operation	Credits
Connect (OAuth)	Free
List files (`/v4/inbox/cas`)	0.2 per pull (any number of files)
Parse file (`/v4/smart/parse`)	1.0 per file

Using with Portfolio Connect SDK

The Portfolio Connect SDK has built-in inbox import across all supported providers:

<PortfolioConnect
  accessToken="at_xxx"
  modes={["upload", "inbox"]}  // Enable email inbox import
  onSuccess={(data) => console.log(data)}
/>

Product Guides

Resources

Overview

Supported providers

Integration flow

Step 1: Initiate OAuth

Step 3: List CAS files from inbox

Step 4: Disconnect (optional)

API endpoints

Response format

Credit usage

Using with Portfolio Connect SDK

Next steps

CDSL OTP Fetch

Portfolio Connect SDK

​Overview

​Supported providers

​Integration flow

​Step 1: Initiate OAuth

​Step 2: User grants consent

​Step 3: List CAS files from inbox

​Step 4: Disconnect (optional)

​API endpoints

​Response format

​Credit usage

​Using with Portfolio Connect SDK

​Next steps

CDSL OTP Fetch

Portfolio Connect SDK

Overview

Supported providers

Integration flow

Step 1: Initiate OAuth

Step 2: User grants consent

Step 3: List CAS files from inbox

Step 4: Disconnect (optional)

API endpoints

Response format

Credit usage

Using with Portfolio Connect SDK

Next steps