Intelligence

Company health score

A rules-based health score (0 to 100) with a grade, the dimensions and signals behind it, red flags and positive signals, built from public records and the company's filed accounts. It is an indicator, not a credit rating.

On the Free plan: 100 calls a UTC day to this endpoint and GET /accounts/{number} together, inside the daily request limit. Each such call carries X-Preview-Daily-Limit, X-Preview-Daily-Remaining and X-Preview-Daily-Reset (Unix time of the next midnight UTC); when the day's calls are used the answer is 429 with code: preview_limit_reached, not counted against the request limit. Starter and above have no separate limit.

get/intelligence/health/{number}

Request

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

Path parameters

numberstring required

Response

Health score with grade and factors

company_numberstring
company_namestring
company_statusstring
score_versionstring
overall_scoreinteger required
grade'A+' | 'A' | 'B+' | 'B' | 'C+' | 'C' | 'D' | 'F' required

A+ ≥90, A ≥80, B+ ≥70, B ≥60, C+ ≥50, C ≥40, D ≥30, F <30

risk_level'very_low' | 'low' | 'medium' | 'high' | 'critical' required

very_low ≥75, low ≥60, medium ≥45, high ≥30, critical <30

red_flagsstring[]
positive_signalsstring[]
positive_signals_notestring nullable

Why positive_signals is empty: set for a company in insolvency proceedings or dissolved (v3.2)

uncapped_scoreinteger

The score before score_caps were applied (v3.2)

enrichmentobject
methodologystring
disclaimerstring
noticestring

Who the data is prepared for and that CompanyStack accepts no responsibility to anyone else who relies on it (Terms 15B). Keep it with the data if you show it to others (Terms 17.5).

data_as_ofstring nullable

Changes

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