---
title: "Get the Automated analyst view of a company"
method: POST
path: "/intelligence/analyst/{number}"
tags: ["Automated analyst view"]
---

# Get the Automated analyst view of a company

`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`

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.

## Path parameters

- `number` string, required

## Request body

- object
  - `persona` 'cfo' | 'credit' | 'mna' | 'compliance', required
  - `question` string: Optional; answered within the chosen focus from our data only

## Response `200`

The checked answer

- object
  - `company_number` string, required
  - `company_name` string, required
  - `persona` object, required
    - `id` 'cfo' | 'credit' | 'mna' | 'compliance'
    - `name` string
  - `question` string, nullable
  - `cached` boolean, required: Served from the cache: the same question on the same data was answered before
  - `generated_at` string, date-time, required
  - `data_as_of` object: The as-of date of each part of the data the answer was written from
  - `summary` object, required
    - `text` string
    - `citations` string[]: Keys of the facts this item relies on (see `facts`)
  - `findings` object[], required
    - `title` string
    - `detail` string
    - `citations` string[]: Keys of the facts this item relies on (see `facts`)
  - `risks` object[], required
    - `risk` string
    - `severity` 'high' | 'medium' | 'low'
    - `citations` string[]: Keys of the facts this item relies on (see `facts`)
  - `questions` string[], required: Questions to ask the company
  - `data_gaps` object[], required: What the analysis could not use, and why
    - `gap` string
    - `reason` string
  - `facts` object, required: The cited facts by key: label, value, unit, source and as-of date. Every figure in the answer is one of these.
  - `notice` string, 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_detail` string, required: What the answer rests on and who may rely on it; show it after the notice
  - `usage` AnalystUsage
    - `limited` boolean
    - `period` 'day' | 'month' | 'null', nullable
    - `limit` integer, nullable
    - `used` integer
    - `left` integer, nullable

## Other responses

- `400`: Invalid company number, persona or question
- `401`: API key missing, malformed or revoked
- `403`: The key's plan does not include this endpoint (`code: plan_upgrade_required`, with `upgrade_url`), the key may not call it, or the key is beyond the plan's key limit after a downgrade (`code: key_limit_exceeded`: the newest keys are paused until keys are deleted or the plan upgraded)
- `404`: Company not found
- `429`: The plan's Automated analyst view allowance is used up (code analyst_allowance_used), or the request rate limit
- `502`: The answer did not pass the checks against our data (code analyst_answer_rejected), or the model service failed
- `503`: The Automated analyst view is off, unavailable, or today's spending limit is reached (code analyst_daily_cap)

---

[API](https://skmtc.dev/companystack/apis/companystack-api.md) · [All operations](https://skmtc.dev/companystack/apis/companystack-api/llms.txt) · [OpenAPI document](https://skmtc.dev/companystack/apis/companystack-api/revisions/8f3234237d2d?raw)