---
title: "Get firm check-quarantine rollup"
method: GET
path: "/firm/check-quarantine"
tags: ["Banking", "Firm"]
---

# Get firm check-quarantine rollup

`GET /firm/check-quarantine`

## Request

- Base URL: `https://ledgerhq.pro/api/v1`
- URL: `https://ledgerhq.pro/api/v1/firm/check-quarantine`
- Auth: one of:
  - HTTP bearer and API key in header `x-organization-id`
  - HTTP bearer and API key in header `x-organization-id`

Firm-anchored pure rollup of active check quarantine. OAuth scope bank_transactions:read. Permission view:data. Firm owner/admin sees all active managed companies. Staff Member/Advisor sees assigned companies only. This route is on the firm identity-only allowlist so assigned Staff Members can read their subset. Never prepares or enqueues.

## Response `200`

Firm check-quarantine rollup

- object
  - `data` CheckQuarantineFirmRollup, required
    - `firmOrganizationId` string, uuid, required
    - `firmPackage` 'core' | 'tally', required
    - `generatedAt` string, date-time, required
    - `counts` object, required
      - `companies` integer, required
      - `active` integer, required
      - `aged` integer, required
      - `waiting` integer, required
      - `machineActionable` integer, required
      - `humanInput` integer, required
      - `byBucket` object, required
    - `companies` CheckQuarantineFirmCompanyRollup[], required
      - `companyOrganizationId` string, uuid, required
      - `companyName` string, required
      - `active` integer, required
      - `aged` integer, required
      - `waiting` integer, required
      - `machineActionable` integer, required
      - `humanInput` integer, required
      - `byBucket` object, required

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Firm not found
- `default`: Error response

---

[API](https://skmtc.dev/ledgerhq-pro/apis/ledgerhq-bookkeeping-api.md) · [All operations](https://skmtc.dev/ledgerhq-pro/apis/ledgerhq-bookkeeping-api/llms.txt) · [OpenAPI document](https://skmtc.dev/ledgerhq-pro/apis/ledgerhq-bookkeeping-api/revisions/9a8269f0a586?raw)