# FileSure API

> REST access to the Ministry of Corporate Affairs register: every company, LLP and director in India, the documents they have filed, and structured data extracted from those documents. Prepaid wallet in rupees, per-endpoint pricing, one-time company unlocks for documents and financials.

Base URL `https://api.filesure.in`. Every request carries the key in the `x-api-key` header. Test keys (`fsk_test_`) work on the sandbox companies with nothing charged.

OpenAPI document: https://api.filesure.in/portal/openapi-public.yaml (also https://api.filesure.in/portal/openapi-public.json). Everything in one file: https://api.filesure.in/llms-full.txt. Rendered reference: https://api.filesure.in/portal/docs. Rate card: https://api.filesure.in/pricing.html. Changelog: https://api.filesure.in/changelog.html.

## Start here

- [Use with your AI tool](https://api.filesure.in/reference/start-here/use-with-your-ai-tool.md)
- [Connect your AI tool](https://api.filesure.in/reference/start-here/connect-your-ai-tool.md)
- [Tools of the connector](https://api.filesure.in/reference/start-here/tools-of-the-connector.md)
- [Tool reference](https://api.filesure.in/reference/start-here/tool-reference.md)
- [How FileSure data works](https://api.filesure.in/reference/start-here/how-filesure-data-works.md)
- [Quickstart](https://api.filesure.in/reference/start-here/quickstart.md)
- [Which call do I need?](https://api.filesure.in/reference/start-here/which-call-do-i-need.md)
- [Keys and the sandbox](https://api.filesure.in/reference/start-here/keys-and-the-sandbox.md)
- [Testing with a test key](https://api.filesure.in/reference/start-here/testing-with-a-test-key.md)
- [Billing and the wallet](https://api.filesure.in/reference/start-here/billing-and-the-wallet.md)
- [Responses and errors](https://api.filesure.in/reference/start-here/responses-and-errors.md)
- [Support](https://api.filesure.in/reference/start-here/support.md)
- [Sandbox identifiers](https://api.filesure.in/reference/start-here/sandbox-identifiers.md)

## Sandbox identifiers

Test API keys (`fsk_test_*`) work only on the companies, LLPs and directors

- [List the sandbox companies and directors](https://api.filesure.in/reference/list-sandbox-entities.md): `GET /v1/sandbox`

## Look up the register

The record MCA holds on a company or director, as plain JSON. Resolve a name to an identifier, read master data, directors and charges, or list what a company has filed. ₹5 a call, no unlock needed.

- [Resolve company name to CIN](https://api.filesure.in/reference/resolve-company.md): `GET /v1/companies/resolve`
- [Get company master data](https://api.filesure.in/reference/get-company-master.md): `GET /v1/companies/{cin}`
- [List company filings](https://api.filesure.in/reference/list-company-filings.md): `GET /v1/companies/{cin}/filings`
- [Resolve director name to DIN](https://api.filesure.in/reference/resolve-director.md): `GET /v1/directors/resolve`
- [Get director profile](https://api.filesure.in/reference/get-director-master.md): `GET /v1/directors/{din}`

## Documents and financials

The filing PDFs and the data extracted from them. Unlock a company once (₹330 for every document it has filed, in any year; access lasts one year) and the first download runs; then download any filing and read any extraction for 5 paisa a call. Filings made after the unlock are picked up under Keep a company current.

- [Unlock a company](https://api.filesure.in/reference/unlock-company.md): `POST /v1/companies/{cin}/unlock`
- [Get unlock status](https://api.filesure.in/reference/get-company-unlock.md): `GET /v1/companies/{cin}/unlock`
- [Download filing PDF](https://api.filesure.in/reference/download-filing.md): `GET /v1/companies/{cin}/filings/{filingId}/download`
- [List extracted form types](https://api.filesure.in/reference/list-extractions.md): `GET /v1/companies/{cin}/extractions`
- [List extracted years](https://api.filesure.in/reference/list-extraction-years.md): `GET /v1/companies/{cin}/extractions/{formType}`
- [Get extracted data](https://api.filesure.in/reference/get-extraction-data.md): `GET /v1/companies/{cin}/extractions/{formType}/{year}`

## Keep a company current

How current is our copy of a company, and what to do about it. The freshness check is free; a refresh (₹1) re-reads the record and the filing list from MCA; a document fetch (₹150) downloads the listed filings still missing a PDF.

- [How current is our copy of this company?](https://api.filesure.in/reference/get-company-freshness.md): `GET /v1/companies/{cin}/freshness`
- [Refresh a company from MCA](https://api.filesure.in/reference/update-company.md): `POST /v1/companies/{cin}/update`
- [Progress of a company refresh](https://api.filesure.in/reference/get-company-update-status.md): `GET /v1/companies/{cin}/update/status`
- [Fetch new documents for an unlocked company](https://api.filesure.in/reference/fetch-company-documents.md): `POST /v1/companies/{cin}/documents/fetch`

## Director contact

A director's phone and email, behind a separate per-director unlock (₹299 by default for new accounts; access lasts one year), then read for 5 paisa a call.

- [Unlock a director's contact](https://api.filesure.in/reference/unlock-director-contact.md): `POST /v1/directors/{din}/unlock`
- [Get director contact unlock status](https://api.filesure.in/reference/get-director-contact-unlock.md): `GET /v1/directors/{din}/unlock`
- [Get director contact](https://api.filesure.in/reference/get-director-contact.md): `GET /v1/directors/{din}/contact`

## Your account

Wallet balance and usage, the wallet ledger, top-ups, your billing profile and GST invoices. All free, on live and test keys alike.

- [Get wallet + usage](https://api.filesure.in/reference/get-account-usage.md): `GET /v1/account/usage`
- [Your rate card](https://api.filesure.in/reference/get-account-pricing.md): `GET /v1/account/pricing`
- [Wallet ledger](https://api.filesure.in/reference/get-wallet-transactions.md): `GET /v1/account/wallet/transactions`
- [Top up the wallet](https://api.filesure.in/reference/create-wallet-recharge.md): `POST /v1/account/wallet/recharge`
- [Recharge status](https://api.filesure.in/reference/get-wallet-recharge-status.md): `GET /v1/account/wallet/recharge/{orderId}/status`
- [Billing profile](https://api.filesure.in/reference/get-billing-profile.md): `GET /v1/account/billing`
- [Set the billing profile](https://api.filesure.in/reference/put-billing-profile.md): `PUT /v1/account/billing`
- [Top-up history](https://api.filesure.in/reference/get-recharges.md): `GET /v1/account/recharges`
- [Download a GST invoice](https://api.filesure.in/reference/get-invoice-pdf.md): `GET /v1/account/invoices/{rechargeId}/pdf`