BLblackkitetech
Company Report

Start to generate a document of a company.

Start to generate the pdf reports of the company for the given company id and a report type.

post/api/v2/companies/{id}/report-generate

Request

Path parameters

idinteger required
Example:123

The id of the company that the document is to be generated.

Request body

Type'summary' | 'strategy' | 'rsi' | 'assessment' required

The type of the PDF report. One of; <br/> summary: A one-page PDF report that reproduces the overall company view. <br/> strategy: A PDF report that provides explicit information allowing to make strategic mitigation decisions that will have the greatest impact based on the technical, financial, and compliance perspectives. <br/> rsi: A PDF report including ransomware related data which poses the most common threat to organizations, especially operations in finance, e-commerce, and healthcare. <br/> assessment: A PDF report that provides a summary of a specific cyber assessment.

Example request

{
  "Type": "strategy",
  "Assessment": {
    "AssessmentId": 456,
    "ReportType": "Summary"
  }
}

Response

Success

Tokenstring

A GUID token is provided to track the progress of report generation. Use this token as a query parameter in the getReportStatus action to retrieve the report status.

Example response

{
  "Token": "0f8fad5b-d9cb-469f-a165-70867728950e"
}

Changes

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