---
title: "Licence holder or owner. action suggest: the variants that are safe and unique for this business (printed nowhere CrawlCheck has read). action create {field, value, supplier}: register one (only a suggested variant is accepted, 422 otherwise). action planted {id, planted_at?}: mark it given to the supplier; sightings before this prove nothing. action retire {id}. Signed (crawlcheck-business-canaries)."
method: POST
path: "/api/v1/business/canaries"
---

# Licence holder or owner. action suggest: the variants that are safe and unique for this business (printed nowhere CrawlCheck has read). action create {field, value, supplier}: register one (only a suggested variant is accepted, 422 otherwise). action planted {id, planted_at?}: mark it given to the supplier; sightings before this prove nothing. action retire {id}. Signed (crawlcheck-business-canaries).

`POST /api/v1/business/canaries`

## Request

- Base URL: `https://crawlcheck.io`
- URL: `https://crawlcheck.io/api/v1/business/canaries`
- Auth: none required

## Request body

- object
  - `domain` string, required
  - `action` 'suggest' | 'create' | 'planted' | 'retire', required
  - `field` 'name' | 'street'
  - `value` string
  - `supplier` string
  - `id` string
  - `planted_at` string, date-time

## Response `200`

signed result

- object, nullable
  - `kind` string, nullable
  - `v` number, nullable
  - `domain` string, nullable
  - `truth` object, nullable
    - `name` string, nullable
    - `street` string, nullable
    - `storefront` boolean, nullable
  - `candidates` object[], nullable
    - `field` string, nullable
    - `value` string, nullable
    - `kind` string, nullable
  - `signature` object, nullable
    - `alg` string, nullable

## Other responses

- `401`: licence or owner needed
- `404`: unknown canary id
- `409`: 20 live canaries per business
- `413`: body over 4 KB
- `422`: not a safe, unique variant

---

[API](https://skmtc.dev/crawlcheck/apis/crawlcheck-api.md) · [All operations](https://skmtc.dev/crawlcheck/apis/crawlcheck-api/llms.txt) · [OpenAPI document](https://skmtc.dev/crawlcheck/apis/crawlcheck-api/revisions/57acbd6d4489?raw)