api_docs

Authorization and Endpoint

1. Authorization and other request headers are shared post onboarding.
2. Endpoint details will be shared with the client post onboarding.

GST Compliances API: Overview

The searchGSTCompliance query is designed to retrieve detailed Goods and Services Tax (GST) compliance data for a specific company based on its Corporate Identification Number (CIN). This query provides valuable insights into a company's GST return filings, their status, and various details such as filing frequency, due dates, and tax periods. It enables businesses, tax auditors, and compliance officers to track a company's adherence to GST regulations and helps them ensure timely filing and payment.

Input Parameters

• Cin (string): The Corporate Identification Number (CIN) of the company whose GST compliance details are required. This serves as the unique identifier to retrieve the correct data.

Output Overview

The output contains a comprehensive set of parameters for tracking and analyzing GST compliance details.

Output Parameters

1. compliances (string): A comprehensive list of all GST compliance records associated with the provided CIN. This includes all filing records, status updates, and related documentation.
2. rowKey (string): A unique alphanumeric identifier assigned to each GST compliance entry, used for efficient database retrieval and indexing.
3. meta (string): Contains metadata with supplementary information about the compliance record, including the CIN and GSTIN of the company.
4. cin (string): The 21-digit Corporate Identification Number of the company, ensuring the correct linkage to the compliance data.
5. gstin (string): The 15-character Goods and Services Tax Identification Number uniquely identifying the business for GST purposes.
6. annualFilings (object): Detailed information about the annual GST returns, including:
   • dateOfFiling (string): Date when the annual GST return was filed.
   • dueDate (string): The official deadline by which the return should have been filed to avoid penalties.
   • filingFrequency (string): The frequency at which the GST return is filed (Annual, Monthly, etc.).
   • filingStatus (string): Status of the return (e.g., Filed, Delayed).
   • filingType (string): The type of GST return filed (e.g., GSTR-9C for annual return).
   • financialYear (string): The fiscal year for which the return is being filed.
   • status (string): The overall filing status (e.g., Filed, Pending).
   • taxPeriod (string): The period covered by the return (e.g., Annual, Quarterly).
   • taxPeriodEndDate (string): The end date of the tax period.
   • taxPeriodStartDate (string): The start date of the tax period.
7. monthlyFilings (object): Detailed breakdown of monthly GST returns, including:
   • dateOfFiling (string): Date when the monthly GST return was filed.
   • dueDate (string): Due date for the return filing.
   • filingFrequency (string): Frequency of filing (Monthly, Quarterly).
   • filingStatus (string): Filing status for the month (e.g., On Time, Delayed).
   • filingType (string): Type of GST return filed for that period (e.g., GSTR-1).
   • financialYear (string): The financial year for the filed return.
   • status (string): Overall status of the monthly return (e.g., Filed, Pending).
   • taxPeriod (string): The tax period covered (e.g., April, Q1).
   • taxPeriodEndDate (string): The last date of the tax period.
   • taxPeriodStartDate (string): The first date of the tax period.
8. totalCount (number): The total number of compliance entries retrieved for the query. This can be useful for pagination and reporting.

EPF Compliances API: Overview

The searchEPFCompliances query is designed to retrieve comprehensive EPF (Employees' Provident Fund) compliance information for a specific company based on its Corporate Identification Number (CIN). This query is primarily used to track the organization's adherence to EPF regulations, including monthly contributions, filing statuses, and payment records. It helps employers, auditors, and EPF compliance officers to efficiently monitor and validate the EPF compliance status of the company.

Input Parameters

• Cin (string): The Corporate Identification Number (CIN) of the company. This unique identifier helps fetch the relevant EPF compliance data for that specific organization.

Output Overview

The query provides the following output parameters to give detailed EPF compliance information:

Output Parameters

1. compliances (string): A comprehensive list of EPF compliance records associated with the given CIN, including details such as payment amounts, filing statuses, and contributions.
2. rowKey (string): A unique alphanumeric identifier assigned to each EPF compliance record for efficient retrieval and indexing in the database.
3. meta (string): Contains supplementary metadata about the EPF compliance record such as CIN, establishment ID (estid), and additional tracking information.
4. cin (string): The 21-digit Corporate Identification Number associated with the company, ensuring that the compliance data is correctly linked to the company.
5. estid (string): A unique establishment ID assigned by EPFO to track compliance for the specific employer.
6. paymentDetails (object): Contains detailed information about EPF payments including:
   • amount (number): Total EPF contributions made for the given period (both employer and employee portions).
   • dateOfCredit (string): Date when the payment was credited to the EPFO account.
   • defaultDate (string): Date when the payment was marked as defaulted, if applicable.
   • ecr (string): Electronic Challan cum Return reference number.
   • filingDate (string): Date of EPF return submission.
   • filingStatus (string): Current status of the return (Filed, Pending, etc.).
   • noOfEmployees (number): The total number of employees covered under EPF.
   • trrn (string): Temporary Return Reference Number for tracking the return process.
   • wageDate (string): Date associated with the wage period for EPF contributions.
   • wageMonth (string): The month for which the wages are being reported.
7. totalCount (number): The total number of EPF compliance entries retrieved in the query, useful for pagination and analysis.

\

Aggregate Turnover API: Overview

The aggregateTurnover query is used to retrieve the annual turnover data for a company based on its Corporate Identification Number (CIN). This query provides a breakdown of the company's turnover for each financial year, helping businesses, tax auditors, and compliance officers to assess financial performance, track revenue trends, and ensure compliance with tax regulations.

Input Parameters

• Cin (string): The Corporate Identification Number (CIN) of the company for which the turnover data is being requested. This ensures that the correct company's turnover records are fetched.

Output Overview

The query provides the following output parameters to give detailed insights into a company's turnover over multiple financial years.

Output Parameters

1. cin (string): The 21-digit Corporate Identification Number (CIN) of the company. This serves as a unique identifier to link the turnover data to the specific company.
2. yearWiseTurnover (object): A collection of annual turnover records, each representing the turnover for a specific financial year.
   • year (string): The financial year period (April 1 to March 31) for which the turnover is reported. The format is YYYY-YY.
   • turnover (number): The total aggregate turnover for the specified year, representing the gross revenue from all business activities for that year. The value is in INR.
3. totalCount (number): The total number of records in the response, useful for pagination or reporting.

MCA Index of Charges API: Overview

Use Case Overview

The searchCharges query is used to retrieve charge records associated with a company based on its Corporate Identification Number (CIN). This data helps track all charge details, modifications, and the current status of charges related to the company. It is essential for understanding the company’s secured financial obligations, such as loans and borrowings against its assets, as well as monitoring the lifecycle of each charge.

Input Parameters

• Cin (string): The Corporate Identification Number (CIN) of the company for which charge details are being retrieved. This ensures accurate retrieval of the charge records associated with the correct company.

Output Overview

The query provides detailed charge records, including their status, amounts, and associated financial institutions. It offers a comprehensive view of all charges, whether active, satisfied, or modified, and helps in assessing the company’s secured financial transactions.

Output Parameters

1. totalCount (number): The total number of charge records retrieved by the query. This value is used for pagination or reporting and helps in understanding the volume of charges related to the company.
2. charges (array): A list of charge records with detailed information, including:
   • rowKey (string): Unique alphanumeric identifier assigned to each charge entry. Used for database indexing and efficient retrieval of specific records.
   • meta (object): Metadata containing supplementary information, such as the charge ID, CIN, and DIN.
   • chargeId (string): Unique identifier for the charge assigned by MCA.
   • cin (string): The 21-digit Corporate Identification Number (CIN) of the company.
   • din (string): The 8-digit Director Identification Number associated with the charge.
   • indexOfCharges (object): Detailed information about the charge:
     • address (string): The postal address of the charge holder or lending institution.
     • amount (number): The value of the charge in INR.
     • chargeCreationDate (string): The date the charge was created.
     • chargeHolderName (string): The name of the institution holding the charge.
     • chargeModificationDate (string): The date the charge was modified.
     • chargeSatisfactionDate (string): The date the charge was satisfied (if applicable).
     • srn (string): Service Request Number generated by MCA for charge filings.
     • status (string): The current status of the charge (e.g., 'Active', 'Satisfied', 'Modified').

MCA Directors API: Overview

The searchDirectors query retrieves information about the directors of a company based on its Corporate Identification Number (CIN). It provides detailed director profiles, including appointment dates, current designations, and PAN details. This query is useful for businesses and regulatory authorities to track director appointments, roles, and compliance with governance regulations.

Input Parameters

• Cin (string): The Corporate Identification Number (CIN) of the company whose director details are being retrieved. This ensures accurate retrieval of director data associated with the correct company.

Output Overview

The output provides a comprehensive list of directors, including their appointment details, current roles, and associated identification information. It helps to understand the governance structure of a company by providing director profiles.

Output Parameters

1. totalCount (number): The total number of director records retrieved. This helps with pagination and understanding the scale of director information available.
2. directors (array): A list of director records, each containing the following information:
   • rowKey (string): Unique alphanumeric identifier for each director entry. Used for database indexing and efficient retrieval.
   • meta (object): Metadata containing the CIN and Director Identification Number (DIN) for the director.
   • cin (string): The 21-digit Corporate Identification Number (CIN) that links the director to the company.
   • din (string): The 8-digit Director Identification Number (DIN) uniquely identifying the director.
   • directors (object): Detailed director profile information:
     • appointmentDate (string): The date the director was first appointed to the board.
     • appointmentDateCurrentDesignation (string): The date the director was appointed to their current role.
     • currentDesignation (string): The director's current role in the company (e.g., Director, Managing Director).
     • name (string): Full legal name of the director.
     • pan (string): The 10-character Permanent Account Number (PAN) of the director, with part of it masked for privacy.

CIBIL Defaulters API: Overview

The searchDefaulters query retrieves records of default cases associated with a company based on its Corporate Identification Number (CIN). It provides detailed information about Non-Performing Asset (NPA) and willful default cases, helping businesses and financial institutions monitor credit risks, assess defaults, and manage recovery strategies.

Input Parameters

• Cin (string): The Corporate Identification Number (CIN) of the company whose defaulter data is being retrieved. This ensures accurate retrieval of default records for the specific company.

Output Overview

The output provides a comprehensive list of defaulters, categorized into NPA and willful default cases. It includes essential details like the default amount, associated entity names, and the record dates for both types of defaults.

Output Parameters

1. totalCount (number): The total number of defaulter records retrieved. This helps with pagination and understanding the scale of default cases.
2. defaulters (array): A list of defaulter records, each containing information about NPA and willful defaults:
   • rowKey (string): Unique identifier for each defaulter entry. Helps with indexing and retrieval.
   • npa (object): Details about the Non-Performing Asset (NPA) case, including:
     • amount (number): The total monetary value classified as NPA.
     • name (string): The name of the entity associated with the NPA.
     • recordDate (string): The date when the account was classified as an NPA.
   • willful (object): Details about the willful default case, including:
     • amount (number): The total amount involved in the willful default.
     • name (string): The name of the entity associated with the willful default.
     • recordDate (string): The date when the default was classified as willful.

Litigation Cases API: Overview

The searchLitigationCases query allows retrieval of litigation case records associated with a company based on its Corporate Identification Number (CIN). This query provides detailed information about ongoing and past legal proceedings involving the company, including case details, involved parties, court orders, and the current status of each case.

Input Parameters

• Cin (string): The Corporate Identification Number (CIN) of the company whose litigation case data is being retrieved.

Output Overview

The output provides a comprehensive list of litigation cases associated with the given CIN, detailing each case's status, involved parties, and related judicial orders.

Output Parameters

1. totalCount (number): The total number of litigation cases retrieved. This is useful for pagination and monitoring the number of cases associated with the company.
2. cases (array): A list of litigation case entries, each containing detailed information about the case and its associated orders:
   • rowKey (string): Unique identifier for each litigation case, useful for indexing.
   • caseDetails (object): Information about the litigation, including:
     • appealNumber (string): The unique number assigned to any appeals filed in the court.
     • appellants (array): A list of parties who have filed the appeal or case.
     • assessmentYear (string): The fiscal year relevant to the case, particularly in tax-related cases.
     • caseStatus (string): Current status of the case (e.g., 'Pending', 'Disposed').
     • caseType (string): Type of case (e.g., Civil, Tax, Corporate).
     • cnrNumber (string): A unique identifier assigned to the case by the court.
     • filingDate (string): The date when the case was filed.
     • forum (string): The specific court or tribunal where the case is being heard.
     • forumType (string): The category of the judicial forum (e.g., High Court, Supreme Court).
     • respondants (array): A list of parties against whom the case is filed.
     • source (string): The origin of the case data (e.g., NCLT, Court).
     • targetRole (string): The company's role in the litigation (e.g., Petitioner, Respondent).
3. orders (array): Judicial orders related to the case, providing details such as:
   • rowKey (string): Unique identifier for each order.
   • orderDate (string): The date when the order was issued.
   • orderLink (string): A link to access the full text or document of the order.
   • orderName (string): Descriptive title of the order.
   • orderNo (string): Official reference number assigned to the order.
   • meta (object): Metadata about the order, including tracking and system information.

Adverse Media API: Overview

The searchAdverseMedia query helps to retrieve adverse media records associated with a company using its Corporate Identification Number (CIN). This query enables businesses, legal professionals, and reputation management teams to track any negative press coverage or potentially harmful news reports that may affect the company's image and operations.

Input Parameters

• Cin (string): The Corporate Identification Number (CIN) of the company whose adverse media data is to be retrieved.

Output Overview

The output provides detailed information about any adverse media mentions, such as articles, news reports, and related documentation, with an emphasis on negative coverage of the company.

Output Parameters

1. totalCount (number): The total number of adverse media records found. It helps in tracking the volume of negative press and for pagination purposes.
2. adverseMedia (array): A collection of adverse media records, each entry containing detailed information about the media, including:
   • rowKey (string): Unique identifier for each adverse media record.
   • meta (object): Additional metadata associated with the record, including an internal ID and CIN.
   • records (array): A list of individual adverse media records with full details:
     • id (string): Unique identifier for the media record.
     • text (string): Excerpt or full content from the article, highlighting the negative coverage.
     • title (string): The headline or title of the media article.
     • sourceName (string): The name of the publication or media outlet that published the article.
     • source_url (string): URL of the source.
     • publishedDate (string): Date when the article was published (in format YYYY-MM-DD).
     • summary (string): A short overview of the article.
     • description (string): Detailed description of the article's content, including the context and potential impact on the business.
     • url (string): Direct link to the full article for further details.
     • imageUrl (string): URL to any images associated with the article.
     • language (string): The language in which the article was written.
     • authors (array): A list of the authors or journalists who contributed to the article.
     • keywords (array): Key terms and phrases related to the article for easier categorization.
     • internal_data_source (string): Internal classification related to the collection of the media data.
     • signalCategories (array): Categories for classifying the type of adverse media (e.g., financial misconduct, regulatory violations).

PEP API: Overview

The searchPEP query retrieves information about Politically Exposed Persons (PEPs) associated with a company using its Corporate Identification Number (CIN). This query supports compliance checks, risk assessments, and anti-corruption measures by identifying individuals or entities connected to political exposure.

Input Parameters

• Cin (string): The Corporate Identification Number (CIN) of the company whose PEP-related data is to be retrieved.

Output Overview

The output provides details about PEP matches, directors associated with PEPs, and evidence supporting the PEP status.

Output Parameters

1. totalCount (number): The total number of PEP-related records found. Useful for assessing the volume of politically exposed entries.
2. pep (array): A collection of PEP entries with detailed information, including:
   • rowKey (string): Unique identifier for each PEP entry.
   • meta (object): Metadata associated with the PEP record, including:
     • _id (string): Internal system ID for uniquely tracking the PEP entry.
     • cin (string): Corporate Identification Number linking the PEP entry to a company.
   • directors (array): A list of company directors with PEP-related information:
     • din (string): 8-digit Director Identification Number (DIN).
     • director_matches (array): Matches found in PEP datasets, including:
       • name (string): Name of the director as per PEP records.
       • mca_dob (string): Date of birth (format: YYYY-MM-DD).
       • matches (array): Information about the matched PEP data:
         • resourceId (string): Unique ID for the PEP resource.
         • score (number): Confidence score (0-100) for the match.
         • countries (array): List of countries associated with the PEP.
         • datasets (array): Sources where the PEP information was found.
         • gender (string): Gender of the matched individual.
         • addresses (array): Address details, including country and city.
   • resource_wise_results (object): Additional details for each PEP entry:
     • pepEntries: Records of current and former PEP positions.
     • contactEntries: Contact details like phone numbers and emails.
     • identifiers: Identification documents associated with the PEP.
     • businessLinks: Business connections of the PEP.
     • evidences: Supporting documentation for PEP classification.
     • nationalitiesIsoCodes: ISO codes for the nationalities associated with the PEP.