Fetch DataBy CIN Realtime

4 min

Introduction

The curl command provided is an example of using the Signzy API to fetch real-time company consolidated data. Signzy is a digital trust infrastructure that provides various APIs to automate and streamline business processes. This particular API is designed to provide real-time company consolidated data for a given Patron ID and Company Identification Number (CIN) via a callback URL. To access this API, you need to provide your access token in the Authorization header. The example uses the HTTP POST method to send a JSON payload with the necessary parameters to the API endpoint URL. In this document.

Sample Curl

curl --request POST \
  --url https://signzy.tech/api/v2/patrons/...patronID.../companyconsolidated \
  --header 'Accept: */*' \
  --header 'Accept-Language: en-US,en;q=0.8' \
  --header 'Authorization: <Access-Token>' \
  --header 'content-type: application/json' \
  --data '{"task":"fetchRealtime","essentials":{"cin":"...cin...", "callbackUrl":"...callbackUrl..."}}'

Parameter Name	Description
URL	The endpoint URL for accessing the API to fetch real-time company consolidated data.
HTTP Method	The HTTP request method used to send a request to the API endpoint. In this case, the method is POST.
Accept	The acceptable response format for the API endpoint. In this case, the value is set to */*, meaning any format is accepted.
Accept-Language	The preferred language for the API response. In this example, it is set to en-US,en;q=0.8.
Authorization	The access token used to authenticate the API request. It must be included in the header of the API request.
content-type	The content type of the request payload. In this case, it is application/json.
patronID	The unique identifier for the patron who is requesting the company consolidated data.
cin	The Company Identification Number (CIN) for the company for which consolidated data is being requested.
callbackUrl	The URL to which the API will send a callback when the data is available.
task	The type of task to be performed by the API endpoint. In this case, it is set to fetchRealtime.

Sample Response

{
    "result": {
      "companyData": {
          "authorizedCapital": "...authorizedCapital...",
          "cin": "...cin...",
          "efilingStatus": "...efilingStatus...",
          "dateOfIncorporation": "...dateOfIncorporation...",
          "legalName": "...legalName...",
          "companyName": "...companyName...",
          "paidUpCapital": "...paidUpCapital...",
          "sumOfCharges": "...sumOfCharges...",
          "registeredAddress": {
              "addressLine1": "...addressLine1...",
              "addressLine2": "...addressLine2...",
              "city": "...city...",
              "pincode": "...pincode...",
              "state": "...state..."
          },
          "businessAddress": {
              "addressLine1": "...addressLine1...",
              "addressLine2": "...addressLine2...",
              "city": "...city...",
              "pincode": "...pincode...",
              "state": "...state..."
          },
          "pan": "...pan...",
          "classification": "...classification...",
          "status": "...status...",
          "nextCin": "...nextCin...",
          "lastAgmDate": "...lastAgmDate...",
          "lastFilingDate": "...lastFilingDate...",
          "email": "...email...",
          "authorizedSignatories": [{
              "pan": "...pan...",
              "din": "...din...",
              "name": "...name...",
              "designation": "...designation...",
              "dateOfBirth": "...dateOfBirth...",
              "age": "...age...",
              "dateOfAppointment": "...dateOfAppointment...",
              "dateOfAppointmentForCurrentDesignation": "...dateOfAppointmentForCurrentDesignation...",
              "dateOfCessation": "...dateOfCessation..."
          }],
          "charges": "...list of charges...",
          "auditors": [{
              "year": "...year...",
              "auditorName": "...auditorName...",
              "auditorFirmName": "...auditorFirmName...",
              "pan": "...pan...",
              "membershipNumber": "...membershipNumber...",
              "firmRegistrationNumber": "...firmRegistrationNumber...",
              "address": "...address..."
          }],
          "detailedFinancials": [{
              "year": "...year...",
              "nature": "...nature...",
              "statedOn": "...statedOn...",
              "filingStandard": "...filingStandard...",
              "bs": {
                  "assets": {
                      "tangibleAssets": "...tangibleAssets...",
                      "producingProperties": "...producingProperties...",
                      "intangibleAssets": "...intangibleAssets...",
                      "preproducingProperties": "...preproducingProperties...",
                      "tangibleAssetsCapitalWorkInProgress": "...tangibleAssetsCapitalWorkInProgress...",
                      "intangibleAssetsUnderDevelopment": "...intangibleAssetsUnderDevelopment...",
                      "noncurrentInvestments": "...noncurrentInvestments...",
                      "deferredTaxAssetsNet": "...deferredTaxAssetsNet...",
                      "foreignCurrMonetaryItemTransDiffAssetAccount": "...foreignCurrMonetaryItemTransDiffAssetAccount...",
                      "longTermLoansAndAdvances": "...longTermLoansAndAdvances...",
                      "otherNoncurrentAssets": "...otherNoncurrentAssets...",
                      "currentInvestments": "...currentInvestments...",
                      "inventories": "...inventories...",
                      "tradeReceivables": "...tradeReceivables...",
                      "cashAndBankBalances": "...cashAndBankBalances...",
                      "shortTermLoansAndAdvances": "...shortTermLoansAndAdvances...",
                      "otherCurrentAssets": "...otherCurrentAssets...",
                      "givenAssetsTotal": "...givenAssetsTotal..."
                  },
                  "liabilities": {
                      "shareCapital": "...shareCapital...",
                      "reservesAndSurplus": "...reservesAndSurplus...",
                      "moneyReceivedAgainstShareWarrants": "...moneyReceivedAgainstShareWarrants...",
                      "shareApplicationMoneyPendingAllotment": "...shareApplicationMoneyPendingAllotment...",
                      "deferredGovernmentGrants": "...deferredGovernmentGrants...",
                      "minorityInterest": "...minorityInterest...",
                      "longTermBorrowings": "...longTermBorrowings...",
                      "deferredTaxLiabilitiesNet": "...deferredTaxLiabilitiesNet...",
                      "foreignCurrMonetaryItemTransDiffLiabilityAccount": "...foreignCurrMonetaryItemTransDiffLiabilityAccount...",
                      "otherLongTermLiabilities": "...otherLongTermLiabilities...",
                      "longTermProvisions": "...longTermProvisions...",
                      "shortTermBorrowings": "...shortTermBorrowings...",
                      "tradePayables": "...tradePayables...",
                      "otherCurrentLiabilities": "...otherCurrentLiabilities...",
                      "shortTermProvisions": "...shortTermProvisions...",
                      "givenLiabilities_total": "...givenLiabilities_total...",
                      "givenLiabilitiesTotal": "...givenLiabilitiesTotal..."
                  },
                  "subTotals": {
                      "totalEquity": "...totalEquity...",
                      "totalCurrentLiabilities": "...totalCurrentLiabilities...",
                      "netFixedAssets": "...netFixedAssets...",
                      "totalCurrentAssets": "...totalCurrentAssets...",
                      "capitalWip": "...capitalWip...",
                      "totalDebt": "...totalDebt..."
                  },
                  "metadata": {
                    "fileName": "...fileName...",
                    "fileURL": "...fileURL..."
                }
              },
              "pnl": {
                  "lineItems": {
                      "netRevenue": "...netRevenue...",
                      "totalCostOfMaterialsConsumed": "...totalCostOfMaterialsConsumed...",
                      "totalPurchasesOfStockInTrade": "...totalPurchasesOfStockInTrade...",
                      "totalChangesInInventoriesOrFinishedGoods": "...totalChangesInInventoriesOrFinishedGoods...",
                      "totalEmployeeBenefitExpense": "...totalEmployeeBenefitExpense...",
                      "totalOtherExpenses": "...totalOtherExpenses...",
                      "operatingProfit": "...operatingProfit...",
                      "otherIncome": "...otherIncome...",
                      "depreciation": "...depreciation...",
                      "profitBeforeInterestAndTax": "...profitBeforeInterestAndTax...",
                      "interest": "...interest...",
                      "profitBeforeTaxAndExceptionalItemsBeforeTax": "...profitBeforeTaxAndExceptionalItemsBeforeTax...",
                      "exceptionalItemsBeforeTax": "...exceptionalItemsBeforeTax...",
                      "profitBeforeTax": "...profitBeforeTax...",
                      "incomeTax": "...incomeTax...",
                      "profitForPeriodFromContinuingOperations": "...profitForPeriodFromContinuingOperations...",
                      "profitFromDiscontinuingOperationAfterTax": "...profitFromDiscontinuingOperationAfterTax...",
                      "minorityInterestAndProfitFromAssociatesAndJointVentures": "...minorityInterestAndProfitFromAssociatesAndJointVentures...",
                      "profitAfterTax": "...profitAfterTax..."
                  },
                  "subTotals": {
                      "totalOperatingCost": "...totalOperatingCost..."
                  },
                  // FOR XBRL FILING 
                  "revenueBreakup": {
                      "revenueFromOperations": "...revenueFromOperations...",
                      "revenueFromInterest": "...revenueFromInterest...",
                      "revenueFromOtherFinancialServices": "...revenueFromOtherFinancialServices...",
                      "revenueFromSaleOfProducts": "...revenueFromSaleOfProducts...",
                      "revenueFromSaleOfServices": "...revenueFromSaleOfServices...",
                      "otherOperatingRevenues": "...otherOperatingRevenues...",
                      "exciseDuty": "...exciseDuty...",
                      "serviceTaxCollected": "...serviceTaxCollected...",
                      "otherDutiesTaxesCollected": "...otherDutiesTaxesCollected..."
                  }

                  // FOR E-FILING 
                  "revenueBreakup": {
                      "saleOfGoodsManufacturedDomestic": "...saleOfGoodsManufacturedDomestic...",
                      "saleOfGoodsTradedDomestic": "...saleOfGoodsTradedDomestic...",
                      "saleOrSupplyOfServicesDomestic": "...saleOrSupplyOfServicesDomestic...",
                      "saleOfGoodsManufacturedExport": "...saleOfGoodsManufacturedExport...",
                      "saleOfGoodsTradedExport": "...saleOfGoodsTradedExport...",
                      "saleOrSupplyOfServicesExport": "...saleOrSupplyOfServicesExport..."
                  }
                  
                  // FOR XBRL FILING
                  "depreciationBreakup": {
                      "depreciation": "...depreciation...",
                      "amortisation": "...amortisation...",
                      "depletion": "...depletion..."
                  }

                  // FOR E-FILING 
                  "depreciationBreakup": {
                      "depreciationAndamortisation": "...depreciationAndamortisation..."
                  },
                  "metadata": {
                    "fileName": "...fileName...",
                    "fileURL": "...fileURL..."
                }
              },
              "auditorComments": {
                  "reportHasAdverseRemarks": "...reportHasAdverseRemarks...",
                  "disclosuresAuditorReport": "...list of disclosuresAuditorReport...",
                  "disclosuresDirectorReport": "...list of disclosuresDirectorReport..."
              }
          }],
          "financialParameters": [{
              "year": "...year...",
              "nature": "...nature...",
              "earningFc": "...earningFc...",
              "expenditureFc": "...expenditureFc...",
              "employeeBenefitExpense": "...employeeBenefitExpense...",
              "transactionRelatedPartiesAs18": "...transactionRelatedPartiesAs18...",
              "grossFixedAssets": "...grossFixedAssets...",
              "tradeReceivableExceedingSixMonths": "...tradeReceivableExceedingSixMonths...",
              "proposedDividend": "...proposedDividend..."
          }],
          "industrySegments": [{
              "industry": "...industry...",
              "segments": "...list of segments..."
          }],
          "principalBusinessActivities": [{
              "year": "...year...",
              "mainActivityGroupCode": "...mainActivityGroupCode...",
              "mainActivityGroupDescription": "...mainActivityGroupDescription...",
              "businessActivityCode": "...businessActivityCode...",
              "businessActivityDescription": "...businessActivityDescription...",
              "percentageOfTurnover": "...percentageOfTurnover..."
          }],
          "shareholdings": [{
              "shareholders": "...shareholders...",
              "year": "...year...",
              "category": "...category...",
              "indianHeldNoOfShares": "...indianHeldNoOfShares...",
              "indianHeldPercentageOfShares": "...indianHeldPercentageOfShares...",
              "nriHeldNoOfShares": "...nriHeldNoOfShares...",
              "nriHeldPercentageOfShares": "...nriHeldPercentageOfShares...",
              "foreignHeldOtherThanNriNoOfShares": "...foreignHeldOtherThanNriNoOfShares...",
              "foreignHeldOtherThanNriPercentageOfShares": "...foreignHeldOtherThanNriPercentageOfShares...",
              "centralGovernmentHeldNoOfShares": "...centralGovernmentHeldNoOfShares...",
              "centralGovernmentHeldPercentageOfShares": "...centralGovernmentHeldPercentageOfShares...",
              "stateGovernmentHeldNoOfShares": "...stateGovernmentHeldNoOfShares...",
              "stateGovernmentHeldPercentageOfShares": "...stateGovernmentHeldPercentageOfShares...",
              "governmentCompanyHeldNoShares": "...governmentCompanyHeldNoShares...",
              "governmentCompanyHeldPercentageOfShares": "...governmentCompanyHeldPercentageOfShares...",
              "insuranceCompanyHeldNoOfShares": "...insuranceCompanyHeldNoOfShares...",
              "insuranceCompanyHeldPercentageOfShares": "...insuranceCompanyHeldPercentageOfShares...",
              "bankHeldNoOfShares": "...bankHeldNoOfShares...",
              "bankHeldPercentageOfShares": "...bankHeldPercentageOfShares...",
              "financialInstitutionsHeldNoOfShares": "...financialInstitutionsHeldNoOfShares...",
              "financialInstitutionsHeldPercentageOfShares": "...financialInstitutionsHeldPercentageOfShares...",
              "financialInstitutionsInvestorsHeldNoOfShares": "...financialInstitutionsInvestorsHeldNoOfShares...",
              "financialInstitutionsInvestorsHeldPercentageOfShares": "...financialInstitutionsInvestorsHeldPercentageOfShares...",
              "mutualFundsHeldNoOfShares": "...mutualFundsHeldNoOfShares...",
              "mutualFundsHeldPercentageOfShares": "...mutualFundsHeldPercentageOfShares...",
              "ventureCapitalHeldNoOfShares": "...ventureCapitalHeldNoOfShares...",
              "ventureCapitalHeldPercentageOfShares": "...ventureCapitalHeldPercentageOfShares...",
              "bodyCorporateHeldNoOfShares": "...bodyCorporateHeldNoOfShares...",
              "bodyCorporateHeldPercentageOfShares": "...bodyCorporateHeldPercentageOfShares...",
              "othersHeldNoOfShares": "...othersHeldNoOfShares...",
              "othersHeldPercentageOfShares": "...othersHeldPercentageOfShares...",
              "totalNoOfShares": "...totalNoOfShares...",
              "totalPercentageOfShares": "...totalPercentageOfShares..."
          }],
          "shareholdingsSummary": [{
              "year": "...year...",
              "totalEquityShares": "...totalEquityShares...",
              "totalPreferenceShares": "...totalPreferenceShares...",
              "promoter": "...promoter...",
              "public": "...public...",
              "total": "...total..."
          }],
          "directorShareholdings": [{
              "year": "...year...",
              "dinPan": "...dinPan...",
              "fullName": "...fullName...",
              "designation": "...designation...",
              "dateOfCessation": "...dateOfCessation...",
              "noOfShares": "...noOfShares...",
              "percentageHolding": "...percentageHolding..."
          }],
          "bifrHistory": "...list of bifrHistory...",
          "cdrHistory": "...list of cdrHistory...",
          "defaulterList": "...list of defaulterList...",
          "legalHistory": "...list of legalHistory...",
          "creditRatings": "...list of creditRatings...",
          "holdingCompanies": "...list of holdingCompanies...",
          "subsidiaryCompanies": "...list of subsidiaryCompanies..."
      }
    }
}

Input Parameter	Data Type	Description
year	string	Year for which the financial data is reported
auditorName	string	Name of the auditor who audited the company's financial statements
auditorFirmName	string	Name of the auditor's firm
pan	string	Permanent Account Number of the auditor
membershipNumber	string	Membership number of the auditor
firmRegistrationNumber	string	Registration number of the auditor's firm
address	string	Address of the auditor's firm
nature	string	Nature of the financial statement (e.g. consolidated, standalone)
statedOn	string	Date on which the financial statement was stated
filingStandard	string	Filing standard used for the financial statement
tangibleAssets	string	Value of the company's tangible assets
producingProperties	string	Value of the company's producing properties
intangibleAssets	string	Value of the company's intangible assets
preproducingProperties	string	Value of the company's pre-producing properties
tangibleAssetsCapitalWorkInProgress	string	Value of the company's tangible assets under construction
intangibleAssetsUnderDevelopment	string	Value of the company's intangible assets under development
noncurrentInvestments	string	Value of the company's non-current investments
deferredTaxAssetsNet	string	Value of the company's net deferred tax assets
foreignCurrMonetaryItemTransDiffAssetAccount	string	Value of the company's foreign currency monetary item translation difference in asset account
longTermLoansAndAdvances	string	Value of the company's long-term loans and advances
otherNoncurrentAssets	string	Value of the company's other non-current assets
currentInvestments	string	Value of the company's current investments
inventories	string	Value of the company's inventories
tradeReceivables	string	Value of the company's trade receivables
cashAndBankBalances	string	Value of the company's cash and bank balances
shortTermLoansAndAdvances	string	Value of the company's short-term loans and advances
otherCurrentAssets	string	Value of the company's other current assets
givenAssetsTotal	string	Total value of the company's assets