> ## Documentation Index > Fetch the complete documentation index at: https://vaquill.ai/docs/llms.txt > Use this file to discover all available pages before exploring further. # Get a compliance check > One compliance check: its findings, or its progress toward them. 404 covers every reason it is not readable, including a job of a different kind that happens to share the table. ## OpenAPI ````yaml https://api.vaquill.ai/workspace/openapi/v1.json get /v1/matters/{matterId}/compliance-checks/{complianceCheckId} openapi: 3.1.0 info: title: Vaquill Legal Workspace API description: >- Organization-scoped API for driving your legal workspace from your own backend: matters, documents, drafting, review, compare and matrices. **Authentication**: `Authorization: Bearer vq_ws_...`. Credentials are issued by an organization owner from the automation console at `/automation` and are shown once. The organization is resolved from the credential and can never be named in a request, so there is no `organizationId` field anywhere in this API and sending one is refused. This is NOT the Vaquill Data API. That one holds a `vq_key_` credential and serves the public legal corpus; the two share no credential, host or endpoint, and sending a `vq_key_` here is refused with an error naming the other product. ## Long-running work Anything that costs real work answers `202` with an **operation**. Poll `GET /v1/operations/{operationId}` until `status` is `succeeded`, `failed` or `cancelled`, honouring `Retry-After` between polls. There are no webhooks, so polling is the only completion signal. The five statuses are `queued`, `running`, `succeeded`, `failed`, `cancelled`, and there is no sixth: every capability reports through the same envelope. Send an `Idempotency-Key` on any launch. A retry with the same key and the same body returns the FIRST operation rather than starting a second billable job, which is what makes recovering from a timeout free. ## Identifiers Every public id is `_<32 lowercase hex>`, for example `mat_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6`. The prefix names the resource type. Ids are opaque: take them from responses rather than building them, and never pass a bare database uuid. ## Lists Every collection answers `{data, pagination}`, never a bare array. Page with `limit` and `offset`, and read `pagination.total` to size a job before running it. `pagination.hasMore` is the reliable signal that rows remain. ## Errors Errors are RFC 9457 problem documents (`application/problem+json`), including for a wrong path and a wrong method. Branch on `type`; it is the stable identifier and it resolves to a page describing the failure. `title` and `detail` are written for people and may be reworded at any time. Every response carries `X-Request-ID`, and every error repeats it as `requestId`: quote it when contacting support. A `404` is returned identically for a resource that does not exist, one belonging to another organization, and one outside your installation's matter allowlist. That is deliberate, so the status code cannot be used to discover which ids exist elsewhere. ## Rate limits Limits are per credential and are set by what an operation COSTS rather than by its HTTP method, so a `GET` that runs a retrieval is not a read. Each operation's tier is fixed; a `429` carries `Retry-After`. | Tier | Per minute | Per hour | Per day | |---|---|---|---| | `poll` | 120 | 3000 | 30000 | | `read` | 60 | 1200 | 15000 | | `write` | 30 | 600 | 5000 | | `launch` | 10 | 200 | 2000 | | `download` | 20 | 300 | 3000 | | `upload` | 5 | 100 | 500 | ## Scopes A credential carries an explicit scope set, chosen when it is issued. A call outside them is `403` with `insufficient-scope`, naming the scopes the operation needed. Read and run are separate throughout, so a credential can be allowed to read results without being allowed to spend money producing them. `chronology:read`, `chronology:write`, `clients:read`, `clients:write`, `compare:read`, `compare:run`, `compliance:read`, `compliance:run`, `credentials:rotate`, `documents:download`, `documents:read`, `documents:write`, `drafting:read`, `drafting:run`, `exports:create`, `exports:read`, `facts:read`, `facts:run`, `matrices:read`, `matrices:run`, `matrices:write`, `matters:read`, `matters:write`, `nda:read`, `nda:run`, `operations:read`, `playbooks:read`, `playbooks:run`, `playbooks:write`, `research:read`, `research:run`, `review:read`, `review:run`, `summaries:read`, `summaries:run`, `webhooks:read`, `webhooks:write`, `workflows:read`, `workflows:run`, `workflows:write` version: 1.0.0 servers: - url: https://api.vaquill.ai/workspace description: Vaquill Legal Workspace API (production) - url: /workspace description: Vaquill Legal Workspace API (relative to the mount) security: - WorkspaceAuth: [] tags: - name: Operations description: >- The one job envelope. Every long-running call answers `202` with an operation, and polling this resource is the only way to learn it finished: there are no webhooks. Five statuses, no synonyms. - name: Clients description: The people and companies matters are filed under. Synchronous CRUD. - name: Matters description: >- The unit of work everything else hangs off. A matter scopes documents, drafts, reviews, comparisons and matrices, and it is what a credential's access is checked against. - name: Folders description: >- Organization inside and across matters. The same folders the web app shows, so one created here appears in the customer's browser. - name: Documents description: >- Files in a matter: their metadata, their ingested text, and the original bytes. A document is only usable by retrieval, drafting and review once its status is `succeeded`. - name: Uploads description: >- Getting files in. One presigned multipart flow at every size, with the bytes going straight to storage and never through this API. Initiate, PUT each part, then complete. - name: Research description: >- Asking legal questions and getting grounded, cited answers. This API does NOT stream: an ask answers `202` and you poll the operation, then read the answer off the message it points at. Conversation state is kept here, so you hold a chat id rather than replaying a transcript. Also covers the matter settings behind an answer, the skills you can ask through, and the standalone web-research tools. - name: Drafting description: >- Generating, revising and exporting draft documents. Bodies come out as sections and go in as markdown; the editor's own format is never on the wire. Rendered files come from the export route. - name: Playbooks description: >- The organization's negotiating positions, per contract type, and the starter templates to build them from. A playbook is the input a contract review is measured against. - name: Reviews description: >- Reviewing one contract against a playbook: clause analysis, redlines, flags, liability exposure and a reported sign-off gate. Export applies the redlines as native Word tracked changes. - name: Facts description: >- The cross-document fact ledger for a matter: what every document in it asserts, coalesced and cited back to its source passages. - name: Matter summary description: >- A citation-backed summary of everything filed to a matter, generated on demand and readable claim by claim. - name: Chronology description: >- The dated events across a matter's documents, as one timeline, with duplicate and date-conflict flags. - name: NDA triage description: >- Screening one inbound NDA against ten standard criteria and, where you name one, your own NDA playbook. Answers `green`, `yellow` or `red` with the reasoning per criterion, plus a report you can forward. - name: Compliance description: >- Checking one document against one regulation's requirement checklist: a verdict per requirement with the article it comes from, the gaps, and what to do about them. Only regulations with a real checklist behind them are accepted. - name: Comparisons description: >- Diffing two documents in a matter into structural changes, with a substantive-versus-cosmetic judgment and a downloadable redline. - name: Matrices description: >- Spreadsheet-style extraction across many documents: rows are documents, columns are questions, cells are answers with verified citations. Building a grid is free; running it is what costs. - name: Workflows description: >- Multi-step analyses from a fixed catalogue. Read a definition to learn what documents and inputs it takes, launch a run inside a matter, then download the artifacts it produces. externalDocs: description: Getting started guide and error reference url: https://vaquill.ai/docs/workspace-api paths: /v1/matters/{matterId}/compliance-checks/{complianceCheckId}: get: tags: - Compliance summary: Get a compliance check description: >- One compliance check: its findings, or its progress toward them. 404 covers every reason it is not readable, including a job of a different kind that happens to share the table. operationId: complianceChecks.get parameters: - name: matterId in: path required: true schema: type: string title: Matterid description: >- `mat_` identifier of the matter to work inside. Everything in this API hangs off a matter, and the matter in the path is what the authorization boundary is checked against. Take it from `GET /v1/matters`. - name: complianceCheckId in: path required: true schema: type: string title: Compliancecheckid description: >- `cck_` identifier of the compliance check. Returned on the operation that launched it. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ComplianceCheck' example: id: cck_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6 matterId: mat_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6 status: queued regulationType: value documentCategory: value overallStatus: value complianceScore: 1 summary: >- Twelve substantive changes, seven of them in the liability and indemnity sections. requirements: - requirementId: REQ-006 requirementName: Business Associate Agreement (BAA) regulationReference: 45 CFR 164.504(e) status: compliant findings: >- The agreement names Acme Corporation as a business associate and requires appropriate safeguards, but it is silent on subcontractor flow-down and on return or destruction of protected health information at termination. gapDescription: value recommendation: value priority: high compliantCount: 0 partiallyCompliantCount: 0 nonCompliantCount: 0 notApplicableCount: 0 gaps: - gapName: No subcontractor flow-down description: >- Master services agreement with Acme for the 2026 platform rollout. regulationReference: 45 CFR 164.504(e)(2)(ii)(D) riskLevel: value remediation: >- Add a clause requiring Acme Corporation to bind every subcontractor that receives protected health information to the same restrictions and conditions. remediationActions: - action: >- Add a subcontractor flow-down clause binding every subcontractor to the same restrictions. priority: high effort: value deadlineGuidance: value responseTimeline: value deterministicCoverage: 1 preCheckFlags: - value parseWarning: >- Two clauses could not be parsed and are omitted from the findings. createdAt: '2026-08-19T14:32:10Z' completedAt: '2026-08-19T14:32:10Z' '401': description: >- The credential is missing, malformed, unknown, revoked or expired. `type` is `invalid-credential`, or `wrong-product-credential` when a `vq_key_` Data API key was sent to this API. headers: X-Request-ID: description: >- The id of this request. The same value appears as `requestId` in the body. Quote it when contacting support. schema: type: string examples: - req_5f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6 WWW-Authenticate: description: RFC 9110 authentication challenge. schema: type: string content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '403': description: >- The credential does not carry a scope this operation requires (`insufficient-scope`), or the organization's installation is suspended (`installation-inactive`). headers: X-Request-ID: description: >- The id of this request. The same value appears as `requestId` in the body. Quote it when contacting support. schema: type: string examples: - req_5f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6 WWW-Authenticate: description: RFC 9110 authentication challenge. schema: type: string content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '404': description: >- The resource does not exist, is not this organization's, or is outside this installation's matter allowlist. The three are deliberately indistinguishable, so the status code cannot be used to discover which ids exist in another organization. Each resource has its own `type`. headers: X-Request-ID: description: >- The id of this request. The same value appears as `requestId` in the body. Quote it when contacting support. schema: type: string examples: - req_5f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6 content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '422': description: >- The request does not match the published schema. `errors` names each rejected field and why. The submitted value is never echoed back. headers: X-Request-ID: description: >- The id of this request. The same value appears as `requestId` in the body. Quote it when contacting support. schema: type: string examples: - req_5f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6 content: application/problem+json: schema: $ref: '#/components/schemas/ValidationProblem' '429': description: Too many requests for this credential's tier. Honour `Retry-After`. headers: X-Request-ID: description: >- The id of this request. The same value appears as `requestId` in the body. Quote it when contacting support. schema: type: string examples: - req_5f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6 Retry-After: description: Seconds to wait before retrying. schema: type: integer content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: >- An unexpected error on our side. The body carries a stable `type` and the request id and nothing else; the cause is in our logs. headers: X-Request-ID: description: >- The id of this request. The same value appears as `requestId` in the body. Quote it when contacting support. schema: type: string examples: - req_5f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6 content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '503': description: >- A dependency this request needs is unavailable, so nothing was done. Retryable. Authentication fails closed rather than admitting the request, so this is never a statement about your credential. headers: X-Request-ID: description: >- The id of this request. The same value appears as `requestId` in the body. Quote it when contacting support. schema: type: string examples: - req_5f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6 content: application/problem+json: schema: $ref: '#/components/schemas/Problem' components: schemas: ComplianceCheck: properties: id: type: string title: Id description: Public identifier, `cck_` followed by 32 hex characters. examples: - cck_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6 matterId: type: string title: Matterid description: '`mat_` identifier of the matter this check belongs to.' examples: - mat_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6 status: $ref: '#/components/schemas/OperationStatus' description: >- Check status, using the same five public values as an operation. While `queued` or `running`, `requirements` is empty and the scalar fields are absent. That is the truthful shape of a check that has not happened yet, not an error. examples: - queued regulationType: anyOf: - type: string - type: 'null' title: Regulationtype description: Regulation checked against, echoed from the request. examples: - hipaa documentCategory: anyOf: - type: string - type: 'null' title: Documentcategory description: Document category, echoed from the request. examples: - vendor_agreement overallStatus: anyOf: - type: string - type: 'null' title: Overallstatus description: >- Overall verdict: `compliant`, `partially_compliant`, `non_compliant`, or `not_applicable`. examples: - partially_compliant complianceScore: anyOf: - type: integer - type: 'null' title: Compliancescore description: Compliance as a percentage, 0 to 100. examples: - 1 summary: type: string title: Summary description: Overall assessment, in prose. default: '' examples: - >- Twelve substantive changes, seven of them in the liability and indemnity sections. requirements: items: $ref: '#/components/schemas/ComplianceRequirement' type: array title: Requirements description: Every requirement checked, and the verdict on each. compliantCount: type: integer title: Compliantcount description: Requirements fully met. default: 0 examples: - 0 partiallyCompliantCount: type: integer title: Partiallycompliantcount description: Requirements partly met. default: 0 examples: - 0 nonCompliantCount: type: integer title: Noncompliantcount description: Requirements not met. default: 0 examples: - 0 notApplicableCount: type: integer title: Notapplicablecount description: Requirements that do not apply to this document. default: 0 examples: - 0 gaps: items: $ref: '#/components/schemas/ComplianceGap' type: array title: Gaps description: The gaps found. remediationActions: items: $ref: '#/components/schemas/ComplianceRemediationAction' type: array title: Remediationactions description: What to do about them, in priority order. responseTimeline: anyOf: - type: string - type: 'null' title: Responsetimeline description: A regulatory deadline that applies, where one does. examples: - 60 calendar days for access requests, with one 30-day extension. deterministicCoverage: anyOf: - type: number - type: 'null' title: Deterministiccoverage description: >- Fraction of requirements with keyword evidence in the document, 0 to 1. Low coverage means more of the verdict rests on the model than on the text. examples: - 1 preCheckFlags: items: type: string type: array title: Precheckflags description: >- Where the model and a deterministic keyword scan disagreed. Each one is worth a human glance. examples: - - value parseWarning: anyOf: - type: string - type: 'null' title: Parsewarning description: >- Set when the model's output only partly parsed, which means the findings may be incomplete. examples: - Two clauses could not be parsed and are omitted from the findings. createdAt: type: string format: date-time title: Createdat description: When the check was created (RFC 3339). examples: - '2026-08-19T14:32:10Z' completedAt: anyOf: - type: string format: date-time - type: 'null' title: Completedat description: When the check reached a terminal status (RFC 3339). examples: - '2026-08-19T14:32:10Z' additionalProperties: false type: object required: - id - matterId - status - createdAt title: ComplianceCheck description: 'One compliance check: its findings, or its progress toward them.' Problem: type: object title: Problem description: >- An RFC 9457 problem document. Branch on `type`, which is stable; `title` and `detail` are written for people and may be reworded. Some problems carry extra members (`requiredScopes`, `limit`, `expectedVersion`), which is why this object is open. required: - type - title - status - detail - instance properties: type: type: string format: uri description: >- The stable identifier for this error, and the one field to branch on. Resolves to a page describing it. examples: - https://vaquill.ai/docs/workspace-api/errors/insufficient-scope title: type: string description: A short human-readable summary. examples: - Insufficient scope status: type: integer description: The HTTP status code, repeated. examples: - 403 detail: type: string description: >- What went wrong on this specific request. May be reworded at any time. examples: - >- This credential carries matters:read. This operation needs matters:write. instance: type: string description: The path this problem occurred on. examples: - /workspace/v1/matters/mat_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6 requestId: type: string description: >- The id of this request, identical to the `X-Request-ID` response header. Quote it when contacting support. examples: - req_5f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6 additionalProperties: true ValidationProblem: type: object title: ValidationProblem description: >- A problem document for a schema rejection. `errors` lists the fields that were refused. The value you submitted is deliberately not echoed, so a validation failure cannot copy your content into an error response or into either side's logs. required: - type - title - status - detail - instance - errors properties: type: type: string format: uri description: >- The stable identifier for this error, and the one field to branch on. Resolves to a page describing it. examples: - https://vaquill.ai/docs/workspace-api/errors/insufficient-scope title: type: string description: A short human-readable summary. examples: - Insufficient scope status: type: integer description: The HTTP status code, repeated. examples: - 403 detail: type: string description: >- What went wrong on this specific request. May be reworded at any time. examples: - >- This credential carries matters:read. This operation needs matters:write. instance: type: string description: The path this problem occurred on. examples: - /workspace/v1/matters/mat_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6 requestId: type: string description: >- The id of this request, identical to the `X-Request-ID` response header. Quote it when contacting support. examples: - req_5f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6 errors: type: array description: One entry per rejected field. items: type: object required: - location - message - type properties: location: type: string description: >- Dotted path to the rejected field, for example `body.contentMarkdown`. message: type: string description: Why it was rejected. type: type: string description: The validation rule that failed. additionalProperties: true OperationStatus: type: string enum: - queued - running - succeeded - failed - cancelled title: OperationStatus description: >- The public five. There is no sixth, and there are no synonyms. Internal vocabularies spell terminal success `completed`, `ready`, `extracted`, `succeeded` and `fresh`; terminal failure `failed` and `error`; queued `pending`, `queued` and `draft`. All of that is collapsed here by `app.workspace_api.adapters.status_map`, which refuses to guess. ComplianceRequirement: properties: requirementId: type: string title: Requirementid description: Stable identifier of this requirement. examples: - REQ-006 requirementName: type: string title: Requirementname description: What the requirement is. examples: - Business Associate Agreement (BAA) regulationReference: type: string title: Regulationreference description: Where it comes from, for example `GDPR Article 28(3)(a)`. examples: - 45 CFR 164.504(e) status: type: string title: Status description: >- Whether the document meets it: `compliant`, `partially_compliant`, `non_compliant`, or `not_applicable`. examples: - compliant findings: type: string title: Findings description: What the document actually says. examples: - >- The agreement names Acme Corporation as a business associate and requires appropriate safeguards, but it is silent on subcontractor flow-down and on return or destruction of protected health information at termination. gapDescription: anyOf: - type: string - type: 'null' title: Gapdescription description: What is missing, where the document does not meet it. examples: - >- No obligation to bind subcontractors to the same restrictions, and no return or destruction of protected health information on termination. recommendation: anyOf: - type: string - type: 'null' title: Recommendation description: What to change to meet it. examples: - >- Add a subcontractor flow-down clause and a termination clause requiring return or destruction of all protected health information. priority: anyOf: - type: string - type: 'null' title: Priority description: >- How urgent the remediation is: `critical`, `high`, `medium` or `low`. examples: - high additionalProperties: false type: object required: - requirementId - requirementName - regulationReference - status - findings title: ComplianceRequirement description: One requirement of the regulation, and whether the document meets it. ComplianceGap: properties: gapName: type: string title: Gapname description: Short name for the gap. examples: - No subcontractor flow-down description: type: string title: Description description: What is missing, and why it matters. examples: - Master services agreement with Acme for the 2026 platform rollout. regulationReference: type: string title: Regulationreference description: The provision the gap is measured against. examples: - 45 CFR 164.504(e)(2)(ii)(D) riskLevel: anyOf: - type: string - type: 'null' title: Risklevel description: 'How risky the gap is: `critical`, `high`, `medium` or `low`.' examples: - high remediation: type: string title: Remediation description: Suggested language or action to close it. examples: - >- Add a clause requiring Acme Corporation to bind every subcontractor that receives protected health information to the same restrictions and conditions. additionalProperties: false type: object required: - gapName - description - regulationReference - remediation title: ComplianceGap description: One compliance gap, named so it can be tracked. ComplianceRemediationAction: properties: action: type: string title: Action description: What needs to be done. examples: - >- Add a subcontractor flow-down clause binding every subcontractor to the same restrictions. priority: anyOf: - type: string - type: 'null' title: Priority description: '`critical`, `high`, `medium` or `low`.' examples: - high effort: anyOf: - type: string - type: 'null' title: Effort description: '`high`, `medium` or `low`.' examples: - low deadlineGuidance: anyOf: - type: string - type: 'null' title: Deadlineguidance description: Suggested timeline, for example `Within 30 days`. examples: - Within 30 days additionalProperties: false type: object required: - action title: ComplianceRemediationAction description: One thing to do, in priority order. securitySchemes: WorkspaceAuth: type: http scheme: bearer bearerFormat: vq_ws_* description: >- Workspace credential issued from the automation console at `/automation`. Send it as `Authorization: Bearer vq_ws_...`. This is NOT a Data API key: a `vq_key_` credential is refused here and names the other product in the error. ````