v1

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

Creates a new assessment for a monitored company.

Creates a new assessment for the specified company.

post/api/v2/companies/{id}/assessments

Path parameters

idinteger required
Example:123

The id of the company for which the assessment will be created.

Request body

Namestring required

Name of the assessment. The assessment name must be unique within the same company.

Descriptionstring

Optional description of the assessment.

Frameworksstring[] required

List of framework names to associate with the assessment.

OnlyApiEditableboolean

If true, the assessment is only editable via API.

Example request

{
  "Name": "Vendor Assessment Q3",
  "Description": "Quarterly vendor risk assessment.",
  "Frameworks": [
    "CAIQ"
  ]
}

Response

Assessment created successfully.

AssessmentIdinteger required

Id of the created assessment.

Example response

{
  "AssessmentId": 456
}