CrawlCheck Facts API

openapi: 3.2.0
info:
  title: Crawlcheck Io Facts API
  version: '1'
  contact:
    name: CrawlCheck
    url: https://crawlcheck.io/policy
    email: hello@crawlcheck.io
  license:
    name: Terms
    url: https://crawlcheck.io/policy
  x-core-contract:
    promise: 'These operations are the core contract. They stay at /api/v1 and keep answering for at least 180 days after any /api/v2 is announced; their stable fields change only in a new major version, and their provisional fields only after 30 days'' notice, per /docs/api/compatibility. Verifying what they return needs none of these calls: crawlcheck-verify.mjs checks a document on your machine against the published keys (/.well-known/http-message-signatures-directory) and the rotation record, read once with --online or saved for --keys. Everything else documented here is useful but secondary, and may change with the notice its fields'' tags promise.'
    operations:
    - method: GET
      path: /api/v1/resolve
      operationId: resolveDomainV1
    - method: POST
      path: /api/v1/resolve
      operationId: resolveBatchV1
    - method: POST
      path: /api/v1/preflight
      operationId: preflightV1
    - method: GET
      path: /api/v1/decisions/{sha256}
      operationId: decisionCheckV1
    - method: GET
      path: /api/v1/revocations
      operationId: revocations
    - method: GET
      path: /api/v1/visitor
      operationId: visitorResolveV1
    - method: POST
      path: /api/v1/visitor
      operationId: visitorResolveBatchV1
    - method: GET
      path: /api/v1/mcp/scan
      operationId: mcpScanUrl
    - method: POST
      path: /api/v1/mcp/lock/check
      operationId: mcpLockCheck
    list: https://crawlcheck.io/api/v1/core
  description: 'Operations tagged Facts across 2 of this provider''s published API definitions: crawlcheck-io-openapi.json, crawlcheck-io-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://crawlcheck.io
tags:
- name: Facts
paths:
  /api/v1/facts:
    get:
      operationId: factsV1
      summary: Business fact cards (fact1).
      parameters:
      - name: domain
        in: query
        required: true
        schema:
          type: string
      - name: field
        in: query
        required: false
        schema:
          type: string
          enum:
          - name
          - phone
          - address
          - service_area
          - hours
          - url
          - categories
          - services
      responses:
        '200':
          description: a set of signed fact cards
          content:
            application/json:
              schema:
                type: object
              examples:
                worked:
                  summary: Shape from the build harness on 2026-10-22; the signature block is abbreviated.
                  value:
                    kind: crawlcheck-fact-set
                    v: 1
                    domain: example.com
                    field: phone
                    record_built_at: '2026-10-22T14:10:53.581Z'
                    count: 1
                    cards:
                    - kind: crawlcheck-fact
                      v: 1
                      id: ccf_3f1c0a9b2d7e4c5a6b8d9e0f
                      subject:
                        domain: example.com
                        name: Example Tree Co
                      field: phone
                      value: '+13035550188'
                      standing: agree
                      from:
                      - site:structured-data
                      - site:tel-link
                      confirmed_by:
                      - source: Google Business Profile
                      confidence: confirmed
                      observed_at: '2026-10-22T14:10:53.581Z'
                      valid_until: '2026-11-21T14:10:53.581Z'
                      recheck: https://crawlcheck.io/api/v1/field-check?domain=example.com&field=phone&value=3035550188
                      reading: Confirmed by Google Business Profile; the business states it the same way in 2 places. Rely on it until 2026-11-21, then re-check.
                      signature:
                        alg: Ed25519
                        kid: '...'
                    verify: Each card is signed on its own with the document key.
                    rule: A card states what CrawlCheck read on observed_at and who else agreed.
      x-codeSamples:
      - lang: Shell
        label: curl
        source: curl -s 'https://crawlcheck.io/api/v1/facts?domain=example.com&field=phone'
      security: []
      x-auth: public; no credential read
      tags:
      - Facts
    servers:
    - url: https://crawlcheck.io
components:
  securitySchemes:
    licenceKey:
      type: apiKey
      in: header
      name: x-crawlcheck-key
      description: 'Your licence key: cc_ followed by 32 hex characters. Sent on every keyed call.'
    bearer:
      type: http
      scheme: bearer
      description: The same licence key as a Bearer token. Accepted on /api/v1/* and /api/usage.
externalDocs:
  url: https://crawlcheck.io/docs/api
  description: Human-readable reference
x-refined-from:
- crawlcheck-io-openapi.json
- crawlcheck-io-openapi.yml