MF CAS EXTRACTION

Introduction

This API allows you to extract your mutual fund data by sending a POST request to our server using the curl command with specific parameters. With this API, you can extract mutual fund data in a CAS file format and provide a password for decryption.

Curl

curl --request POST \
  --url https://signzy.tech/api/v2/patrons/..your-patron-id../mutualFund \
  --header 'Accept: */*' \
  --header 'Accept-Language: en-US,en;q=0.8' \
  --header 'content-type: application/json' \
  --data '{"task":"mfCASExtraction","essentials":{"file":"... Cas File...","password":"...password..."}}'

Request Parameters

Parameter	Data Type	Required	Description
task	string	Yes	The type of task to be performed by the API. In this case, "mfCASExtraction" specifies that the mutual fund data extraction task is to be performed.
essentials.file	string	Yes	The path or location of the CAS file containing the mutual fund data.
essentials.password	string	Yes	The password is used to decrypt the mutual fund data in the CAS file.

Response Parameters

{
    "essentials": {
        "file": " ... Cas file ...",
        "password": "...Password..."
    },
    "id": "60xxxxxxxxxxxxxxxxxxxxxxxxxx",
    "patronId": "60xxxxxxxxxxxxxxxxxxxxxxxxxx",
    "task": "mfCASExtraction",
    "result": [{
        "casType": "...Cas type...",
        "statementPeriod": {
            "from": "...dd/mm/yyyy...",
            "to": "...dd/mm/yyyy..."
        },
        "fileType": "...FileType...",
        "folios": [{
            "folio": "...folio...",
            "amc": "...amc...",
            "PAN": "...PAN ...",
            "KYC": "...KYC...",
            "PANKYC": "...PANKYC...",
            "schemes": [{
                "scheme": "...scheme...",
                "advisor": "...advisor...",
                "rtaCode": "...rta_code...",
                "type": "...type...",
                "rta": "...rta...",
                "isin": "...isin...",
                "amfi": "...amfi...",
                "open": "...open...",
                "close": "...close...",
                "closeCalculated": "...close_calculated ...",
                "valuation": {
                    "date": "...dd/mm/yyyy...",
                    "value": "...value...",
                    "nav": "...nav..."
                },
                "transactions": [{
                    "date": "...dd/mm/yyyy...",
                    "description": "...description...",
                    "amount": "...amount...",
                    "units": "...units...",
                    "nav": "...nav...",
                    "balance": "...balance...",
                    "type": "...type...",
                    "dividendRate": "...dividend_rate..."
                }]
            }]
        }],
        "investorInfo": {
            "name": "...name...",
            "email": "....email..",
            "address": "...address...",
            "mobile": "...mobileNo..."
        }
    }]
}

Parameter	Data Type	Required	Description
essentials	object	Yes	An object that contains information about the CAS file and the password used to decrypt the mutual fund data.
essentials.file	string	Yes	The path or location of the CAS file containing the mutual fund data.
essentials.password	string	Yes	The password used to decrypt the mutual fund data in the CAS file.
id	string	Yes	The unique ID of the mutual fund extraction task.
patronId	string	Yes	The ID of the user who initiated the mutual fund extraction task.
task	string	Yes	The type of task performed by the API. In this case, "mfCASExtraction" specifies that the mutual fund data extraction task was performed.
result	array	Yes	An array of objects containing the extracted mutual fund data.
result.casType	string	Yes	The type of the CAS file containing the mutual fund data.
result.statementPeriod	object	Yes	An object that contains the start and end dates of the statement period for the mutual fund data.
result.statementPeriod.from	string	Yes	The start date of the statement period in the format dd/mm/yyyy.
result.statementPeriod.to	string	Yes	The end date of the statement period in the format dd/mm/yyyy.
result.fileType	string	Yes	The type of file that contains the mutual fund data.
result.folios	array	Yes	An array of objects containing the mutual fund data for each folio.
result.folios.folio	string	Yes	The folio number of the mutual fund investment.
result.folios.amc	string	Yes	The name of the Asset Management Company (AMC) managing the mutual fund investment.
result.folios.PAN	string	Yes	The PAN number of the investor.
result.folios.KYC	string	Yes	The KYC status of the investor.
result.folios.PANKYC	string	Yes	The PAN-KYC status of the investor.
result.folios.schemes	array	Yes	An array of objects containing information about the mutual fund schemes invested in the folio.
result.folios.schemes.scheme	string	Yes	The name of the mutual fund scheme.
result.folios.schemes.advisor	string	Yes	The name of the advisor who recommended the mutual fund scheme.
result.folios.schemes.rtaCode	string	Yes	The RTA code of the mutual fund scheme.
result.folios.schemes.type	string	Yes	The type of mutual fund scheme.
result.folios.schemes.rta	string	Yes	The name of the Registrar and Transfer Agent (RTA) of the mutual fund scheme.
result.folios.schemes.isin	string	Yes	The International Securities Identification Number (ISIN) of the mutual fund scheme.
result.folios.schemes.amfi	string	Yes	The Association of Mutual Funds in India (AMFI) code of the mutual fund scheme.
result.folios.schemes.open	string	Yes	The date the mutual fund scheme was opened in the format dd/mm/yyyy.
result.folios.schemes.close	string	Yes	The date the mutual fund scheme was closed in the format dd/mm/yyyy.
result.folios.schemes.closeCalculated	string	Yes	The calculated close date of the mutual fund scheme in the format dd/mm

result.folios.valuation.date	String (Date)	Required	The date of valuation.
result.folios.valuation.value	String	Required	The value of the scheme.
result.folios.valuation.nav	String	Required	The NAV (Net Asset Value) of scheme.

result.folios.transactions.date	String (Date)	Required	The date of the transaction.
result.folios.transactions.description	String	Required	The description of the transaction.
result.folios.transactions.amount	String	Required	The amount of the transaction.
result.folios.transactions.units	String	Required	The units involved in the transaction.
result.folios.transactions.nav	String	Required	The NAV (Net Asset Value) of the transaction.
result.folios.transactions.balance	String	Required	The balance after the transaction.
result.folios.transactions.type	String	Required	The type of transaction.
result.folios.transactions.dividendRate	String	Required	The dividend rate of the transaction.

result.investorInfo.name	String	Required	The name of the investor.
result.investorInfo.email	String	Required	The email of the investor.
result.investorInfo.address	String	Required	The address of the investor.
result.investorInfo.mobile	String	Required	The mobile number of the investor.