Docs
View as Markdown

opencorporates.company

beta Standard

One company by jurisdiction code and registry number (OpenCorporates).

GET /v1/opencorporates/company

What you get#

One Opencorporates record in Onekey's unified shape, in data. If the record does not exist you get a 404 not_found and are not charged.

What it costs#

  • Standard · 1 credit for a fresh fetch, charged only when it succeeds.
  • Free when served from cache (0.2 credit for a cached response over 100 KB).
  • Free if the request is invalid (never charged) or the source fails or reports not found (refunded).

Parameters#

NameTypeRequiredDefaultWhat it isConstraints
jurisdictionstringyes(required)Jurisdiction code, e.g. gb, us_camax 6 chars; must match [a-z]{2}(?:_[a-z0-9]{2,3})?; trimmed, lowercased
numberstringyes(required)Registry company numbermax 30 chars; must match [A-Za-z0-9-]{1,30}; trimmed

Request#

curl "https://api.onekey.dev/v1/opencorporates/company?jurisdiction=us_ca&number=C0806592" \
  -H "x-api-key: YOUR_API_KEY"

Try it

Add your key to run this call right here. No key? Get one free. The key stays in this tab.

Recorded response#

A real Opencorporates response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json
{
  "success": true,
  "data": {
    "entity": {
      "id": "C0806592",
      "name": "APPLE INC.",
      "status": "Active",
      "url": "https://opencorporates.com/companies/us_ca/C0806592"
    },
    "ext": {
      "jurisdiction": "us_ca"
    },
    "content": {
      "createdAt": "1977-01-03T00:00:00Z"
    },
    "place": {
      "address": "1 Apple Park Way, Cupertino, CA"
    }
  },
  "metadata": {
    "platform": "opencorporates",
    "endpoint": "company",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 1,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}

Field mapping#

How this endpoint's source fields become Onekey's unified schema. Fields the source lacks come back as null.

Source pathOnekey fieldTransform
company.company_numberentity.id-
company.nameentity.name-
company.jurisdiction_codeext.jurisdiction-
company.incorporation_datecontent.createdAttoIsoDate
company.current_statusentity.status-
company.opencorporates_urlentity.urlsafeUrl
company.registered_address_in_fullplace.address-

Caching and freshness#

  • Fresh for about 30 minutes. Repeat calls in that window are served from cache and are free.
  • Between 30 minutes and 6 hours the cached copy is still served instantly and marked stale: true while Onekey refreshes it in the background.
  • If the source is down when a refresh is needed, the last copy can be served for up to 1 day more (marked stale).
  • A "not found" is remembered for 5 minutes and is free.
  • The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

StatusCodeWhat to do
401unauthorizedCheck the x-api-key header.
402insufficient_creditsAdd credits; your balance must cover the price.
404not_foundThat record does not exist. Free; do not retry.
422invalid_paramsFix the parameters using the table above. Free.
429rate_limitedWait Retry-After seconds, then retry.
502upstream_errorThe source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: beta (not yet verified against the live source).