Sign in
requirement-checks

Update Requirement Check

Update a requirement check's compliance status and/or reviewer note.

Allows reviewers to override the AI-generated compliance classification and document their reasoning.

patch/requirement-checks/{requirement_id}

Path parameters

requirement_idstring uuid required

Request body

check_labelstring nullable
reviewer_notestring nullable

Response

Successful Response

idstring uuid required
evidence_packet_idstring uuid required
evidence_packet_section_idstring uuid nullable
risk_area_namestring nullable
template_idstring uuid nullable
template_namestring nullable
question_idstring uuid required
compliance'compliant' | 'non_compliant' | 'partially_compliant' | 'no_evidence' | 'not_applicable'

Compliance status for an evidence requirement.

ai_compliance'compliant' | 'non_compliant' | 'partially_compliant' | 'no_evidence' | 'not_applicable'

Compliance status for an evidence requirement.

check_labelstring nullable
ai_check_labelstring nullable
classified_atstring date-time nullable
reviewer_notestring nullable
approval_status'pending' | 'approved' | 'issue_created'

Approval status for an evidence requirement check.

issue_idstring uuid nullable
collaborative_task_idstring uuid nullable
closed_atstring date-time nullable
check_type'REQUIREMENT' | 'RISK_FACTOR'

Discriminator for the evidence_requirement_checks polymorphic hierarchy.

suggested_inherent_risk_labelstring uuid nullable
suggested_inherent_risk_rationalestring nullable
suggested_control_strength_labelstring nullable
suggested_control_strength_rationalestring nullable
manual_inherent_risk_labelstring uuid nullable
manual_control_strength_labelstring nullable
agent_run_idstring uuid nullable

Changes

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