Compliance / CASL

Check if a phone number or email address has valid CASL consent

A consent this check finds past its expiry is marked EXPIRED as a side effect of the check itself, not only by a background job: this call can write, not just read.

Requires compliance:r.

get/v1/compliance/consents/check

Request

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

Query parameters

phone_numberstring
email_addressstring

Check an email address instead of a phone number. Email consent is available when the email product launches.

Response

Whether a send to the phone number or email address would pass the CASL gate. Exactly one of phone_number/email_address is present, matching the subject queried. consentType and reason are camelCase and mutually exclusive.

phone_numberstring
email_addressstring
allowedboolean required
consentType'EXPRESS' | 'IMPLIED'

Present when allowed.

reason'OPT_OUT' | 'NO_CONSENT' | 'CONSENT_EXPIRED'

Present when not allowed.

Changes

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