---
title: "List double opt-in confirmations"
method: GET
path: "/v1/compliance/opt-in-confirmations"
tags: ["Compliance / CASL"]
---

# List double opt-in confirmations

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

Newest first. A pending confirmation past its 7 days is reported EXPIRED. Confirmations are live only, so a test key lists none.

Requires `compliance:r`.

## Query parameters

- `to` string
- `status` 'PENDING' | 'CONFIRMED' | 'EXPIRED' | 'DECLINED'
- `page` integer
- `limit` integer

## Response `200`

A page of confirmations, newest first. No total is returned. Empty for a test key.

- object: A page of confirmations, newest first. No total is returned. Empty for a test key.
  - `data` OptInConfirmation[], required
    - `id` string, 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).
    - `from` string, nullable, required: The toll-free number it was sent from.
    - `to` string, required: The recipient.
    - `brand_name` string, required
    - `language` 'en' | 'fr', required
    - `message_id` string, nullable, required: The confirmation text, as a message (GET /v1/messages/{id}).
    - `expires_at` string, date-time, required
    - `confirmed_at` string, date-time, nullable, required
    - `reply_message_id` string, nullable, required: The recipient's YES, as an inbound message.
    - `created_at` string, date-time, required

## 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 (the to filter) or VALIDATION_ERROR.
- `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.

---

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