Automated analyst view

Get the Automated analyst view of a company

A language model reviews the company, with the chosen focus (finance, credit, acquisition or compliance), from CompanyStack's own data only: the profile, parsed accounts, Health Score, officers, PSCs, charges, filings, Gazette notices and sanctions screening. Every figure in the answer cites a fact (returned in facts); answers quoting figures that are not in our data are repaired or rejected before they are returned. Leave out question for the standard review for that focus. The same question on the same data is served from a cache and does not use your allowance again. API Starter includes 100 answers a month, Business 400, Enterprise 2,000; each call also counts as one request. Generated automatically by a language model from our data. No person reviews it. It can be wrong and is not advice. Not a credit rating and not a credit limit.

post/intelligence/analyst/{number}

Request

  • Base URL: https://api.companystack.co.uk
  • URL: https://api.companystack.co.uk/intelligence/analyst/{number}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Api-Key

Path parameters

numberstring required

Request body

persona'cfo' | 'credit' | 'mna' | 'compliance' required
questionstring

Optional; answered within the chosen focus from our data only

Response

The checked answer

company_numberstring required
company_namestring required
questionstring nullable
cachedboolean required

Served from the cache: the same question on the same data was answered before

generated_atstring date-time required
data_as_ofobject

The as-of date of each part of the data the answer was written from

questionsstring[] required

Questions to ask the company

factsobject required

The cited facts by key: label, value, unit, source and as-of date. Every figure in the answer is one of these.

noticestring required

The fixed notice that goes with every answer: "Generated automatically by a language model from our data. No person reviews it. It can be wrong and is not advice." Show it with the answer.

notice_detailstring required

What the answer rests on and who may rely on it; show it after the notice

Example response

{
  "company_number": "00445790"
}

Changes

No recorded changes to this operation across all 1 revision of this API.