honkio-ca · Schema

Consent

A consent record as stored: field names are camelCase, unlike the rest of the API.

SMSEmailCanadaCASLPIPEDACompany

Properties

Name Type Description
id string
accountId string
channel string
phoneNumber stringnull
emailAddress stringnull
consentType string
status string
sourceDescription stringnull
sourceIp stringnull
sourceUrl stringnull
relationshipType stringnull
expiresAt stringnull
grantedAt string
revokedAt stringnull
revokedReason stringnull
doubleOptInConfirmedAt stringnull When the subscriber last confirmed double opt-in by replying YES to an opt-in confirmation from one of your toll-free numbers. A toll-free send needs a confirmation from its own sending number: see GE
doubleOptInConfirmationId stringnull The opt-in confirmation (oic_…) they answered.
consentBatchId stringnull The bulk upload (cb_…) that recorded this consent; null for one recorded on its own.
View JSON Schema on GitHub

JSON Schema

honkio-ca-consent-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/honkio-ca/json-schema/honkio-ca-consent-schema.json",
  "title": "Consent",
  "description": "A consent record as stored: field names are camelCase, unlike the rest of the API.",
  "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/Consent",
  "type": "object",
  "additionalProperties": true,
  "required": [
    "id",
    "accountId",
    "channel",
    "phoneNumber",
    "emailAddress",
    "consentType",
    "status",
    "sourceDescription",
    "sourceIp",
    "sourceUrl",
    "relationshipType",
    "expiresAt",
    "grantedAt",
    "revokedAt",
    "revokedReason",
    "doubleOptInConfirmedAt",
    "doubleOptInConfirmationId",
    "consentBatchId"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "accountId": {
      "type": "string"
    },
    "channel": {
      "type": "string",
      "enum": [
        "SMS",
        "EMAIL"
      ]
    },
    "phoneNumber": {
      "type": [
        "string",
        "null"
      ]
    },
    "emailAddress": {
      "type": [
        "string",
        "null"
      ]
    },
    "consentType": {
      "type": "string",
      "enum": [
        "EXPRESS",
        "IMPLIED"
      ]
    },
    "status": {
      "type": "string",
      "enum": [
        "ACTIVE",
        "EXPIRED",
        "REVOKED"
      ]
    },
    "sourceDescription": {
      "type": [
        "string",
        "null"
      ]
    },
    "sourceIp": {
      "type": [
        "string",
        "null"
      ]
    },
    "sourceUrl": {
      "type": [
        "string",
        "null"
      ]
    },
    "relationshipType": {
      "type": [
        "string",
        "null"
      ]
    },
    "expiresAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "grantedAt": {
      "type": "string",
      "format": "date-time"
    },
    "revokedAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "revokedReason": {
      "type": [
        "string",
        "null"
      ]
    },
    "doubleOptInConfirmedAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "When the subscriber last confirmed double opt-in by replying YES to an opt-in confirmation from one of your toll-free numbers. A toll-free send needs a confirmation from its own sending number: see GET /v1/compliance/opt-in-confirmations."
    },
    "doubleOptInConfirmationId": {
      "type": [
        "string",
        "null"
      ],
      "description": "The opt-in confirmation (oic_…) they answered."
    },
    "consentBatchId": {
      "type": [
        "string",
        "null"
      ],
      "description": "The bulk upload (cb_…) that recorded this consent; null for one recorded on its own."
    }
  }
}

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"
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.