API reference
Declare identity facts for a verified claim
What the verified claimant states about the brand: cross refs (system + id; confirms or corrects what the site declared), alias / former / redirect domains, and former names with dates. Every row is stored with source = claim and evidence {type: claim, id} beside observed rows; disagreements are returned on the envelope as two rows, never merged. At most 50 items per call; a repeat of the same value is skipped, not duplicated. Costs 0 credits.
AuthorizationBearer <token>
bx_-prefixed API key. Free keys: https://bixel.com/account/
In: header
Path Parameters
id*string
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
application/problem+json
curl -X POST "https://example.com/v1/claims/string/declare" \ -H "Content-Type: application/json" \ -d '{}'{ "data": { "bixel_id": "string", "claim_id": "string", "written": { "cross_refs": 0, "domains": 0, "former_names": 0 }, "skipped_as_duplicate": { "cross_refs": 0, "domains": 0, "former_names": 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"}{ "type": "http://example.com", "title": "string", "status": 0, "code": "company_not_found", "detail": "string", "hint": "string", "docs_url": "http://example.com"}