---
title: "The register badge (\"Company details checked against the Companies House register\")"
method: GET
path: "/elements/v1/badge/{number}"
tags: ["Website components"]
---

# The register badge ("Company details checked against the Companies House register")

`GET /elements/v1/badge/{number}`

## Request

- Base URL: `https://api.companystack.co.uk`
- URL: `https://api.companystack.co.uk/elements/v1/badge/{number}`
- Auth: API key in query parameter `key`

For a company the key holds a badge for (issued in the dashboard by an account holder who acts for it). `show` is false while the register does not show the company as active. Append .svg for the badge as an image (from a page on the key's websites).

## Path parameters

- `number` string, required

## Query parameters

- `key` string

## Response `200`

The badge, or show: false

- object
  - `show` boolean
  - `badge` object
    - `company_number` string
    - `company_name` string
    - `status_label` string
    - `checked_on` string
    - `issued_to` string
    - `issued_on` string
    - `details_url` string
    - `wording` object
  - `attribution` object: Show `text` with `licence` wherever the data is shown (the Open Government Licence asks for the statement).
    - `text` string
    - `licence` string
    - `licence_url` string
    - `affiliation` string
    - `url` string

## Other responses

- `400`: Missing or malformed session, or an invalid company number
- `401`: No key, or an invalid or revoked key
- `403`: A publishable key or token from a website it does not list (`origin_not_allowed`: no Access-Control-Allow-Origin, so the page cannot read the answer and nothing is counted), a secret key sent from a browser (`secret_key_in_browser`), an endpoint a publishable key cannot reach (`secret_key_required`), or a scope or company a token does not cover (`scope_not_allowed`, `company_not_allowed`)
- `404`: No badge issued to this key for this company (`badge_not_issued`), or badges not available yet
- `429`: A per-visitor or per-key limit (`rate_limited`), the end of a session (`session_exhausted`: start a new one), the key's daily cap (`key_daily_cap`) or the account's quota (`quota_exceeded`). Retry-After says when to try again.

---

[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)