---
title: "Check if a phone number or email address has valid CASL consent"
method: GET
path: "/v1/compliance/consents/check"
tags: ["Compliance / CASL"]
---

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

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

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

## Query parameters

- `phone_number` string
- `email_address` string

## Response `200`

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.

- object: 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_number` string
  - `email_address` string
  - `allowed` boolean, required
  - `consentType` 'EXPRESS' | 'IMPLIED': Present when allowed.
  - `reason` 'OPT_OUT' | 'NO_CONSENT' | 'CONSENT_EXPIRED': Present when not allowed.

## Other responses

- `401`: Missing, invalid, revoked or expired API key.
- `402`: The account has no balance, or a LIVE key was used before the first top-up.
- `403`: The API key lacks the permission this operation requires, or the account is suspended or closed.
- `422`: INVALID_PHONE_NUMBER, EMAIL_INVALID_ADDRESS, or VALIDATION_ERROR (provide exactly one of phone_number or email_address).
- `429`: Rate limit reached: 100 requests per second per account, or a route-specific limit (Retry-After set where one applies).
- `500`: Unexpected server error.
- `501`: EMAIL_COMING_SOON: email consent is available when the email product launches (sent only for an email_address request).

---

[API](https://skmtc.dev/honkio/apis/honkio-api.md) · [All operations](https://skmtc.dev/honkio/apis/honkio-api/llms.txt) · [OpenAPI document](https://skmtc.dev/honkio/apis/honkio-api/revisions/ce4ed3fe9691?raw)