v1

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

Gets FAIR factors for a specific assessment of a monitored company.

Retrieves FAIR risk factors for the specified assessment, including factor metadata, mapped framework control, rating, and relevant scenarios.

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

Path parameters

idinteger required
Example:123

The id of the company whose FAIR factors will be retrieved.

assessmentIdinteger required
Example:456

The id of the assessment whose FAIR factors will be retrieved.

Response

Assessment FAIR factors retrieved successfully.

TotalCountinteger required

Total number of FAIR factors returned.

AssessmentIdinteger required

Identifier of the assessment.

CompanyIdinteger required

Identifier of the company.

AssessmentNamestring nullable

Assessment name for context.

Example response

{
  "FairFactors": [
    {
      "Id": "FIF01",
      "FactorName": "Incident response team",
      "FrameworkControlId": 5001,
      "Rating": "Implemented",
      "RelevantScenarios": [
        "DataBreach",
        "Ransomware"
      ],
      "Description": "Identifies the pathways through which threat agents can reach assets."
    }
  ],
  "TotalCount": 2,
  "AssessmentId": 456,
  "CompanyId": 123,
  "AssessmentName": "Q2 2026 Security Assessment"
}