v1

latestOpenAPI 3.0.0Proprietary - Commercial Use Only2026-08-06172139621.6 KB
Assessment

Updates the rating of a specific control within an assessment for a monitored company.

Updates the rating of a specific assessment control item along with a comment explaining the change. The updating user information is required for audit purposes. The assessment must not be in 'Completed' status to allow updates.

patch/api/v2/companies/{id}/assessments/{assessmentId}/controls/{assessmentControlId}

Path parameters

idinteger required
Example:123

The id of the company whose assessment control rating will be updated.

assessmentIdinteger required
Example:456

The id of the assessment.

assessmentControlIdinteger required
Example:789

The unique identifier of the assessment control to update.

Request body

Rating'NoEvidence' | 'InsufficientEvidence' | 'Failed' | 'PartiallyCompliant' | 'FullyCompliant' | 'NotApplicable' required

The new rating value for the control.

Commentstring required

Comment describing the reason for the rating update. Required, must not be empty, and must be less than or equal to 1800 characters.

Example request

{
  "Rating": "FullyCompliant",
  "Comment": "Updated based on latest security review findings."
}

Response

Assessment control rating updated successfully.