API reference
Start a domain claim
Create a pending claim for a registrable apex you control and receive the proof instructions for the chosen method: dns_txt (a TXT record bixel-verification=), html_meta (a tag on the homepage), or verified_email (an address at the domain already verified on the account). Then POST /v1/claims/{id}/verify. An account may hold 10 pending claims. Costs 0 credits.
AuthorizationBearer <token>
bx_-prefixed API key. Free keys: https://bixel.com/account/
In: header
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/claims" \ -H "Content-Type: application/json" \ -d '{ "domain": "acme.com", "method": "dns_txt" }'{ "data": { "claim": { "id": "string", "domain": "string", "method": "dns_txt", "status": "pending", "bixel_id": "string", "requested_at": "2019-08-24T14:15:22Z", "verified_at": "2019-08-24T14:15:22Z", "instructions": "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"}{ "type": "http://example.com", "title": "string", "status": 0, "code": "company_not_found", "detail": "string", "hint": "string", "docs_url": "http://example.com"}