---
title: "Get a bulk consent upload"
method: GET
path: "/v1/compliance/consent-batches/{id}"
tags: ["Compliance / CASL"]
---

# Get a bulk consent upload

`GET /v1/compliance/consent-batches/{id}`

## Request

- Base URL: `https://api.honkio.ca`
- URL: `https://api.honkio.ca/v1/compliance/consent-batches/{id}`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

Requires `compliance:r`.

## Path parameters

- `id` string, required

## Response `200`

The upload, with the defaults it was sent with.

- ConsentBatch
  - `id` string, required: cb_…
  - `source` 'api' | 'dashboard', required: Sent through the API, or uploaded on the dashboard.
  - `file_name` string, nullable, required: The file name the uploader gave, if any.
  - `attested` boolean, required: Whether the uploader confirmed these people gave this consent or have this relationship.
  - `counts` object, required
    - `rows` integer, required
    - `recorded` integer, required
    - `express` integer, required
    - `implied` integer, required
    - `already_recorded` integer, required
    - `opted_out` integer, required
    - `revoked_by_review` integer, required
    - `duplicate_in_file` integer, required
    - `invalid` integer, required
  - `revoked_at` string, date-time, nullable, required
  - `created_at` string, date-time, required
  - `defaults` object: The defaults the upload was sent with, as sent. Only on GET /v1/compliance/consent-batches/{id}.
    - `consent_type` 'express' | 'implied', required
    - `source_description` string
    - `source_ip` string
    - `source_url` string
    - `relationship_type` string
    - `last_transaction_date` string
    - `expires_at` string, nullable

## 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.
- `404`: NOT_FOUND: no such resource on this account.
- `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)