honkio-ca

honkio-ca Compliance / CASL API

CASL consent and opt-out management

Documentation GitHub OpenAPI

Operations 12

POST /v1/compliance/consents Record CASL consent for a phone number or email address #

GET /v1/compliance/consents List consent records for account's subscribers #

POST /v1/compliance/consents/batch Record CASL consent for up to 5,000 phone numbers #

GET /v1/compliance/consent-batches List bulk consent uploads #

GET /v1/compliance/consent-batches/{id} Get a bulk consent upload #

GET /v1/compliance/consents/check Check if a phone number or email address has valid CASL consent #

DELETE /v1/compliance/consents/{phone} Revoke CASL consent for a phone number #

DELETE /v1/compliance/consents/email/{address} Revoke CASL consent for an email address #

POST /v1/compliance/opt-outs Manually record an opt-out for a phone number #

GET /v1/compliance/opt-outs List opt-out records #

POST /v1/compliance/opt-in-confirmations Send a double opt-in confirmation from a toll-free number #

GET /v1/compliance/opt-in-confirmations List double opt-in confirmations #

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/honkio-ca:honkio-ca-compliance-casl-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: HonkIO Compliance / CASL API
  description: 'Canadian-focused SMS gateway API.


    ## Canadian Compliance

    - **CASL**: All commercial messages require consent. Use `/v1/compliance/consents` to record.

    - **DNCL**: CRTC Do Not Call List checking is coming soon (not yet enforced).

    - **PIPEDA / Quebec Law 25**: Data is stored in Canada (ca-central-1). Requests are processed in the United States in transit. Right-to-erasure available.


    ## Authentication

    Provide your API key via `Authorization: Bearer mk_live_...` or `X-API-Key: mk_live_...`.

    Test keys never send, never charge and can''t change live data; they work before your first top-up.


    ## Rate limits

    100 requests per second per account. Every authenticated response carries `X-RateLimit-Limit`, `X-RateLimit-Remaining` and `X-RateLimit-Reset`.


    ## Pagination

    Shape follows the route family, not one convention across the API: documented here rather than changed. Messages listings return `{ data, meta: { page, limit, total, pages } }`. Contacts, Contact Groups, Lists and Verify listings return `{ data, total, limit, offset }`. Compliance consent and opt-out listings accept `page`/`limit` and return `{ data }`, with no total. Account transactions use a cursor: pass `before`, get back `has_more`.'
  version: 1.0.0
  contact:
    name: HonkIO Support
    email: support@honkio.ca
servers:
- url: https://api.honkio.ca
  description: Production
- url: http://localhost:3000
  description: Local development
security:
- apiKey: []
- apiKeyHeader: []
tags:


# --- truncated at 32 KB (56 KB total) ---
# Full source: https://artifacts.apis.io/honkio-ca/openapi/honkio-ca-compliance-casl-api-openapi.yml