Documentation
Documentation

Overview

Spore docs

Start here

Getting startedInstall the CLIAuthentication and keys

Build

Search and filtersSegments and the loopEnrichment lifecycle

Recipes

Recipe: search to a live SegmentRecipe: enrich without a segmentRecipe: land your own research

Connect

Events

Account

Credits and billing

Reference

Conventions
API reference
Export the organization's Operation calls POSTPage the organization's Operation calls GETExport the organization's recorded acts POSTPage the organization's recorded acts GETCancel an enrichment launch POSTRead a vocabulary: tools, filters, knowledge, or NACE GETPublish a staged Commons Generation POSTRestore the retained previous Commons Generation POSTPage the organization's Companies GETCorrect a Company's Core under Spore-If-Match PATCHDelete a Company DELETERead everything you know about one Company GETRead Legal entity data for Companies you hold POSTFind Legal entities in the Commons POSTFold one Company into another POSTMint Companies from your own data, or attach rows to Companies you hold POSTPromote a declared current Fact into Company Core POSTRead one Company GETMeasure requested fields over a set of Companies POSTRun a native enrichment POSTPoll an enrichment GETFollow the organization's durable events stream GETPage a Job's frozen target list GETCreate an API key and reveal its secret once POSTRevoke an organization API key POSTList per-item enrichment outcomes GETDeclare a namespace and its fields before recording into them POSTDelete a declaration while nothing stands on it DELETERead your Catalog GETRecord what you observed about a Company or concluded about a Segment POSTUnlock every Legal entity a search matched POSTSearch the Commons: count, analytics, and a minted sample POSTPage a Segment's members, with the exact count GETName a live filter over your Companies POSTDelete a Segment DELETERead what you have concluded about one Segment GETRename a Segment, or change what it means, under Spore-If-Match PATCHRead a Segment's name and filter GETPage the organization's Segments GETPage the organization's credit ledger GETRead the balance and this key's spend bounds GET
API reference

Find Legal entities in the Commons

Searches the Commons by name, by registration identifier, or both, and returns the Legal entities it carries. It mints nothing and unlocks nothing: each candidate reports whether this organization already holds a Company bound to it, so the caller decides what to mint (`POST /companies`) and what to pay to read (`POST /companies/legal-entity`). Free.

POST
/api/v1/companies/lookup

Searches the Commons by name, by registration identifier, or both, and returns the Legal entities it carries. It mints nothing and unlocks nothing: each candidate reports whether this organization already holds a Company bound to it, so the caller decides what to mint (POST /companies) and what to pay to read (POST /companies/legal-entity).

Free.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/companies/lookup" \  -H "Content-Type: application/json" \  -d '{    "name": "Coop Eesti",    "country": "EE"  }'
{  "candidates": [    {      "legalEntityId": "string",      "legalName": "string",      "country": "string",      "status": "string",      "companyId": "string",      "unlocked": true    }  ]}

Read Legal entity data for Companies you hold POST

Reads the live Registry record for up to 100 Companies, paying one credit for each Legal entity this organization has not unlocked before. `maxCredits` is mandatory spend consent and is checked against the worst-case quote before any Commons work; the whole request is refused rather than partly applied. `dryRun` returns that quote and which Companies it pays for, without reading the Commons, granting, or debiting; the real read charges the same, less what it cannot deliver: a Legal entity the Commons no longer carries, or one unlocked between the quote and the read. `namespaces` names the Namespaces whose Assertions ride beside each record, and only those the record's Inventory lists are read — read the Inventory off the locked section first, for free, and name its keys to get everything a Legal entity has, including the Namespaces a single Source owns. A Company with no Registry link is reported and never charged, an already-unlocked one is free forever, and a Legal entity the Commons no longer carries — including one withdrawn to a Tombstone — reads as absent. Variable price, quoted per request: up to 100 credits per call. 1 credit per Legal entity not yet unlocked, once, forever. Unverified and already-unlocked Companies are free.

Fold one Company into another POST

Folds the absorbed Company into the survivor because both name the same Legal entity, and redirects the absorbed id to the survivor forever. Permitted only when the absorbed Company names no Legal entity or names the survivor's: two Companies bound to different entities are two businesses, and a verified Company absorbed into an unverified one is refused with the direction to merge instead. The absorbed Company's identifiers always move — one qualified value belongs to exactly one Company, so they cannot collide — and its domains and activities move unless the survivor already holds the same value. The survivor keeps its name, its country, and its primaries. `dryRun` reports the same plan and writes nothing. Unlock is untouched: a grant belongs to the Legal entity, not to a Company. There is no split and no undo. Free. A merge never refunds.

name*string
Length2 <= length <= 200
country?string
Length2 <= length <= 2
identifier?
limit?integer
Range1 <= value <= 50