CrawlCheck Removal API

The Removal API from CrawlCheck — 4 operation(s) for removal.

GitHub OpenAPI

Operations 5

POST /api/removal Ask for removal without a licence: {type: site_control|personal_data|other… #
GET /api/removal The state of a removal request: verifying, review, decided, appealed, closed or… #
POST /api/removal/verify Prove a removal request: {id, t} checks the site-control token (file or TXT… #
POST /api/removal/appeal Appeal a removal decision once, within 30 days: {id, t, reason}. #
GET /api/removal/record A signed removal record: what was done in counts, and the sealed digests that… #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/crawlcheck-io:crawlcheck-io-removal-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

crawlcheck-io-removal-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Crawlcheck Io Removal 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 Removal 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: Removal
paths:
  /api/removal:
    post:
      operationId: removalRequest
      summary: 'Ask for removal without a licence: {type: site_control|personal_data|other…'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            examples:
              worked:
                summary: The request behind the worked response
                value:
                  type: site_control
                  domain: example.com
                  also_opt_out: true
      responses:
        '201':
          description: crawlcheck-removal-request with t
          content:
            application/json:
              examples:
                worked:
                  summary: Shape; not captured from production. t is shown once.
                  value:
                    ok: true
                    t: <32 hex, shown once>
                    status: https://crawlcheck.io/removal?id=rmv_0123456789abcdef
                    kind: crawlcheck-removal-request
                    id: rmv_0123456789abcdef
                    type: site_control
                    domain: example.com
                    state: verifying
                    prove:
                      file: https://example.com/.well-known/crawlcheck-removal.txt
                      dns_txt: _crawlcheck-removal.example.com
                      value: crawlcheck-removal=rmv_0123456789abcdef.89abcdef01234567
                      then: POST https://crawlcheck.io/api/removal/verify {id, t}
              schema:
                type:
                - object
                - 'null'
                properties:
                  ok:
                    type:
                    - boolean
                    - 'null'
                  t:
                    type:
                    - string
                    - 'null'
                  status:
                    type:
                    - string
                    - 'null'
                  kind:
                    type:
                    - string
                    - 'null'
                  id:
                    type:
                    - string
                    - 'null'
                  type:
                    type:
                    - string
                    - 'null'
                  domain:
                    type:
                    - string
                    - 'null'
                  state:
                    type:
                    - string
                    - 'null'
                  prove:
                    type:
                    - object
                    - 'null'
                    properties:
                      file:
                        type:
                        - string
                        - 'null'
                      dns_txt:
                        type:
                        - string
                        - 'null'
                      value:
                        type:
                        - string
                        - 'null'
                      then:
                        type:
                        - string
                        - 'null'
                    additionalProperties: true
                additionalProperties: true
                x-schema-source: worked-example
        '400':
          description: missing or invalid field
        '429':
          description: rate limited
      x-codeSamples:
      - lang: Shell
        label: curl
        source: 'curl -s -X POST https://crawlcheck.io/api/removal -H ''content-type: application/json'' -d ''{"type":"site_control","domain":"example.com"}'''
      security: []
      x-auth: public; no credential read
      x-crawlcheck-budget:
        request_body_max: 1048576
      tags:
      - Removal
    get:
      operationId: removalStatus
      summary: 'The state of a removal request: verifying, review, decided, appealed, closed or…'
      parameters:
      - name: id
        in: query
        required: true
        schema:
          type: string
      - name: t
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: crawlcheck-removal-request
          content:
            application/json:
              examples:
                worked:
                  summary: Shape; a request in review after its address was confirmed.
                  value:
                    ok: true
                    kind: crawlcheck-removal-request
                    id: rmv_0123456789abcdef
                    type: personal_data
                    domain: example.com
                    state: review
                    created_at: '2026-10-08T04:00:00.000Z'
                    verified_at: '2026-10-08T04:05:00.000Z'
                    decide_by: '2026-11-07T04:05:00.000Z'
                    decision: null
                    appeal: null
                    appeal_until: null
              schema:
                type:
                - object
                - 'null'
                properties:
                  ok:
                    type:
                    - boolean
                    - 'null'
                  kind:
                    type:
                    - string
                    - 'null'
                  id:
                    type:
                    - string
                    - 'null'
                  type:
                    type:
                    - string
                    - 'null'
                  domain:
                    type:
                    - string
                    - 'null'
                  state:
                    type:
                    - string
                    - 'null'
                  created_at:
                    type:
                    - string
                    - 'null'
                  verified_at:
                    type:
                    - string
                    - 'null'
                  decide_by:
                    type:
                    - string
                    - 'null'
                  decision: {}
                  appeal: {}
                  appeal_until: {}
                additionalProperties: true
                x-schema-source: worked-example
        '404':
          description: unknown id or wrong t
      x-codeSamples:
      - lang: Shell
        label: curl
        source: curl -s 'https://crawlcheck.io/api/removal?id=rmv_0123456789abcdef&t=<t>'
      security: []
      x-auth: public; no credential read
      tags:
      - Removal
    servers:
    - url: https://crawlcheck.io
  /api/removal/verify:
    post:
      operationId: removalVerify
      summary: 'Prove a removal request: {id, t} checks the site-control token (file or TXT…'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            examples:
              worked:
                summary: The request behind the worked response
                value:
                  id: rmv_0123456789abcdef
                  t: <t>
      responses:
        '200':
          description: crawlcheck-removal-request
          content:
            application/json:
              examples:
                worked:
                  summary: Shape; site control proven, deletion run at once.
                  value:
                    ok: true
                    kind: crawlcheck-removal-request
                    id: rmv_0123456789abcdef
                    type: site_control
                    domain: example.com
                    state: done
                    decision:
                      decision: delete_domain
                      at: '2026-10-08T04:06:00.000Z'
                      note: null
                      record: null
                      final: true
                    deletion:
                      job: dcj:0123456789abcdef0123
                      state: done
                      record: https://crawlcheck.io/api/data/deletion?sha256=<64 hex>
              schema:
                type:
                - object
                - 'null'
                properties:
                  ok:
                    type:
                    - boolean
                    - 'null'
                  kind:
                    type:
                    - string
                    - 'null'
                  id:
                    type:
                    - string
                    - 'null'
                  type:
                    type:
                    - string
                    - 'null'
                  domain:
                    type:
                    - string
                    - 'null'
                  state:
                    type:
                    - string
                    - 'null'
                  decision:
                    type:
                    - object
                    - 'null'
                    properties:
                      decision:
                        type:
                        - string
                        - 'null'
                      at:
                        type:
                        - string
                        - 'null'
                      note: {}
                      record: {}
                      final:
                        type:
                        - boolean
                        - 'null'
                    additionalProperties: true
                  deletion:
                    type:
                    - object
                    - 'null'
                    properties:
                      job:
                        type:
                        - string
                        - 'null'
                      state:
                        type:
                        - string
                        - 'null'
                      record:
                        type:
                        - string
                        - 'null'
                    additionalProperties: true
                additionalProperties: true
                x-schema-source: worked-example
        '409':
          description: token not found or wrong code
      x-codeSamples:
      - lang: Shell
        label: curl
        source: 'curl -s -X POST https://crawlcheck.io/api/removal/verify -H ''content-type: application/json'' -d ''{"id":"rmv_0123456789abcdef","t":"<t>"}'''
      security: []
      x-auth: public; no credential read
      x-crawlcheck-budget:
        request_body_max: 1048576
      tags:
      - Removal
    servers:
    - url: https://crawlcheck.io
  /api/removal/appeal:
    post:
      operationId: removalAppeal
      summary: 'Appeal a removal decision once, within 30 days: {id, t, reason}.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            examples:
              worked:
                summary: The request behind the worked response
                value:
                  id: rmv_0123456789abcdef
                  t: <t>
                  reason: My phone number is also on the report.
      responses:
        '200':
          description: crawlcheck-removal-request
          content:
            application/json:
              examples:
                worked:
                  summary: Shape; one appeal per decision, within 30 days.
                  value:
                    ok: true
                    kind: crawlcheck-removal-request
                    id: rmv_0123456789abcdef
                    type: personal_data
                    domain: example.com
                    state: appealed
                    decide_by: '2026-12-07T04:00:00.000Z'
                    appeal:
                      at: '2026-11-07T04:00:00.000Z'
                      decide_by: '2026-12-07T04:00:00.000Z'
              schema:
                type:
                - object
                - 'null'
                properties:
                  ok:
                    type:
                    - boolean
                    - 'null'
                  kind:
                    type:
                    - string
                    - 'null'
                  id:
                    type:
                    - string
                    - 'null'
                  type:
                    type:
                    - string
                    - 'null'
                  domain:
                    type:
                    - string
                    - 'null'
                  state:
                    type:
                    - string
                    - 'null'
                  decide_by:
                    type:
                    - string
                    - 'null'
                  appeal:
                    type:
                    - object
                    - 'null'
                    properties:
                      at:
                        type:
                        - string
                        - 'null'
                      decide_by:
                        type:
                        - string
                        - 'null'
                    additionalProperties: true
                additionalProperties: true
                x-schema-source: worked-example
        '409':
          description: nothing to appeal or already appealed
      x-codeSamples:
      - lang: Shell
        label: curl
        source: 'curl -s -X POST https://crawlcheck.io/api/removal/appeal -H ''content-type: application/json'' -d ''{"id":"rmv_0123456789abcdef","t":"<t>","reason":"..."}'''
      security: []
      x-auth: public; no credential read
      x-crawlcheck-budget:
        request_body_max: 1048576
      tags:
      - Removal
    servers:
    - url: https://crawlcheck.io
  /api/removal/record:
    get:
      operationId: removalRecord
      summary: 'A signed removal record: what was done in counts, and the sealed digests that…'
      parameters:
      - name: sha256
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: crawlcheck-removal-record
        '404':
          description: unknown digest
          content:
            application/json:
              examples:
                worked:
                  summary: 'An unknown digest; a real one returns the signed removal record: counts and the sealed digests that stay, never the removed text.'
                  value:
                    ok: false
                    error: No removal record with that digest.
              schema:
                type:
                - object
                - 'null'
                properties:
                  ok:
                    type:
                    - boolean
                    - 'null'
                  error:
                    type:
                    - string
                    - 'null'
                additionalProperties: true
                x-schema-source: worked-example
      x-codeSamples:
      - lang: Shell
        label: curl
        source: curl -s 'https://crawlcheck.io/api/removal/record?sha256=0000000000000000000000000000000000000000000000000000000000000000'
      security: []
      x-auth: public; no credential read
      tags:
      - Removal
    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