honkio-ca

honkio-ca Accounts API

Account management and API keys

GitHub OpenAPI

Operations 25

POST /v1/accounts Create a new account #
PATCH /v1/accounts/{id} Update account name or settings #
GET /v1/accounts/{id} Get account details #
GET /v1/accounts/me Get the account the API key belongs to #
GET /v1/accounts/{id}/topup-allowance Top-up allowance (balance cap and rolling 30-day cap) #
GET /v1/accounts/{id}/usage Get usage summary for a billing period #
GET /v1/accounts/{id}/transactions List balance transactions (ledger), newest first #
POST /v1/accounts/{id}/api-keys Issue a new API key #
POST /v1/accounts/{id}/api-keys/{keyId}/rotate Rotate an API key (issue replacement and revoke the old one atomically) #
DELETE /v1/accounts/{id}/api-keys/{keyId} Revoke an API key #
PATCH /v1/accounts/{id}/api-keys/{keyId}/default-deny Toggle default-deny mode for an API key #
GET /v1/accounts/{id}/api-keys/{keyId}/lists Get allow/deny list assignments for an API key #
PUT /v1/accounts/{id}/api-keys/{keyId}/lists/{mode} Assign an allow or deny list to an API key #
DELETE /v1/accounts/{id}/api-keys/{keyId}/lists/{mode} Remove an allow or deny list from an API key #
POST /v1/accounts/{id}/phone-verification Start account owner phone verification #
POST /v1/accounts/{id}/phone-verification/confirm Confirm OTP to complete phone verification #
GET /v1/auto-topup Your auto top-up settings #
GET /v1/send-limit Your sending limits and current usage #
GET /v1/send-limit/requests List your volume requests #
POST /v1/send-limit/requests Request a higher daily sending volume #
GET /v1/business-verification Get your business verification #
PUT /v1/business-verification Save your business verification profile #
POST /v1/business-verification/submit Submit your business for verification #
POST /v1/account/topup-cap-requests Request higher top-up limits #
GET /v1/account/topup-cap-requests List your top-up limit requests #

Documentation

📖
Documentation
https://honkio.ca/docs
📖
APIReference
https://honkio.ca/docs/api

Specifications

⚙
OpenAPI
https://artifacts.apis.io/honkio-ca/openapi/honkio-ca-accounts-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/honkio-ca/json-schema/honkio-ca-toll-free-verification-schema.json
📊
JSONSchema
https://artifacts.apis.io/honkio-ca/json-schema/honkio-ca-account-document-schema.json
📊
JSONSchema
https://artifacts.apis.io/honkio-ca/json-schema/honkio-ca-account-me-document-schema.json
📊
JSONSchema
https://artifacts.apis.io/honkio-ca/json-schema/honkio-ca-sent-message-schema.json
📊
JSONSchema
https://artifacts.apis.io/honkio-ca/json-schema/honkio-ca-send-limit-schema.json
📊
JSONSchema
https://artifacts.apis.io/honkio-ca/json-schema/honkio-ca-message-schema.json

Other Resources

🔗
APIsJSON
https://artifacts.apis.io/honkio-ca/apis.yml

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-accounts-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

honkio-ca-accounts-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: HonkIO Accounts 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 (119 KB total) ---
# Full source: https://artifacts.apis.io/honkio-ca/openapi/honkio-ca-accounts-api-openapi.yml