Beta

Compdex is new: mistakes will happen. Tell us.

Report a problemSuggest a feature or give feedback
Skip to main content
For developers

API reference

Read Compdex from your own code, and have events about the companies you watch sent to you.

Getting started

The API comes with the Team and Data plans. Create a key on Plan and API, then call:

Base URL
https://api.compdex.ai
Your first call
curl -H "Authorization: Bearer $COMPDEX_API_KEY" \
  "https://api.compdex.ai/v1/api/usage"

Every response is JSON in UTF-8. Dates are YYYY-MM-DD, times are ISO 8601 in UTC, and money is in pounds, except a period of accounts filed in another currency, which carries its currency (USD, EUR) and its figures as filed in it, never converted; the finder's pounds figures leave such a company out. A value we do not have is null: absent and zero are different, and the API keeps them apart.

Authentication

Send your key on every request, in either header. Keys start cdx_live_, so a leaked one is easy to spot in a scan.

Authorization: Bearer cdx_live_…
# or
x-api-key: cdx_live_…

A key is shown once, when it is created; we keep only a hash of it. An account holds up to 10 keys, so each system can have its own and be revoked alone. Revoking a key refuses it at once. Keep keys on your servers: a key in a browser or an app can be read by anyone who has it. A call runs as the key's account, with that account's plan.

Reference

Endpoints

Each route on the public API, with a request, a response and what its statuses mean.

GET/v1/companies/{number}

One company in a single response: register facts, filed accounts, estimates with their working, scores, people, control, charges, filings and outside signals.

The same payload the Compdex company page is built from. Parts your plan does not include, such as the full credit score, are left out rather than filled. Every estimate carries estimate: true, a range, a confidence and a method; a figure the filing did not state is null, never zero.

Request
curl -H "Authorization: Bearer $COMPDEX_API_KEY" \
  "https://api.compdex.ai/v1/companies/$COMPANY_NUMBER"
Response
{
  "apiVersion": "v1",
  "company": {
    "number": "…", "name": "…", "slug": "…",
    "status": "…", "isActive": true,
    "depth": "full",            // or "register": built from the bulk register until a full read
    "sicCodes": ["…"], "town": "…",
    "registeredAddress": { "lines": ["…"], "postcode": "…" },
    "incorporatedOn": "YYYY-MM-DD", "accountsNextDue": "YYYY-MM-DD", …
  },
  "financials": [ … ],          // one entry per filed period, newest first; unstated lines are null
  "profitEstimate": {           // or null when there is nothing to estimate from
    "estimate": true, "periodEnd": "YYYY-MM-DD",
    "value": 0,                 // the best guess, never a floor (ADR 0338)
    "low": 0, "high": 0, "confidence": 0,
    "likely": { "low": 0, "high": 0, "confidence": 0 },
    "method": "…", "modelVersion": "…", "workings": [ … ]
  },
  "turnoverEstimate": { … },     // a similar estimate, or null
  "changes": [ … ],             // year-on-year movements in filed figures
  "distributions": [ … ],       // tax, dividends and directors' pay per period
  "scores": {                   // the Compdex Health Score: value, band, three parts, drivers, factors
    "health": { "value": 0, "band": "A", "parts": [ … ], "drivers": [ … ], "factors": [ … ], … },
    "credit": { … }
  },
  "officers": [ … ], "formerOfficers": [ … ], "pscs": [ … ],
  "charges": [ … ], "filings": [ … ], "timeline": [ … ],
  "valuation": { … }, "forecasts": [ … ], "peers": [ … ],
  "gazetteNotices": [ … ], "paymentReports": [ … ], "tenderAwards": [ … ],
  "evidence": { … },            // the source records behind the figures
  "underReview": [ … ],         // fields with an open dispute
  "freshness": { … },
  …
}
// The numbers above are placeholders showing each field's type, not figures.
StatusMeaning
200The company.
202We do not hold this company yet and are reading it from Companies House. The body is { "status": "loading", "retryAfterSeconds": n }; ask again after that wait.
400Not a valid company number.
404The register has no such company.
503A read failed moments ago: { "status": "unavailable", "reason": "…" }. Try again later.
GET/v1/officers/{id}

One officer and their appointments, using the officer id from a company response or a search.

Month and year of birth only, as the register publishes. Until the whole record has been read, fullRecord is false and the list covers the companies we hold.

Request
curl -H "Authorization: Bearer $COMPDEX_API_KEY" \
  "https://api.compdex.ai/v1/officers/$OFFICER_ID"
Response
{
  "id": "…", "name": "…",
  "bornMonth": 0, "bornYear": 0, "nationality": "…", "occupation": "…",
  "firstAppointed": "YYYY-MM-DD", "isDisqualified": false,
  "appointments": [
    { "companyNumber": "…", "companyName": "…", "role": "…", "status": "…",
      "appointedOn": "YYYY-MM-DD", "resignedOn": null, "held": true, … }
  ],
  "fullRecord": true, "readAt": "…", "refreshing": false,
  "trackRecord": { … }          // null until the full record has been read
}
StatusMeaning
200The officer.
404No such officer.
GET/v1/watchlist

The companies the account watches, with each one’s Compdex Health Score, latest estimate, cash and latest event.

The watchlist also decides which companies your webhooks carry events about.

Request
curl -H "Authorization: Bearer $COMPDEX_API_KEY" \
  "https://api.compdex.ai/v1/watchlist"
Response
{
  "items": [
    { "companyNumber": "…", "name": "…", "slug": "…", "status": "…", "town": "…",
      "addedAt": "…", "health": 0,
      "estimatedProfit": { "estimate": true, "value": 0, "low": 0, "high": 0, "confidence": 0, "method": "…", … },
      "cash": 0, "cashPrevious": 0,
      "latestEvent": { … } }
  ],
  "limit": 0                    // companies the plan may watch; null for no limit
}
StatusMeaning
200The watchlist.
GET/v1/watchlist/{number}

Whether the account watches one company.

Request
curl -H "Authorization: Bearer $COMPDEX_API_KEY" \
  "https://api.compdex.ai/v1/watchlist/$COMPANY_NUMBER"
Response
{ "watching": true }
StatusMeaning
200The answer.
PUT/v1/watchlist/{number}

Start watching a company. Doing it twice is harmless.

Request
curl -X PUT -H "Authorization: Bearer $COMPDEX_API_KEY" \
  "https://api.compdex.ai/v1/watchlist/$COMPANY_NUMBER"
Response
{ "watching": true }
StatusMeaning
200Watched.
400Not a valid company number.
403The plan’s watchlist is full: { "error": "…", "limit": n }.
404No such company on the register.
DELETE/v1/watchlist/{number}

Stop watching a company. Removing one that was not watched is harmless.

Request
curl -X DELETE -H "Authorization: Bearer $COMPDEX_API_KEY" \
  "https://api.compdex.ai/v1/watchlist/$COMPANY_NUMBER"
Response
{ "watching": false }
StatusMeaning
200Not watched.
GET/v1/api/usage

Calls used this month and the plan’s allowance. The call itself counts.

Request
curl -H "Authorization: Bearer $COMPDEX_API_KEY" \
  "https://api.compdex.ai/v1/api/usage"
Response
{
  "month": "YYYY-MM",           // the UTC calendar month
  "used": 0,
  "limit": 0                    // null when the plan has no monthly cap
}
StatusMeaning
200The month so far.
GET/v1/sic?q={query}

The UK SIC 2007 codes matching a code or words, with Companies House’s description of each.

Two to five digits match codes that start with them; anything else matches descriptions containing every word. Results are in code order.

Request
curl -H "Authorization: Bearer $COMPDEX_API_KEY" \
  "https://api.compdex.ai/v1/sic?q=bakery"
Response
{
  "query": "…",
  "mode": "words",              // or "code"
  "results": [ { "code": "…", "description": "…" } ],
  "truncated": false            // true when more codes matched than are listed
}
StatusMeaning
200Results, which may be empty.
400Neither two to five digits nor a word of two letters or more.
GET/v1/plans

The plans, their monthly prices, features and allowances, as the pricing page shows them. The call itself counts.

Prices are in pence. In an allowance, null means no cap and 0 means not included.

Request
curl -H "Authorization: Bearer $COMPDEX_API_KEY" \
  "https://api.compdex.ai/v1/plans"
Response
{
  "plans": [
    {
      "id": "…",                  // free, pro, team or data
      "name": "…",
      "monthlyPence": 0,
      "priceFrom": false,         // true where the price is a floor
      "purchasable": false,
      "features": [ { "id": "…", "label": "…" } ],
      "limits": { "seats": 0, "apiCalls": 0, "exportRows": 0, "…": 0 }
    }
  ]
}
StatusMeaning
200Every plan, in order.
GET/v1/deadlines?filter={all|due30|overdue}

The account’s client book: when each client company’s next accounts and confirmation statement are due at Companies House, with the days left and flags.

The same table as the Client deadlines page. A seat on a Team plan reads its owner’s book. Dates are the register’s, from the newer of our last full read of each company and the monthly register file, so a client we have not read in full still has its dates; readOn is the day of the last full read, or null. Days are whole UTC days: 0 is the due day, still on time; negative is overdue. A company that is not active has no calendar. Adding and removing clients, the reminder email and the calendar address stay on the web.

Request
curl -H "Authorization: Bearer $COMPDEX_API_KEY" \
  "https://api.compdex.ai/v1/deadlines?filter=due30"
Response
{
  "today": "YYYY-MM-DD",
  "filter": "due30",
  "rows": [
    { "companyNumber": "…", "name": "…", "slug": "…", "status": "active", "active": true,
      "accounts":     { "kind": "accounts", "dueOn": "YYYY-MM-DD", "daysLeft": 0, "state": "urgent" },
      "confirmation": { "kind": "confirmation", "dueOn": "YYYY-MM-DD", "daysLeft": 0, "state": "later" },
      "next": { … },              // the sooner of the two, which the table sorts by
      "readOn": "YYYY-MM-DD",     // null until the company is read in full
      "reading": false,
      "warnings": [ { "kind": "strike_off", "on": "YYYY-MM-DD", "detail": "…" } ],
      "addedAt": "…" }
  ],
  "counts": { "all": 0, "due30": 0, "overdue": 0 },
  "limit": 0,                   // clients the plan keeps; null for no limit
  "used": 0,
  "owner": null,                // the Team owner's name and email, when read from a seat
  "reminders": { … }, "calendar": { … }
}
StatusMeaning
200The book, which may be empty.
GET/v1/deadlines/export

The whole client book as a CSV, one row per client: the two due dates in ISO form with the days left, the status and the flags.

Cells are made safe for spreadsheets: none begins with a formula character. It counts as one call and does not spend the export allowance.

Request
curl -H "Authorization: Bearer $COMPDEX_API_KEY" \
  -o client-deadlines.csv "https://api.compdex.ai/v1/deadlines/export"
Response
company_number,company_name,status,accounts_due,accounts_days_left,confirmation_statement_due,confirmation_statement_days_left,next_deadline,next_deadline_state,warnings,register_read_on,page
…
// text/csv; charset=utf-8, one row per client
StatusMeaning
200The CSV.
GET/v1/datasets/true-sectors

The true-sector taxonomy on the Data plan: sections, groups and leaves with their definitions and typical SIC codes, and every retired slug with where it goes now.

JSON by default, CSV with format=csv. The latest published version unless version names one. A leaf's SIC codes are a hint, never a rule. Not counted against the export allowance.

Request
curl -H "Authorization: Bearer $COMPDEX_API_KEY" \
  "https://api.compdex.ai/v1/datasets/true-sectors?format=json"
Response
{
  "version": 2,
  "sections": [ { "slug": "technology", "name": "Technology and software",
    "groups": [ { "slug": "software-products", "name": "Software products",
      "leaves": [ { "slug": "software-saas-business", "name": "Business software (SaaS)", "definition": "…", "sic": ["62012"] } ] } ] } ],
  "redirects": { "old-slug": { "to": "new-slug", "kind": "merge", "version": 3 } }
}
StatusMeaning
200The taxonomy.
403The plan does not include datasets.
404No such version was published.
GET/v1/datasets/true-sectors/companies

The companies Compdex reads as a true sector, at any level, as a CSV stream: number, name, leaf, group, section, confidence, who set it, taxonomy version and when.

node is a section, group or leaf slug; a retired slug reads where it lives now. Readings at or above minConfidence (0.8 unless given). A row set by the company through a verified claim says owner and carries confidence 1. The file counts its rows against the month's export allowance before it starts, and is refused whole when the allowance is short.

Request
curl -H "Authorization: Bearer $COMPDEX_API_KEY" \
  -o software.csv "https://api.compdex.ai/v1/datasets/true-sectors/companies?node=software-products"
Response
company_number,company_name,active,leaf_slug,leaf_name,group_slug,group_name,section_slug,section_name,confidence,source,taxonomy_version,classified_at
…
// text/csv; charset=utf-8; x-dataset-rows: rows in the file
StatusMeaning
200The CSV.
403The plan does not include datasets, or the export allowance is short.
404No such node, or no company read there at that confidence.
Reference

Limits and webhooks

What an error says, how calls are counted, and how events reach you.

Errors and limits

An error answers with a status and a JSON body whose error says what went wrong in plain words.

StatusMeaning
401No key, or a key that is unknown or revoked.
403The endpoint is not part of the public API, the plan does not include the API or the feature asked for, or the account is suspended.
429The month’s allowance is spent, or the key made more requests in the minute or the day than its plan allows.

Monthly allowance. Team: 5,000 calls a month; Data: no monthly cap. Calls are counted per calendar month in London across every key on the account, including the seats on a Team plan, and the allowance renews at midnight on the 1st. A call counts once it has been answered with a success, a 202 included; a refused call (a 4xx) does not. Once the allowance is spent, calls answer 429 until the month turns.

Burst and daily limits. Each key may make its plan’s requests a minute and a day (UTC): Team: 120 requests a minute and 5,000 a day; Data: 300 requests a minute and 100,000 a day. Past either, calls answer 429 with a retry-after header in seconds; wait that long and carry on.

Usage headers. Every counted response carries the month so far:

x-api-calls-used: 1234     # calls this month, this one included
x-api-calls-limit: 5000    # the plan's allowance; absent when there is no cap
The header values above are illustrative.

Webhooks

Add an endpoint on Plan and API and choose the events it should carry. Each time one of those events is recorded for a company on your watchlist, we POST it to your address as JSON. An account holds up to 5 active endpoints; addresses must be https, to a public host name.

Body
{
  "id": "…",                    // the event's id: the same on every retry, so drop a repeat
  "type": "officer.appointed",  // one of the event kinds below
  "createdAt": "…",             // when the event was recorded, ISO 8601
  "company": { "number": "…", "name": "…" },
  "event": {
    "id": "…",
    "companyNumber": "…",
    "occurredOn": "YYYY-MM-DD",
    "kind": "officer.appointed",
    "headline": "…",            // one line in plain English
    "detail": { … },            // what the event carries, varying by kind; may be null
    "sourceUrl": "…",           // where it was read, such as the filing; may be null
    "origin": "stream",         // stream, refresh, sweep or model
    "createdAt": "…"
  }
}
Headers
content-type: application/json
user-agent: Compdex-Webhooks/1
compdex-signature: t=<unix seconds>,v1=<hex HMAC-SHA256>
compdex-event-id: <the body's id>

Answering. Answer with any 2xx status within 10 seconds; do slow work after answering. Anything else, a redirect included, or no answer in time, is a failure.

Retries. A failed delivery is tried again after 1 minute, 5 minutes, 30 minutes, 2 hours and 12 hours, then given up. Deliveries can arrive more than once and out of order: use id (also in compdex-event-id) to drop a repeat, and event.occurredOn to order them.

Switching off. After 20 failed deliveries in a row an endpoint is switched off, and what was still waiting for it is dropped. Plan and API shows it switched off, with the last failure. Delete it and add the address again once it answers.

Testing. Send test on Plan and API sends a signed ping, with no company and no event, so your receiver can tell it from news:

{
  "id": "ping_…",
  "type": "ping",
  "createdAt": "…",
  "company": null,
  "event": null
}

Event kinds. A new endpoint carries the ones marked default unless you choose otherwise. More kinds may be added: ignore a type you do not know.

TypeWhat happened
filing.accountsAccounts fileddefault
filing.confirmationConfirmation statementdefault
filing.otherFiling
capital.allotmentShare allotment
capital.reductionCapital reduction
officer.appointedDirector appointeddefault
officer.resignedDirector resigneddefault
psc.notifiedNew controller
psc.ceasedController ceased
charge.createdNew chargedefault
charge.satisfiedCharge satisfieddefault
company.incorporatedIncorporated
company.name_changedName changed
company.status_changedStatus changed
company.address_changedAddress changed
company.dissolvedDissolved
insolvency.caseInsolvency
gazette.noticeGazette noticedefault
strike_off.noticeStrike-off notice
accounts.overdueAccounts overdue
confirmation.overdueConfirmation overdue
score.changedScore changeddefault
control.changeChange of control
tax.none_while_profitableProfit filed with a £0 tax charge
dividends.payout_jumpPayout ratio jumped
dividends.exceeded_profitDividends exceeded profit

Verifying a delivery

Check every delivery before acting on it. The compdex-signature header holds t, the Unix time it was signed, and v1, the hex HMAC-SHA256 of the string <t>.<raw body>, keyed with the endpoint's signing secret. Compute the same over the body exactly as it arrived, before parsing it, compare in constant time, and refuse a timestamp more than five minutes from your clock. Each retry is signed afresh, so a retried delivery carries a current timestamp.

Node.js, standard library only
import { createHmac, timingSafeEqual } from 'node:crypto';

/**
 * rawBody: the request body exactly as it arrived (a Buffer or string),
 * before any JSON parsing. header: the compdex-signature header.
 * secret: the endpoint's signing secret, whsec_ and all.
 */
export function verifyCompdex(rawBody, header, secret, toleranceSeconds = 300) {
  const parts = Object.fromEntries(
    String(header ?? '').split(',').map((part) => {
      const at = part.indexOf('=');
      return [part.slice(0, at).trim(), part.slice(at + 1).trim()];
    }),
  );
  const t = Number(parts.t);
  if (!Number.isInteger(t) || Math.abs(Date.now() / 1000 - t) > toleranceSeconds) return false;
  const expected = createHmac('sha256', secret).update(`${t}.`).update(rawBody).digest();
  const given = Buffer.from(parts.v1 ?? '', 'hex');
  return given.length === expected.length && timingSafeEqual(given, expected);
}
Python, standard library only
import hashlib
import hmac
import time


def verify_compdex(raw_body: bytes, header: str, secret: str, tolerance: int = 300) -> bool:
    """raw_body: the body exactly as it arrived. header: the compdex-signature header.
    secret: the endpoint's signing secret, whsec_ and all."""
    parts = dict(p.strip().split("=", 1) for p in (header or "").split(",") if "=" in p)
    try:
        t = int(parts["t"])
    except (KeyError, ValueError):
        return False
    if abs(time.time() - t) > tolerance:
        return False
    expected = hmac.new(secret.encode(), f"{t}.".encode() + raw_body, hashlib.sha256).hexdigest()
    return hmac.compare_digest(expected, parts.get("v1", ""))

The signing secret is shown once, when the endpoint is added. If it is lost, delete the endpoint and add it again for a new one.

Reference

Integrations and versions

AI assistants, Zapier and your CRM, and how the API changes.

Use Compdex in Claude and ChatGPT

Available once the connector is deployedRemote MCP server, Streamable HTTP

Compdex is a connector for AI assistants: a remote MCP (Model Context Protocol) server that Claude, ChatGPT and other MCP clients call to look up UK companies. It is a client of this API with your key, so it needs the Team and Data plans, and each tool call is one call against your monthly allowance, under the same limits. Every answer names the Compdex page to cite, a filed figure comes with its filing date, and an estimate keeps its ranges, confidence and method.

Server address
https://mcp.compdex.ai/mcp

Signing in. Send your API key as a bearer token, Authorization: Bearer cdx_live_…. Make a separate key for the assistant on Plan and API, so you can revoke it alone.

Claude Code
claude mcp add --transport http compdex https://mcp.compdex.ai/mcp \
  --header "Authorization: Bearer cdx_live_…"
Claude Desktop: Settings, Developer, Edit Config (claude_desktop_config.json)
{
  "mcpServers": {
    "compdex": {
      "command": "npx",
      "args": ["-y", "mcp-remote", "https://mcp.compdex.ai/mcp", "--header", "Authorization:${COMPDEX_AUTH}"],
      "env": { "COMPDEX_AUTH": "Bearer cdx_live_…" }
    }
  }
}

Restart Claude Desktop after saving. It needs Node.js for the small bridge, which carries the header for you.

Cursor (mcp.json); other clients take the same address and header
{
  "mcpServers": {
    "compdex": {
      "url": "https://mcp.compdex.ai/mcp",
      "headers": { "Authorization": "Bearer cdx_live_…" }
    }
  }
}

claude.ai and ChatGPT. Custom connectors on the web sign in with OAuth rather than a key. Compdex's OAuth sign-in comes with its listing in their connector directories; until then, use Claude Desktop, Claude Code or another client above.

Tools. All read-only. Nothing is written to your account.

search_companiesFind a company by name or number: up to 20 matches, live companies first. Calls GET /v1/search.
get_companyThe summary: register facts, the latest filed accounts with their filing date, estimates with their ranges, confidence and method, health, and the credit band (the score where the plan includes credit). Calls GET /v1/companies/{number}.
get_financialsFiled accounts period by period, year-on-year changes, and tax and dividends. Calls GET /v1/companies/{number}.
get_peopleOfficers, former officers, persons with significant control and group companies. Month and year of birth only; no addresses. Calls GET /v1/companies/{number}.
get_eventsWhat changed: filings, charges, appointments and signals, newest first. Calls GET /v1/companies/{number}.
find_companiesThe Company finder’s filters: place, industry, status, type, age, filed figures and estimates. Calls GET /v1/finder.
companies_likeCompanies like one or more others, ranked by likeness. Calls GET /v1/finder/lookalikes.
get_client_deadlinesYour client book’s accounts and confirmation statement due dates. Calls GET /v1/deadlines.

When a call is refused. The assistant is told why in words it can pass on: an unknown or revoked key, a plan without the API or the feature asked for, the month's allowance used, or too many calls a minute.

Zapier

Compdex works in Zapier as a private integration built on this API, with the Team and Data plans. Zapier signs in with an API key in the x-api-key header, and checks it by calling GET /v1/api/usage. Without an integration, Webhooks by Zapier can call the same endpoints with the same header.

Instant triggers (REST hooks). When a Zap is switched on, Zapier subscribes its own address; when it is switched off, it unsubscribes. Each subscription is sent events about the companies on your watchlist, signed and retried as a webhook endpoint is. If Zapier answers a delivery with 410, the subscription is removed. An account holds up to 25 subscriptions. A delivery does not count against the monthly allowance; subscribing and unsubscribing do.

Subscribe
curl -X POST -H "x-api-key: cdx_live_…" -H "content-type: application/json" \
  -d '{"target_url":"https://hooks.zapier.com/hooks/standard/…","event":"charge.created"}' \
  "https://api.compdex.ai/v1/hooks"
# 201 {"id":"…","target_url":"…","events":["charge.created"],"createdAt":"…"}
Unsubscribe
curl -X DELETE -H "x-api-key: cdx_live_…" "https://api.compdex.ai/v1/hooks/{id}"

event takes one event kind and events a list; with neither, the webhook defaults are sent. The kinds are those listed under Webhooks above.

Sample data. GET /v1/hooks/sample/{kind} answers an array of one body in the delivery's shape, marked "sample": true, about SAMPLE COMPANY LIMITED (not a real company), number 00000000, which Companies House never issues. It carries no figures. Zapier shows it while a Zap is built.

Polling trigger. GET /v1/hooks/events answers the events on your watchlist, newest first, as an array of delivery bodies, each with its id for Zapier to drop what it has seen. kinds takes a comma-separated list; limit is 50 by default and at most 100. Every poll is a call against the allowance, so a Zap polling every few minutes spends thousands a month: prefer the instant trigger.

PUT /v1/watchlist/{number}Action: watch a company. Its events then reach your triggers.
GET /v1/listsYour lists, for a dropdown in the Zap editor.
POST /v1/listsAction: make a list, with {"name": "…"}.
POST /v1/lists/{id}/membersAction: add companies, with {"numbers": ["01234567"]}. A number the register never issued is counted back, not stored.
DELETE /v1/lists/{id}/members/{number}Action: take a company off a list.

HubSpot and Salesforce

With the Team and Data plans, connect your own HubSpot or Salesforce under Integrations and send a list from its page, or one company from the ⋯ menu in its header. Each company is created the first time and updated after, matched by its number, so none is made twice. A list can be kept in step every day. This is not part of the public API: it runs as you, from the site.

HubSpot, once. In Settings, Properties, Company properties, create a single-line text property with the internal name compdex_number and tick Require unique values for this property. HubSpot matches on it. Compdex asks only for company read and write.

Salesforce, once. In Setup, Object Manager, Account, Fields & Relationships, create a Text(8) field with the API name Compdex_Number__c and tick Unique and External ID, visible and editable to the profile of whoever connects. Records are sent as Accounts with that person's rights.

What is sent. The fields below, each to the property you choose; the defaults are the CRM's own where it has one. A custom property must exist before it is mapped. A value Compdex does not hold is left out, never sent blank. Estimates are sent only if you tick Include estimates, and then as text that says it is a Compdex estimate and not a filed figure, with its range, confidence and year: map them to a text property.

Company number (the match key)HubSpot compdex_number · Salesforce Compdex_Number__c
Registered nameHubSpot name · Salesforce Name
Registered address, streetHubSpot address · Salesforce BillingStreet
Registered address, townHubSpot city · Salesforce BillingCity
Registered address, postcodeHubSpot zip · Salesforce BillingPostalCode
Registered address, countryHubSpot country · Salesforce BillingCountry
SIC codesHubSpot compdex_sic (suggested) · Salesforce Sic
SIC description (first code)HubSpot compdex_sic_description (suggested) · Salesforce SicDesc
Status on the registerHubSpot compdex_status (suggested) · Salesforce Compdex_Status__c (suggested)
Incorporated onHubSpot compdex_incorporated (suggested) · Salesforce Compdex_Incorporated__c (suggested)
WebsiteHubSpot domain · Salesforce Website
Latest accounts made up toHubSpot compdex_accounts_to (suggested) · Salesforce Compdex_Accounts_To__c (suggested)
Turnover, latest filedHubSpot annualrevenue · Salesforce AnnualRevenue
Net assets, latest filedHubSpot compdex_net_assets (suggested) · Salesforce Compdex_Net_Assets__c (suggested)
Employees, latest filedHubSpot numberofemployees · Salesforce NumberOfEmployees
Turnover, Compdex estimate (labelled text)HubSpot compdex_turnover_estimate (suggested) · Salesforce Compdex_Turnover_Estimate__c (suggested)
Profit before tax, Compdex estimate (labelled text)HubSpot compdex_profit_estimate (suggested) · Salesforce Compdex_Profit_Estimate__c (suggested)
Compdex pageHubSpot compdex_url (suggested) · Salesforce Compdex_URL__c (suggested)

Versioning

Every path starts /v1. Within v1, changes are additive only: new endpoints, new fields in a response, and new event kinds may appear, but no field is removed or renamed or changes its meaning. Read the fields you need and ignore the rest. A change that would break a client comes as a new version beside v1, not as a change to it.

Estimates from public filings; not a credit reference or financial advice. Contains public sector information licensed under the Open Government Licence v3.0.