Assessment

Creates a new assessment for a monitored company.

Creates a new assessment for the specified company.

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

Request

Base URL
https://app.blackkitetech.com
Auth
OAuth 2
Client credentials
Token URLhttps://app.blackkitetech.com//api/v2/oauth/token
TypeScript
https://skmtc.dev/blackkitetech/apis/black-kite-api/docs/api/v2/companies/:id/assessments/post.ts
A function with typed inputs. Its response is checked against the schema.

idinteger required

Example:123

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

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.

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

Assessment created successfully.

AssessmentIdinteger required

Id of the created assessment.

{
  "AssessmentId": 456
}

No recorded changes to this operation across all 8 revisions of this API.