Sign in
files

Get Document Risks

Get all risks associated with a document.

This is a cross-run file surface: a document's risks can span marketing, base, and other run types. Reviewer-only free-text (dismiss_note on any run, plus the TipTap notes doc on marketing runs) is redacted for callers without write access on the owning run's module, mirroring get_run_risks/get_risk_by_id. The write check runs once per distinct run type on the file, not once per risk.

get/files/{file_id}/risks

Path parameters

file_idstring uuid required

Response

Successful Response

risk_idstring uuid required
document_idstring uuid required
short_textstring required
explanationstring required
document_clausestring nullable
source_clausestring required
remediationstring nullable
severity'low' | 'medium' | 'high' required
status'reject' | 'allow' | 'flag' | 'dismissed' required
dismiss_reason'valid_ok' | 'already_met' | 'incorrect' | 'out_of_scope' | 'pre_approved' | 'other'

Why a reviewer dismissed a marketing risk (status=dismissed).

dismiss_notestring nullable
made_obsolete_bystring uuid nullable required
ignore_commentstring nullable required
{"stackTrail":"components:schemas:DocumentRiskResponseWithRun:properties:notes:anyOf","oasType":"schema","type":"unknown","title":"Notes","nullable":true}
created_by_user_idstring uuid nullable
run_idstring uuid required
suppressed_by_rule_idstring uuid nullable
filenamestring nullable
resolvedstring date-time nullable
issue_idstring uuid nullable
assignee_idstring uuid nullable
assignee_first_namestring nullable
assignee_last_namestring nullable
due_datestring date nullable
run_type'base' | 'soc' | 'soc1' | 'marketing' | 'overview' | 'contract_analysis' | 'drafting' | 'inherent_risk_assessment' | 'risk_assessment' required
run_timestring date-time required

Changes

No recorded changes to this endpoint across all 1 revision of this API.