Assessment

Adds a document to an assessment for a monitored company.

Uploads a document to the specified assessment for the given company.

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

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/:assessmentId/documents/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idinteger required

Example:123

The id of the company.

assessmentIdinteger required

Example:456

The id of the assessment.

Request body multipart/form-data

fileNamestring binary required

The binary content of the file to be uploaded. Supported file extensions: .xlsx, .xls, .xlsm, .docx, .doc, .txt, .pdf, .csv, .md

isStorableboolean

Indicates whether the uploaded document should be persistently stored in the system. If true, the document will be retained and accessible for future reference; if false, the document will be permanently deleted after processing is complete.

passwordstring

If the uploaded document is password-protected, enter its password here. This is required to access the document's content. Leave blank if the document is not protected.

Response

Document uploaded successfully.

DocumentIdinteger

This is the id of the assessment document. Use this id as a query parameter in the getAssessmentDocumentDetail action to retrieve the document status and details.

Example response

{
  "DocumentId": 789
}

Changes

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