NSDL parser
Documentation

This documentation will guide you on how to parse NSDL PDF and what JSON response will be retured after extracting data from the NSDL PDF

Check out NSDL parser demo

Postman logo

Try CASreader API in postman

Download CASreader collection and import it from postman to get started

Download CASreader postman collection

NSDL parser endpoint:

https://api.casreader.com/parse/nsdl

Method:

POST

Parameters (form-data):

  1. file - NSDL CAS pdf. File size limit is 10 MB.
  2. password - Password of the file. Optional and case sensitive.
  3. key - Client access key. Required and case sensitive.

Response:

JSON, charset=utf-8. JSON strcuture is documented below.

JSON Response

Field Data type
success
Status of API response, has value either true or false.
Boolean
data
Entire parsed data of the uploaded statement
if success is true JSON Object of data
if success is false JSON Object of error

data

Field Data type
CasType
Uploaded pdf type
ENUM of type CasType
ClientCode
Client/User id as held in your database. This field will be set by you.
String
ParsedData
Parsed data from PDF
JSON Object of NcParsedModel

NcParsedModel

Field Data type
StatementPeriod
Period of the PDF file
JSON Object of NcStatementPeriodModel
InvestorInfo
Information of investor
JSON Object of NcInvestorModel
AccountInfo
Account details held by investor
JSON Object of NcAccountListModel
NsdlInfo
Nsdl account details
JSON Object of NcNsdlAccountModelList
CdslInfo
Cdsl account details
JSON Object of NcCdslAccountModelList
MutualFundFolioInfo
Independently held Mutual Fund's details
JSON Object of NcMffAccountListModel
InsuranceInfo
Insurance details held by investor
JSON Object of NcInsuranceInfoModel

NcStatementPeriodModel

Field Data type
From
Starting date of tenure of uploaded PDF
String
To
Ending date of tenure of uploaded PDF
String

NcInvestorModel

Field Data type
CasId
Unique Identifier for investor
String
Name
Name of the investor
String
Address
Residential address of the investor
String
PinCode
Pin code of investor’s home address
String
Pancard
Pan card number of investor address
String

NcAccountListModel

Field Data type
TotalAccount
Number of accounts (NSDL, CDSL and Independent Mutual Fund folios) held by the investor
Integer
GrandTotal
Total investment amount of investor
Double
Accounts
List of all the accounts held by investor.
JSON Array of NcAccountModel

NcNsdlAccountModelList

Field Data type
TotalAccount
Total NSDL account held by investor
Integer
TotalValue
Total invsetment value in NSDL accounts
Double
Accounts
List of all the NSDL accounts
JSON Array of NcNsdlAccountModel

NcCdslAccountModelList

Field Data type
TotalAccount
Total CDSL account held by investor
Integer
TotalValue
Total invsetment value in CDSL accounts
Double
Accounts
List of all the CDSL accounts
JSON Array of NcCdslAccountModel

NcMffAccountListModel

Field Data type
TotalAccount
Total mutual fund folios held by investor
Integer
TotalValue
Total invsetment value in Mutual fund folios
Double
Accounts
List of all the mutual fund folios
JSON Array of NcMffAccountModel

NcInsuranceInfoModel

Field Data type
InsuranceHolderName
Name of the insurance holder
String
TotalInsurance
Total number of insurance
Integer
TotalValue
Total value in all the insurances
Double
Insurances
List of all the insurances
JSON Array of NcInsuranceModel
LifeInsurancePolicies
List of all the insurance policies
JSON Object of NcLifeInsurancePolicyListModel

NcAccountModel

Field Data type
AccountType
Account is either NSDL, CDSL or independently held Mutual Fund
String
AccountDetails
Name of Demat account service provider
String
Value
Total investment held with this DP
Double
DpId
Unique identifier of DP
String
ClientId
Unique identifier of investor in the DP
String
AccountClass
Classification for type of account
ENUM of type NsdlCasAccountClass

NcNsdlAccountModel

Field Data type
AccountType
Type of the account: NSDL
String
AccountDetails
Name of Demat account service provider
String
DpId
Unique identifier of DP
String
ClientId
Unique identifier of investor in the DP
String
Value
Total investment held with this DP
Double
EquityList
All the equities in NSDL account
JSON Object of NcNsdlEquityShareListModel
CorporateBondList
All the corporate bonds in NSDL account
JSON Object of NcNsdlCorporateBondListModel
MutualFundList
All the mutual funds in NSDL account
JSON Object of NcNsdlMutualFundListModel
GovernmentSecurityList
All the government securities in NSDL account
JSON Object of NcNsdlGovernmentSecurityListModel

NcCdslAccountModel

Field Data type
AccountType
Type of the account: CDSL
String
AccountDetails
Name of Demat account service
String
DpId
Unique identifier of DP
String
ClientId
Unique identifier of investor in the DP
String
Value
Total investment held with this DP
Double
EquityList
All the equities help in CDSL account
JSON Object of NcCsdlEquityListModel
MutualFundList
All the mutual funds in CDSL account
JSON Object of NcCdslMutualFundListModel
CorporateBondList
All the corporate bonds in CDSL account
JSON Object of NcCdslCorporateBondListModel
GovernmentSecurityList
All the government securities in CDSL account
JSON Object of NcCdslGovernmentSecurityListModel

NcMffAccountModel

Field Data type
AccountType
Type of the account: MFF
String
AccountDetails
Folios details as in PDF
String
Value
Total investment held with physicals
Double
MutualFundFolioList
All the mutual fund folios details
JSON Object of NcMutualFundFolioListModel

NcInsuranceModel

Field Data type
PolicyType
Type of insurance policy
String
NumberOfPolicies
Total number of policies
Integer
NumberOfInsuranceCompanies
Total number of insurance companies
Integer
Value
Total value in this insurance
Double

NcLifeInsurancePolicyListModel

Field Data type
TotalPolicy
Type of life insurance policy
Integer
TotalValue
Total value in this life insurance
Double
Policies
List of all the life insurance policies
JSON Array of NcLifeInsurancePolicyModel

NcNsdlEquityShareListModel

Field Data type
TotalEquityShare
Total number of equity share held under the current DP in NSDL account
Integer
TotalValue
Total value of equity shares held by this NSDL account
Double
Equities
List of all the NSDL equity shares
JSON Array of NcNsdlEquityShareModel

NcNsdlCorporateBondListModel

Field Data type
TotalCorporateBond
Total number of corporate bonds held under the current DP in NSDL account
Integer
TotalValue
Total value of corporate bonds held by this NSDL account
Double
CorporateBonds
List of all the NSDL corporate bonds
JSON Array of NcNsdlCorporateBondModel

NcNsdlMutualFundListModel

Field Data type
TotalMutualFund
Total number of mutual fund held under the current DP in NSDL account
Integer
TotalValue
Total value of mutual funds held by this NSDL account
Double
MutualFunds
List of all the NSDL mutual funds
JSON Array of NcNsdlMutualFundModel

NcNsdlGovernmentSecurityListModel

Field Data type
TotalGovernmentSecurity
Total number of government security held under the current DP in NSDL account
Integer
TotalValue
Total value of government securities held by this NSDL account
Double
GovernmentSecurities
List of all the NSDL government securities
JSON Array of NcNsdlGovernmentSecurityModel

NcCsdlEquityListModel

Field Data type
TotalEquity
Total number of equity held under the current DP in CDSL account
Integer
TotalValue
Total value of equity shares held by this CDSL account
Double
Equities
List of all the CDSL equities
JSON Array of NcCdslEquityModel

NcCdslMutualFundListModel

Field Data type
TotalMutualFund
Total number of mutual fund held under the current DP in CDSL account
Integer
TotalValue
Total value of mutual funds held by this CDSL account
Double
MutualFunds
List of all the CDSL mutual funds
JSON Array of NcCdslMutualFundModel

NcCdslCorporateBondListModel

Field Data type
TotalBond
Total number of corporate bond held under the current DP in CDSL account
Integer
TotalValue
Total value of corporate bonds held by this CDSL account
Double
CorporateBonds
List of all the CDSL corporate bonds
JSON Array of NcCdslCorporateBondModel

NcCdslGovernmentSecurityListModel

Field Data type
TotalGovernmentSecurity
Total number of government security held by CDSL account
Integer
TotalValue
Total value of government securities held by this CDSL account
Double
GovernmentSecurities
List of all the CDSL government securities
JSON Array of NcCdslGovernmentSecurityModel

NcMutualFundFolioListModel

Field Data type
TotalMutualFundFolio
Total number of mutual fund folios
Integer
MutualFundFolios
List of all the mutual fund folios
JSON Array of NcMutualFundFolioModel

NcLifeInsurancePolicyModel

Field Data type
HolderName
Life insurance policy holder name
String
CompanyName
Name of the company providing the policy
String
PolicyName
Name of the policy
String
PolicyNumber
Policy number
String
Status
Status of the policy
String
PremiumInstallment
Premium installment value
Double
Frequency
Premium frequency of the policy
String
Value
Value of the policy
Double

NcNsdlEquityShareModel

Field Data type
EquityType
Type of share. General or Preference
ENUM of type EquityType
Isin
ISIN id of Equity
String
StockSymbol
Symbol of Equity
String
CompanyName
Name of Share
String
NumberOfShares
Numbers shares held of equity
Double
Value
Market value of current share holding
Double

NcNsdlCorporateBondModel

Field Data type
Isin
ISIN id of Corporate Bond
String
CompanyName
Issuer of corporate bond
String
CouponRate
Coupon rate of the bond
Double
Frequency
Frequency of the coupon rate
String
MaturityDate
Date of maturity of the bond
String
NumberOfBonds
Number of bonds held of the given corporate bond
Double
FaceValue
The face value of corporate bond
Double
Value
The value of corporate bond
Double
InterestType
Interest type of the bond
ENUM of type InterestType
Interest
Interest type of the bond
String

NcNsdlMutualFundModel

Field Data type
Isin
ISIN id of Mutual Fund
String
IsinDescription
Name of Mutual Fund
String
NumberOfUnits
Numbers units held of mutual fund
Double
Value
Market value of the mutual fund
Double

NcNsdlGovernmentSecurityModel

Field Data type
Isin
ISIN id of Government Security
String
IssuerName
Issuer of government security
String
CouponRate
Coupon rate of security
Double
Frequency
Frequency of coupon rate
String
MaturityDate
Date of maturity of security
String
NumberOfUnits
Number of bonds held of the given security
Double
FaceValue
The face value of security
Double
Value
The value of security
Double

NcCdslEquityModel

Field Data type
EquityType
Type of share. General or Preference
ENUM of type EquityType
Isin
ISIN id of Equity
String
Security
Name of the secutiry
String
CurrentBalance
Current balance of the equity
Double
Value
Value of the equity
Double

NcCdslCorporateBondModel

Field Data type
Isin
ISIN id of the bond
String
Security
Name of the secutiry
String
CurrentBalance
Current balance of the equity
Double
Value
Value of the equity
Double

NcCdslMutualFundModel

Field Data type
Isin
ISIN id of mutual fund
String
Security
Name of the fund
String
CurrentBalance
Current balance of the fund
Double
Value
Value of the fund
Double

NcCdslGovernmentSecurityModel

Field Data type
Isin
ISIN id of Government Security
String
IssuerName
Issuer of government security
String
CouponRate
Coupon rate of security
Double
MaturityDate
Date of maturity of security
String
NumberOfUnits
Number of bonds held of the given security
Double
FaceValue
The face value of security
Double
Value
The value of security
Double

NcMutualFundFolioModel

Field Data type
Isin
ISIN id of mutual fund folio
String
IsinName
Name of Mutual Fund Folio
String
FolioNumber
Folio number of Mutual Fund
String
NumberOfUnits
Numbers units held
Double
AverageCostPerUnits
Average cost per unit of the fund
Double
Value
Value of the fund
Double
InvestmentValue
Investment value of the fund
Double

CasType

Enum value Enum name
0
Nsdl
1
Cdsl
2
Cams

NsdlCasAccountClass

Enum value Enum name
0
Nsdl
1
Cdsl
2
Mff

InterestType

Enum value Enum name
0
None
1
Zero
2
Fixed
3
Variable
4
No
5
IndexLinked

EquityType

Enum value Enum name
0
General
1
Preference

error

Code (Integer) Error (String)
17 credits are expired or pdf limit was reached
18 pdf file size was exceeded. maximum file size limit is 10 MB
20 key is disabled
21 cams parser is disabled for the key
22 nsdl parser is disabled for the key
23 cdsl parser is disabled for the key
31 account is disabled, contact us
32 invalid client access key
33 client ip is not whitelisted for the key
404 this end point does not exists
500 internal server error
599 file was corrupted or not uploaded completely
699 incorrect pdf file
799 incorrect password
999 not a pdf file
Tunnel in