v1

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

Gets the details of a specific assessment for a monitored company.

Retrieves all details for the specified assessment, including summary, status, frameworks, documents, and snapshot ratings.

get/api/v2/companies/{id}/assessments/{assessmentId}

Path parameters

idinteger required
Example:123

The id of the company whose assessment will be retrieved.

assessmentIdinteger required
Example:456

The id of the assessment to retrieve.

Response

Assessment details retrieved successfully.

Idinteger required

Id of the Assessment.

Namestring required

Name of the assessment.

Descriptionstring

Description of the assessment.

Summarystring

Summary of the assessment. This field may contain HTML-encoded text.

Status'Analyzing' | 'InvitationSent' | 'InvitationEnqueued' | 'WaitingOnVendor' | 'ReadyToReview' | 'InReview' | 'Completed' required

Status of the assessment.

OnlyApiEditableboolean required

If true, the assessment is only editable via API.

Example response

{
  "Id": 456,
  "Name": "Vendor Assessment Q3",
  "Description": "Quarterly vendor risk assessment.",
  "Summary": "This is the summary of the assessment.",
  "Status": "Completed",
  "OnlyApiEditable": true,
  "Frameworks": [
    {
      "FrameworkName": "CAIQ",
      "FrameworkFullName": "Consensus Assessments Initiative Questionnaire (CAIQ)",
      "Ratings": {
        "FullyCompliant": 46,
        "PartiallyCompliant": 8,
        "Failed": 14,
        "InsufficientEvidence": 14,
        "NoEvidence": 3
      }
    }
  ],
  "Documents": [
    {
      "Id": 789,
      "FileName": "Q3_Report.pdf",
      "Type": "Policies and Procedure",
      "Date": "2025-05-03T23:32:23.000Z",
      "DateSource": "Document Metadata",
      "UploadDate": "2024-06-01T12:00:00.000Z",
      "UploadedBy": "API",
      "Status": "Completed"
    }
  ],
  "SnapshotRatings": {
    "CyberRating": {
      "Grade": 85.5,
      "GradeLetter": "A"
    },
    "CyberRatings": [
      {
        "Module": "Network",
        "Grade": 85.5,
        "GradeLetter": "A"
      }
    ],
    "FairRatings": [
      {
        "RiskType": "Ransomware",
        "AnnualLossExposureAvg": 120000
      }
    ],
    "RsiDbiRatings": {
      "RansomwareIndex": 0.563,
      "RansomwareIndexIndustryAverage": 0.674,
      "BreachIndex": 0.738,
      "BreachIndexIndustryAverage": 0.675
    },
    "RsiTrend": [
      {
        "Date": "2025-05-03T23:32:23.000Z",
        "Value": 0.76
      }
    ],
    "DbiTrend": [
      {
        "Date": "2025-05-03T23:32:23.000Z",
        "Value": 0.458
      }
    ],
    "FocusTags": [
      {
        "Id": 1,
        "Name": "Cloud"
      }
    ],
    "SnapshotDate": "2024-06-01T12:00:00.000Z"
  },
  "Activities": [
    {
      "HistoryType": "AddComment",
      "InsertUser": "api@blackkite.com",
      "InsertDate": "2025-05-03T23:32:23.000Z",
      "FullName": "API User",
      "DocumentName": "Evidence.pdf",
      "Comment": "Please review the uploaded evidence."
    }
  ]
}