Compliance / CASL

Send a double opt-in confirmation from a toll-free number

Texts the recipient a fixed confirmation from your verified toll-free number: "{brand_name}: reply YES to confirm you want text messages from us. Msg & data rates may apply. Reply STOP to opt out." (with language: "fr": "{brand_name} : répondez OUI pour confirmer que vous voulez recevoir nos textos. Des frais de messagerie et de données peuvent s’appliquer. Répondez ARRET pour vous désabonner.").

Canadian toll-free messaging needs double opt-in, per sending number: until the recipient replies YES, Y, OUI or O to this number, sends to them from it are refused with 451 DOUBLE_OPT_IN_REQUIRED (each of your toll-free numbers asks for its own). The reply confirms the confirmation, records the double opt-in for this number, and fires consent.double_opt_in_confirmed. A STOP to this number withdraws it. Verification codes (POST /v1/verify) are exempt.

The recipient must already have an active consent (the first opt-in). The confirmation is billed as a normal message and expires after 7 days. Sending another from the same number replaces the pending one; at most 3 can be sent to one recipient in 24 hours, from any of your numbers. Live keys only.

Requires compliance:w.

post/v1/compliance/opt-in-confirmations

Request

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

Request body

fromstring required

Your toll-free number (E.164) with an approved toll-free verification.

tostring required

The recipient (E.164, Canadian), who must already have an active consent.

brand_namestring required

The name the recipient knows you by, shown at the start of the text. Plain text: letters, numbers, spaces and . , ' & ! -, not a link.

language'en' | 'fr'

The language of the confirmation text.

Response

Sent: the confirmation, PENDING until the recipient replies YES.

idstring required

oic_…

status'PENDING' | 'CONFIRMED' | 'EXPIRED' | 'DECLINED' required

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

fromstring nullable required

The toll-free number it was sent from.

tostring required

The recipient.

brand_namestring required
language'en' | 'fr' required
message_idstring nullable required

The confirmation text, as a message (GET /v1/messages/{id}).

expires_atstring date-time required
confirmed_atstring date-time nullable required
reply_message_idstring nullable required

The recipient's YES, as an inbound message.

created_atstring date-time required

Changes

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