Partner API

API reference

REST · HTTPSAuthX-API-KeyHMAC webhooksAudit30 days
GET/api/v1/partner/companies/search?q=<name or regcode>&limit=10

Company search

requires portfolio?q=<name or regcode>&limit=10

Look up a company by name to get its regcode.

Request
GET /api/v1/partner/companies/search?q=Circle+K&limit=10
X-API-Key: YOUR_KEY
Response200 · application/json
{
  "items": [
    {
      "regcode":             "40003521600",
      "name":                "SIA Example",
      "is_active":            true,
      "entity_type":         "SIA",
      "nace_code":           "47.11",
      "nace_description":    "Retail sale in non-specialised stores",
      "latest_revenue":       1250000.0,
      "latest_profit_loss":     95000.0,
      "latest_employees":          47,
      "letter_rating":       "B",
      "composite_score":       72.4
    }
  ],
  "count": 1        // total matches; can exceed the items returned
}

Watch out

  • Fewer than 2 characters in q returns an empty list, not an error.
  • count is the total number of matches and can exceed the number of items returned — narrow q rather than paging.
  • Search is a lookup, not proof of identity: check name before you store a regcode against a customer.