Skip to main content
Get a compliance check

Authorizations

Authorization
string
header
required

Personal API key. Send X-Organization-Id. The required cumulative level is listed in x-watchdog-permission.

Headers

X-Organization-Id
string

Required for personal API keys. Target one organization you have access to. Migrated keys may omit it to use their original organization. For Clerk sessions, it must match the active organization.

Path Parameters

id
string<uuid>
required

Response

The completed check.

id
string<uuid>
required
invoice_id
string<uuid>
required
agreement_id
string<uuid>
required
workflow_run_item_id
string<uuid>
required
summary
string
required
finding_count
integer
required
Required range: x >= 0
completeness
enum<string>
required

incomplete: the investigation reached its budget but established findings.

Available options:
complete,
incomplete
assessed
object
required

Inputs this evaluation read. Never rewritten.

freshness
enum<string>
required

Derived on read by comparing assessed inputs with the live invoice and agreement.

Available options:
current,
outdated
completed_at
string<date-time>
required