honkio-ca · Schema

ConsentBatch

SMSEmailCanadaCASLPIPEDACompany

Properties

Name Type Description
id string cb_…
source string Sent through the API, or uploaded on the dashboard.
file_name stringnull The file name the uploader gave, if any.
attested boolean Whether the uploader confirmed these people gave this consent or have this relationship.
counts object
revoked_at stringnull
created_at string
defaults object The defaults the upload was sent with, as sent. Only on GET /v1/compliance/consent-batches/{id}.
View JSON Schema on GitHub

JSON Schema

honkio-ca-consent-batch-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/honkio-ca/json-schema/honkio-ca-consent-batch-schema.json",
  "title": "ConsentBatch",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/honkio-ca-compliance-casl-api-openapi.yml#/components/schemas/ConsentBatch",
  "type": "object",
  "additionalProperties": true,
  "required": [
    "id",
    "source",
    "file_name",
    "attested",
    "counts",
    "revoked_at",
    "created_at"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "cb_…"
    },
    "source": {
      "type": "string",
      "enum": [
        "api",
        "dashboard"
      ],
      "description": "Sent through the API, or uploaded on the dashboard."
    },
    "file_name": {
      "type": [
        "string",
        "null"
      ],
      "description": "The file name the uploader gave, if any."
    },
    "attested": {
      "type": "boolean",
      "description": "Whether the uploader confirmed these people gave this consent or have this relationship."
    },
    "counts": {
      "type": "object",
      "additionalProperties": true,
      "required": [
        "rows",
        "recorded",
        "express",
        "implied",
        "already_recorded",
        "opted_out",
        "revoked_by_review",
        "duplicate_in_file",
        "invalid"
      ],
      "properties": {
        "rows": {
          "type": "integer"
        },
        "recorded": {
          "type": "integer"
        },
        "express": {
          "type": "integer"
        },
        "implied": {
          "type": "integer"
        },
        "already_recorded": {
          "type": "integer"
        },
        "opted_out": {
          "type": "integer"
        },
        "revoked_by_review": {
          "type": "integer"
        },
        "duplicate_in_file": {
          "type": "integer"
        },
        "invalid": {
          "type": "integer"
        }
      }
    },
    "revoked_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "defaults": {
      "type": "object",
      "additionalProperties": true,
      "required": [
        "consent_type"
      ],
      "properties": {
        "consent_type": {
          "type": "string",
          "enum": [
            "express",
            "implied"
          ]
        },
        "source_description": {
          "type": "string"
        },
        "source_ip": {
          "type": "string"
        },
        "source_url": {
          "type": "string"
        },
        "relationship_type": {
          "type": "string"
        },
        "last_transaction_date": {
          "type": "string"
        },
        "expires_at": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "description": "The defaults the upload was sent with, as sent. Only on GET /v1/compliance/consent-batches/{id}."
    }
  }
}

Work with this as data

Every JSON Schema 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 schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • 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 JSON Schema
curl "https://apis.io/api/v1/json-schemas/honkio-ca-consent-batch"
All schemas
curl "https://apis.io/api/v1/json-schemas?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. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

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