Compliance / CASL

Record CASL consent for a phone number or email address

Records express or implied consent per CASL §6-10. Every SMS needs consent on file for its recipient, transactional or commercial (a verification code through the Verify API needs none); email needs it only for commercial sends. Refused with 409 CONSENT_REVOKED_BY_REVIEW when HonkIO revoked this recipient's consent on review of a bulk upload: such consent cannot be recorded again unless HonkIO lifts the block.

Requires compliance:w.

post/v1/compliance/consents

Request

  • Base URL: https://api.honkio.ca
  • URL: https://api.honkio.ca/v1/compliance/consents
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Request body

phone_numberstring

E.164 phone number of subscriber

email_addressstring

Email address of the subscriber (email channel). Email consent is available when the email product launches.

consent_type'express' | 'implied' required
source_descriptionstring

How/where consent was obtained (required for express)

source_ipstring

IP address of subscriber at time of consent

source_urlstring

URL where consent was obtained

relationship_typestring

Business relationship type (required for implied; e.g. "purchase")

last_transaction_datestring date

Date of last transaction (implied consent: expiry calculated from this)

expires_atstring

Explicit expiry (ISO 8601 date or date-time) for implied consent. Overrides the expiry derived from last_transaction_date. Not accepted for express consent, which never expires (CASL §10).

Response

Default Response

statusstring
phone_numberstring
email_addressstring
expires_atstring nullable

When this consent lapses (implied only); null for express consent.

Changes

No recorded changes to this operation across all 1 revision of this API.