Roadmap
What is planned and not served yet, why not, and what to use until then.
The API reference lists only what is served: every operation in it
answers today. The operations below are designed and not served yet. A call to any of them
answers 404, and none of them is charged.
Contact details
| Planned | What it returns |
|---|---|
GET /companies/{company_id}/contact | A company's website, e-mail addresses, phone numbers and social profiles |
GET /persons/{person_id}/contact | The same for one person |
A third read will return the contact details of everyone who holds a current role at a company, in one call.
Contact details are not register data: they are gathered from public web sources and go out of date on their own schedule. They will be an add-on beside the register data, priced apart, and every answer will say when it was gathered.
Not built yet. Until then, the register gives you the registered office on the company
record (GET /companies/{company_id}).
Jobs: fetching data again
| Planned | What it does |
|---|---|
POST /jobs | Ask for a company's documents, financial statements or ownership history to be fetched from the register again |
GET /jobs/{job_id} | Poll that work until it has succeeded or failed |
Some work cannot happen inside a request, so it will be a job you start and then poll.
Not served, for two reasons. No worker consumes the queue yet, so a job would be accepted and never run. And a stored job records neither its company nor its type, so it could not describe itself back to you. Offering the endpoint before both are fixed would sell a request that does nothing.
What to do instead:
- Shareholders fetch themselves. When we hold no shareholder list for a company,
GET /companies/{company_id}/shareholdersstarts reading one. The page then saysextract.status: "processing", and the same request a little later returns the holders. One call starts at most one extraction, for the company you asked about. - Documents are listed as they are on file.
GET /companies/{company_id}/documentslists what we hold. If the document you need is not there, a job would not conjure it: for many entries nothing was ever filed, or the entry has been deleted. See Data coverage.
Documents and financial statements by id
| Planned | What it returns |
|---|---|
GET /documents/{document_id}/content | The document file, through a short-lived download link |
GET /financial-statements/{financial_statement_id} | One financial statement with its figures |
GET /financial-statements/{financial_statement_id}/content | The statement's file, through a short-lived download link |
Not served, because our data store cannot yet look a document or a statement up by its id. Each is reachable through its company instead:
GET /companies/{company_id}/documentslists a company's documents.GET /companies/{company_id}/financial-statementslists its statements, each one with its figures — the same object the by-id read will return.
Until the by-id reads are served, links.download on a document or statement is null.