CAMS parser
Documentation

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

Check out CAMS parser demo

Postman logo

Try CASreader API in postman

Download CASreader collection and import it from postman to get started

Download CASreader postman collection

CAMS parser endpoint:

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

Method:

POST

Parameters (form-data):

  1. file - CAMS 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
Warning
Warning if Cams file is incomplete
Example: Incomplete portfolio
String
StatementPeriod
Period of the PDF file
JSON Object of CamsStatementPeriodModel
InvestorInfo
Information of investor
JSON Object of CamsInvestorModel
OrderItems
Scheme level aggregated investment information
JSON Array of CcOrderItemModel

CamsStatementPeriodModel

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

CamsInvestorModel

Field Data type
Email
Email id of the investor
String
Name
Name of the investor
String
Address
Residential Address of the Investor
String
PinCode
Pin code of investor’s home address
String
Contact
Phone number of investor
String

CcOrderItemModel

Field Data type
Index
Iterator of the folio item in the PDF
Integer
KycStatus
KYC status of investor, as given in the PDF
String
PanStatus
PAN card of the investor, linked or not
String
Registrar
Registrar of mutual fund
String
SchemeRtaCode
RTA code of mutual fund
String
SchemeName
Name of mutual fund
String
Folio
Folio number of mutual fund
String
AdvisorCode
Code of distributor
String
Pan
PAN number of investor
String
OpeningBalance
Number of units held by investor at the starting period of statement
Double
ClosingBalanceParsed
Number of units held by investor at the end period of statement. (As mentioned in the statement)
Double
ClosingBalanceManaged
Number of units held by investor at the end period of statement. (Calculated by accounting for Buy and sell transactions)
Double
FolioItems
List of transaction level information of each mutual fund per folio number
JSON Array of CcFolioItemModel

CcFolioItemModel

Field Data type
Index
Iterator to identify unique folio per scheme
Integer
Type
Transaction description
String
BuySell
Transaction type (Either buy or sell)
String
DateString
Date of transaction
String
Nav
NAV at the time of transaction
Double
Units
No. of units in transaction
Double
Folio
Folio number of transaction
String
Amount
Amount of transaction
Double
DateNumeral
Time stamp non formatted date
DateTime
Rate
Rate of dividend. Only applicable if Type is Dividend
Double

CasType

Enum value Enum name
0
Nsdl
1
Cdsl
2
Cams

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