Skip to main content
GET
Get a compliance check

Authorizations

Authorization
string
header
required

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.

Path Parameters

matterId
string
required

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.

complianceCheckId
string
required

cck_ identifier of the compliance check. Returned on the operation that launched it.

Response

Successful Response

One compliance check: its findings, or its progress toward them.

id
string
required

Public identifier, cck_ followed by 32 hex characters.

Example:

"cck_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"

matterId
string
required

mat_ identifier of the matter this check belongs to.

Example:

"mat_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"

status
enum<string>
required

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.

Available options:
queued,
running,
succeeded,
failed,
cancelled
Example:

"queued"

createdAt
string<date-time>
required

When the check was created (RFC 3339).

Example:

"2026-08-19T14:32:10Z"

regulationType
string | null

Regulation checked against, echoed from the request.

Example:

"hipaa"

documentCategory
string | null

Document category, echoed from the request.

Example:

"vendor_agreement"

overallStatus
string | null

Overall verdict: compliant, partially_compliant, non_compliant, or not_applicable.

Example:

"partially_compliant"

complianceScore
integer | null

Compliance as a percentage, 0 to 100.

Example:

1

summary
string
default:""

Overall assessment, in prose.

Example:

"Twelve substantive changes, seven of them in the liability and indemnity sections."

requirements
ComplianceRequirement · object[]

Every requirement checked, and the verdict on each.

compliantCount
integer
default:0

Requirements fully met.

Example:

0

partiallyCompliantCount
integer
default:0

Requirements partly met.

Example:

0

nonCompliantCount
integer
default:0

Requirements not met.

Example:

0

notApplicableCount
integer
default:0

Requirements that do not apply to this document.

Example:

0

gaps
ComplianceGap · object[]

The gaps found.

remediationActions
ComplianceRemediationAction · object[]

What to do about them, in priority order.

responseTimeline
string | null

A regulatory deadline that applies, where one does.

Example:

"60 calendar days for access requests, with one 30-day extension."

deterministicCoverage
number | null

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.

Example:

1

preCheckFlags
string[]

Where the model and a deterministic keyword scan disagreed. Each one is worth a human glance.

Example:
parseWarning
string | null

Set when the model's output only partly parsed, which means the findings may be incomplete.

Example:

"Two clauses could not be parsed and are omitted from the findings."

completedAt
string<date-time> | null

When the check reached a terminal status (RFC 3339).

Example:

"2026-08-19T14:32:10Z"

Last modified on August 23, 2026