honkio-ca · Schema

OptInConfirmation

A double opt-in confirmation sent from a toll-free number.

SMSEmailCanadaCASLPIPEDACompany

Properties

Name Type Description
id string oic_…
status string PENDING until the recipient replies YES (CONFIRMED), it lapses after 7 days or is replaced by a newer one (EXPIRED), or the recipient texts STOP (DECLINED).
from stringnull The toll-free number it was sent from.
to string The recipient.
brand_name string
language string
message_id stringnull The confirmation text, as a message (GET /v1/messages/{id}).
expires_at string
confirmed_at stringnull
reply_message_id stringnull The recipient's YES, as an inbound message.
created_at string
View JSON Schema on GitHub

JSON Schema

honkio-ca-opt-in-confirmation-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/honkio-ca/json-schema/honkio-ca-opt-in-confirmation-schema.json",
  "title": "OptInConfirmation",
  "description": "A double opt-in confirmation sent from a toll-free number.",
  "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/OptInConfirmation",
  "type": "object",
  "additionalProperties": true,
  "required": [
    "id",
    "status",
    "from",
    "to",
    "brand_name",
    "language",
    "message_id",
    "expires_at",
    "confirmed_at",
    "reply_message_id",
    "created_at"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "oic_…"
    },
    "status": {
      "type": "string",
      "enum": [
        "PENDING",
        "CONFIRMED",
        "EXPIRED",
        "DECLINED"
      ],
      "description": "PENDING until the recipient replies YES (CONFIRMED), it lapses after 7 days or is replaced by a newer one (EXPIRED), or the recipient texts STOP (DECLINED)."
    },
    "from": {
      "type": [
        "string",
        "null"
      ],
      "description": "The toll-free number it was sent from."
    },
    "to": {
      "type": "string",
      "description": "The recipient."
    },
    "brand_name": {
      "type": "string"
    },
    "language": {
      "type": "string",
      "enum": [
        "en",
        "fr"
      ]
    },
    "message_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "The confirmation text, as a message (GET /v1/messages/{id})."
    },
    "expires_at": {
      "type": "string",
      "format": "date-time"
    },
    "confirmed_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "reply_message_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "The recipient's YES, as an inbound message."
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    }
  }
}

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-opt-in-confirmation"
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.