BixelDocs
API reference

Resolve up to 1,000 identifiers

POST
/v1/resolve/batch

List-in intake: every row runs the same resolve ladder as GET /v1/resolve and answers the same typed per-row shape (data.results[i].result_type). Rows are bare strings (auto-classified like identifier=) or objects with exactly one typed input key, for example {"lei": "..."}, {"companies_house": "..."}, {"email": "..."}, plus optional jurisdiction and target. Tracked-domain misses register demand; unknown domains are logged as coverage candidates, so a pasted CRM export becomes coverage. Optional watch attach: watch:true with watch_subscription_id adds resolved, servable companies to that subscription in the same call (normal watch tier caps apply). Requires an API key (a free key is fine); request cost is batch-weighted, about 1 credit per 100 rows, capped at 10.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/v1/resolve/batch" \  -H "Content-Type: application/json" \  -d '{    "identifiers": [      "string"    ]  }'
{  "data": {    "results": [      {        "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"          }        ]      }    ],    "summary": {      "total": 0,      "by_result_type": {        "resolved": 0,        "redirected": 0,        "ambiguous": 0,        "unresolved": 0,        "not_a_company": 0,        "retired": 0,        "input_invalid": 0      }    },    "watch": {      "subscription_id": "string",      "attached": 0,      "already_watched": 0,      "not_watchable": 0    }  },  "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"}
{  "type": "http://example.com",  "title": "string",  "status": 0,  "code": "company_not_found",  "detail": "string",  "hint": "string",  "docs_url": "http://example.com"}