Resolve an identifier to its Bixel ID
Deterministic resolution of one input to its permanent Bixel ID. Pass exactly one of the input parameters (identifier auto-classifies; the typed parameters say what the value is). Every parseable request answers 200 with data.result_type: resolved (one entity at or above the inferred tier, with tier, why, and evidence references), redirected (a merged ID or a former identifier, with the redirect chain), ambiguous (candidates), unresolved (a reason plus would_resolve_with; tracked-but-unminted domains include the tracked block and register demand), not_a_company, retired, or input_invalid. Problem+json is reserved for protocol errors: no input, more than one input, or a bad target. Merged IDs always answer (an issued ID never 404s). meta carries data_version (the registry mint version), resolved_at, and the ODbL attribution block that redistributors pass through.
Query Parameters
Any single identifier, auto-classified: a bxc_ Bixel ID, an apex domain, any URL (folds to its registrable apex), an email address (resolves its domain), a LinkedIn or Crunchbase company URL, a 20-character LEI (the ISO 17442 checksum decides), or a Wikidata QID. Bare numbers are never guessed as CIK or Companies House numbers; use the typed parameters for those.
length <= 2048An apex domain.
length <= 2048Any URL; folds to its registrable apex.
length <= 2048An email address; its domain is resolved. Consumer mailboxes (gmail.com, outlook.com and the like) answer not_a_company.
length <= 2048A bxc_ Bixel ID (12 characters from the published alphabet).
length <= 2048A linkedin.com/company/ URL on any locale subdomain, or the bare slug. Person profiles (/in/) are input_invalid; showcase pages answer unresolved. Bixel never fetches LinkedIn: the slug is matched against identifiers companies published on their own sites.
length <= 2048A crunchbase.com/organization/ URL, or the bare permalink. Bixel never fetches Crunchbase.
length <= 2048A Legal Entity Identifier (20 characters; ISO 17442 check digits enforced, a failure answers input_invalid with reason lei_checksum).
length <= 2048An SEC Central Index Key (digits; zero-padding optional).
length <= 2048A UK Companies House company number (8 characters; numeric input is zero-padded; letter prefixes such as SC, NI, OC are kept).
length <= 2048A Wikidata QID, e.g. Q95.
length <= 2048An OpenCorporates identifier as published: jurisdiction/number, e.g. gb/02869245.
length <= 2048A company name. Name resolution ships with the name rung; until then a name answers unresolved with reason name_rung_not_available and would_resolve_with, and keyed lookups feed the demand log.
length <= 2048ISO 3166 code scoping a name lookup, e.g. GB or US-DE.
length <= 8Which kind to answer with. brand (default) answers the operating presence with its legal entity linked inline; legal_entity answers the registered company.
"brand"Value in
- "brand"
- "legal_entity"
Response Body
application/json
application/problem+json
application/problem+json
curl -X GET "https://example.com/v1/resolve"{ "data": { "identifier": "string", "input_kind": "identifier", "target": "brand", "result_type": "resolved", "entity": { "slug": "string", "record_available": true }, "tier": "attested", "matched_via": "bixel_id", "why": [ "string" ], "evidence": [ { "type": "capture", "id": "string" } ] }, "meta": { "generated_at": "2019-08-24T14:15:22Z", "count": 0, "total": 0, "next_cursor": "string", "notice": "string", "window": { "served_from": "string", "earliest_event_at": "string", "events_beyond_window": true }, "data_version": "string", "resolved_at": "2019-08-24T14:15:22Z", "attribution": { "source": "Bixel", "url": "string", "license": "CC-BY-4.0", "notice": "from Bixel", "data_version": "string" } }}{ "type": "http://example.com", "title": "string", "status": 0, "code": "company_not_found", "detail": "string", "hint": "string", "docs_url": "http://example.com"}{ "type": "http://example.com", "title": "string", "status": 0, "code": "company_not_found", "detail": "string", "hint": "string", "docs_url": "http://example.com"}