Skip to main content
Get a compliance check

Authorizations

Authorization
string
header
required

Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).

Headers

X-Organization-Id
string

The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.

Path Parameters

id
string<uuid>
required

Query Parameters

fields
string

Return only these fields, comma-separated; use dots for nested fields, such as assessed.agreement_version. id is always returned. Fields: id, invoice_id, agreement_id, workflow_run_item_id, summary, finding_count, assessed, changed_since_check, completed_at.

Response

The completed check.

id
string<uuid>
required
invoice_id
string<uuid>
required
agreement_id
string<uuid>
required
workflow_run_item_id
string<uuid> | null
required

The workflow item that produced the check; null for checks made before workflow runs.

summary
string
required
finding_count
integer
required
Required range: x >= 0
assessed
object
required

The inputs the check read.

changed_since_check
object
required

Whether the agreement or the invoice changed after the check. A change does not make its findings wrong; check again to assess the new inputs.

completed_at
string<date-time>
required