Feedback

Submit a bug report or feature request

Submit a bug report, feature request, or general feedback.

Feedback is stored and reviewed by the Registrum team. Include endpoint and company_number when relevant - it helps reproduce the issue faster.

Types:

  • bug - something is broken or returning unexpected data
  • request - a new endpoint, field, or capability you'd like to see
  • other - anything else

Example:

POST /v1/feedback
{
  "type": "bug",
  "message": "The financials endpoint returns 502 for company 00445790.",
  "endpoint": "/v1/company/00445790/financials",
  "company_number": "00445790"
}
post/v1/feedback

Request

  • Base URL: https://api.registrum.co.uk
  • URL: https://api.registrum.co.uk/v1/feedback
  • Auth: API key in header X-API-Key

Request body

typestring required

Feedback type. One of: bug, request, other.

messagestring required

Human-readable description of the issue or request.

endpointstring nullable

The API endpoint where you encountered the issue, if applicable.

company_numberstring nullable

UK company number you were querying, if applicable.

request_idstring nullable

The X-Request-Id header value from the failed response. Including this lets us trace the exact request in our logs.

Example request

{
  "company_number": "00445790",
  "endpoint": "/v1/company/00445790/financials",
  "message": "The financials endpoint returns 502 for company 00445790.",
  "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "type": "bug"
}

Response

Feedback received.

statusstring

'success' or 'error'

cachedboolean

True if this response was served from cache rather than fetched live

cache_age_secondsinteger nullable

How many seconds ago this data was fetched from Companies House (null if not cached)

fetched_atstring nullable

ISO 8601 instant (UTC) when this data was actually fetched from Companies House. Use this, not cache_age_seconds, to show a user when the data was last checked: an age is measured at the moment this response was produced, so anything that caches the response downstream will overstate freshness by however long it held it. This instant does not drift. Null when unknown - render nothing rather than a guessed date.

data_sourcestring

'live' - fetched from Companies House right now; 'cached' - served from local cache (data is recent, no upstream call needed); 'cached_rate_conserved' - served from cache because the CH API budget is above 70% utilisation; data may be up to 30 days old in this state

credits_usedinteger

Number of API credits consumed by this request

credits_remaininginteger nullable

API credits remaining this month (null in dev mode)

Example response

{
  "cache_age_seconds": 3421,
  "cached": true,
  "credits_remaining": 487,
  "credits_used": 1,
  "data": {
    "company_age_years": 78,
    "company_name": "TESCO PLC",
    "company_number": "00445790",
    "company_status": "active",
    "company_type": "plc"
  },
  "data_source": "cached",
  "status": "success"
}

Changes

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