Companies
List the company report's optional sections
The sections the company report (företagsupplysning) can contain besides its main part, in the report's order: key (the value for sections in GET /companies/{id}/company-report/pdf), available (whether the caller's plan includes it) and selected (whether it is in the report when sections is left out).
Max+ tier
GEThttps://lens-api.tic.io/companies/company-report/sections
The optional sections of the company report, in the report’s order, with what your plan includes. It is the same for every company, so it takes no company ID.
| Field | Description |
|---|---|
key |
The value for sections in Company report |
available |
Whether your plan includes the section. Asking for one that is not available returns 403 |
selected |
Whether the section is in the report when sections is left out (only when it is also available) |
Example
curl "https://lens-api.tic.io/companies/company-report/sections" \
-H "x-api-key: YOUR_API_KEY"[
{ "key": "timeline", "available": true, "selected": true },
{ "key": "signals", "available": true, "selected": true },
{ "key": "financials", "available": true, "selected": true },
{ "key": "debts", "available": true, "selected": false },
{ "key": "status", "available": true, "selected": false },
{ "key": "registrations", "available": true, "selected": false },
{ "key": "businessMortgages", "available": true, "selected": false },
{ "key": "group", "available": false, "selected": false },
{ "key": "properties", "available": true, "selected": false },
{ "key": "vehicles", "available": true, "selected": false },
{ "key": "servingPermits", "available": true, "selected": false },
{ "key": "workplaces", "available": true, "selected": false }
]What each section holds is described under Optional sections.
Authorization
x-api-keystringheaderrequiredYour API key, sent in the x-api-key header.
Responses
The optional sections · application/json
keystring | nullavailablebooleanselectedboolean