Skip to main content

Overview

All CAS parsing endpoints return a unified JSON structure regardless of source (CDSL, NSDL, CAMS, KFintech).

Top-Level Structure

{
  "status": "success",
  "cas_type": "cdsl",
  "meta": { ... },
  "investor": { ... },
  "summary": { ... },
  "demat_accounts": [ ... ],
  "mutual_funds": [ ... ],
  "insurance": [ ... ],
  "nps": [ ... ]
}

Status Field

ValueDescription
successParsing completed successfully
failedParsing failed (see msg field)

Meta Object

{
  "meta": {
    "cas_type": "cdsl",
    "statement_date": "2024-01-31",
    "generated_on": "2024-02-01T10:30:00Z"
  }
}
FieldTypeDescription
cas_typestringcdsl, nsdl, or cams_kfintech
statement_datestringDate of the statement (YYYY-MM-DD)
generated_onstringWhen the CAS was generated (ISO 8601)

Investor Object

{
  "investor": {
    "name": "John Doe",
    "email": "john@example.com",
    "pan": "ABCDE1234F",
    "mobile": "9876543210",
    "address": "123 Main St, Mumbai 400001"
  }
}
FieldTypeRequiredDescription
namestringYesFull name
emailstringNoEmail address
panstringYesPAN number
mobilestringNoMobile number
addressstringNoFull address

Summary Object

{
  "summary": {
    "total_value": 2547832.50,
    "as_on_date": "2024-01-15",
    "accounts": {
      "demat_accounts": 2,
      "mutual_fund_folios": 5,
      "insurance_policies": 1,
      "nps_accounts": 1
    }
  }
}
FieldTypeDescription
total_valuenumberTotal portfolio value in ₹
as_on_datestringValuation date (YYYY-MM-DD)
accountsobjectCount of each account type

Demat Accounts Array

{
  "demat_accounts": [
    {
      "dp_id": "12345678",
      "dp_name": "HDFC Bank Limited",
      "client_id": "1234567890123456",
      "total_value": 1500000.00,
      "equities": [ ... ],
      "corporate_bonds": [ ... ],
      "mutual_funds": [ ... ],
      "aifs": [ ... ],
      "etfs": [ ... ],
      "g_secs": [ ... ]
    }
  ]
}

Demat Account Fields

FieldTypeDescription
dp_idstringDepository Participant ID (8 digits)
dp_namestringDP name (e.g., “HDFC Bank”)
client_idstringClient ID (16 digits)
total_valuenumberTotal value of this account

Equity Object

{
  "isin": "INE002A01018",
  "name": "Reliance Industries Ltd",
  "units": 100,
  "current_value": 250000.00,
  "market_price": 2500.00,
  "transactions": [
    {
      "date": "2023-06-15",
      "type": "BUY",
      "quantity": 50,
      "price": 2400.00,
      "value": 120000.00
    }
  ]
}
FieldTypeDescription
isinstringISIN code (12 chars)
namestringSecurity name
unitsnumberNumber of shares held
current_valuenumberCurrent market value
market_pricenumberPrice per share
transactionsarrayTransaction history (optional)

Corporate Bond Object

{
  "isin": "INE123A01234",
  "company_name": "HDFC Ltd",
  "number_of_bonds": 10,
  "coupon_rate": "8.5%",
  "maturity_date": "2027-12-31",
  "face_value": 1000,
  "market_value": 1050,
  "value": 10500
}
FieldTypeDescription
isinstringISIN code
company_namestringIssuer name
number_of_bondsnumberQuantity held
coupon_ratestringInterest rate
maturity_datestringMaturity date (YYYY-MM-DD)
face_valuenumberFace value per bond
market_valuenumberMarket value per bond
valuenumberTotal value

Mutual Funds Array

{
  "mutual_funds": [
    {
      "folio": "1234567890",
      "amc": "HDFC Mutual Fund",
      "pan": "ABCDE1234F",
      "schemes": [
        {
          "scheme": "HDFC Equity Fund - Growth",
          "isin": "INF179K01234",
          "units": 1000.50,
          "nav": 450.75,
          "value": 451000.88,
          "transactions": [ ... ]
        }
      ]
    }
  ]
}

Mutual Fund Fields

FieldTypeDescription
foliostringFolio number
amcstringAsset Management Company
panstringInvestor PAN
schemesarrayList of schemes in this folio

Scheme Object

FieldTypeDescription
schemestringScheme name
isinstringISIN code
unitsnumberUnits held
navnumberNet Asset Value
valuenumberCurrent value (units × NAV)
transactionsarrayTransaction history

Transaction Object

{
  "date": "2023-06-15",
  "type": "PURCHASE",
  "amount": 10000.00,
  "units": 22.18,
  "nav": 450.86,
  "balance": 1000.50
}
FieldTypeDescription
datestringTransaction date (YYYY-MM-DD)
typestringPURCHASE, REDEMPTION, DIVIDEND, etc.
amountnumberTransaction amount
unitsnumberUnits transacted
navnumberNAV at transaction
balancenumberUnits balance after transaction

Insurance Array

{
  "insurance": [
    {
      "policy_number": "POL123456",
      "provider": "HDFC Life",
      "plan": "Term Insurance",
      "sum_assured": 10000000,
      "premium": 15000,
      "maturity_date": "2045-12-31"
    }
  ]
}

NPS Array

{
  "nps": [
    {
      "pran": "123456789012",
      "tier": "Tier I",
      "fund_type": "Equity",
      "units": 5000.50,
      "nav": 45.67,
      "value": 228472.84
    }
  ]
}

Error Response

{
  "status": "failed",
  "msg": "Invalid password for PDF",
  "code": "INVALID_PASSWORD"
}
FieldTypeDescription
statusstringAlways failed for errors
msgstringHuman-readable error message
codestringError code for programmatic handling

Common Error Codes

CodeDescriptionSolution
INVALID_PASSWORDWrong PDF passwordCheck PAN format
INVALID_PDFCorrupted/scanned PDFUse original digital PDF
UNSUPPORTED_FORMATNot a CAS fileUpload CAS, not bank statement
PARSING_ERRORInternal parsing failureContact support with request ID

Next Steps