TRtrycompai
Risks

Create organization risk

Changed on

Create a risk record with ownership and context so compliance teams can track mitigation and remediation work.

post/v1/risks

Request

  • Base URL
    https://api.trycomp.ai
  • Auth
    API key in header X-API-Key

Request body

titlestring required

Risk title

descriptionstring required

Detailed description of the risk

category'customer' | 'fraud' | 'governance' | 'operations' | 'other' | 'people' | 'regulatory' | 'reporting' | 'resilience' | 'technology' | 'vendor_management' required

Risk category

departmentstring

Department responsible for the risk. Built-in values: none, admin, gov, hr, it, itsm, qms. Custom department names are also accepted.

status'open' | 'pending' | 'closed' | 'archived' required

Current status of the risk

likelihood'very_unlikely' | 'unlikely' | 'possible' | 'likely' | 'very_likely' required

Likelihood of the risk occurring

impact'insignificant' | 'minor' | 'moderate' | 'major' | 'severe' required

Impact if the risk materializes

residualLikelihood'very_unlikely' | 'unlikely' | 'possible' | 'likely' | 'very_likely' required

Residual likelihood after treatment

residualImpact'insignificant' | 'minor' | 'moderate' | 'major' | 'severe' required

Residual impact after treatment

treatmentStrategyDescriptionstring

Description of the treatment strategy

treatmentStrategy'accept' | 'avoid' | 'mitigate' | 'transfer' required

Risk treatment strategy

assigneeIdstring

ID of the user assigned to this risk

Example request

{
  "title": "Data breach vulnerability in user authentication system",
  "description": "Weak password requirements could lead to unauthorized access to user accounts",
  "category": "technology",
  "department": "it",
  "status": "open",
  "likelihood": "possible",
  "impact": "major",
  "residualLikelihood": "unlikely",
  "residualImpact": "minor",
  "treatmentStrategyDescription": "Implement multi-factor authentication and strengthen password requirements",
  "treatmentStrategy": "mitigate",
  "assigneeId": "mem_abc123def456"
}

Response

Risk created successfully

idstring

Risk ID

titlestring

Risk title

descriptionstring

Risk description

category'customer' | 'governance' | 'operations' | 'other' | 'people' | 'regulatory' | 'reporting' | 'resilience' | 'technology' | 'vendor_management'
department'none' | 'admin' | 'gov' | 'hr' | 'it' | 'itsm' | 'qms' nullable
status'open' | 'pending' | 'closed' | 'archived'
likelihood'very_unlikely' | 'unlikely' | 'possible' | 'likely' | 'very_likely'
impact'insignificant' | 'minor' | 'moderate' | 'major' | 'severe'
residualLikelihood'very_unlikely' | 'unlikely' | 'possible' | 'likely' | 'very_likely'
residualImpact'insignificant' | 'minor' | 'moderate' | 'major' | 'severe'
treatmentStrategyDescriptionstring nullable
treatmentStrategy'accept' | 'avoid' | 'mitigate' | 'transfer'
organizationIdstring
assigneeIdstring nullable

ID of the user assigned to this risk

createdAtstring date-time

When the risk was created

updatedAtstring date-time

When the risk was last updated

authType'api-key' | 'session'

How the request was authenticated

Example response

{
  "id": "rsk_abc123def456",
  "title": "Data breach vulnerability in user authentication system",
  "description": "Weak password requirements could lead to unauthorized access to user accounts",
  "category": "technology",
  "department": "it",
  "status": "open",
  "likelihood": "possible",
  "impact": "major",
  "residualLikelihood": "unlikely",
  "residualImpact": "minor",
  "treatmentStrategyDescription": "Implement multi-factor authentication and strengthen password requirements",
  "treatmentStrategy": "mitigate",
  "organizationId": "org_abc123def456",
  "assigneeId": "mem_abc123def456",
  "authenticatedUser": {
    "id": "usr_def456ghi789",
    "email": "user@example.com"
  }
}

Changes

  • 33c685841b7aRevision changes
    • breaking

      removed the enum value admin of the request property

    • breaking

      removed the enum value gov of the request property

    • breaking

      removed the enum value hr of the request property

    • breaking

      removed the enum value it of the request property

    • breaking

      removed the enum value itsm of the request property

    • breaking

      removed the enum value none of the request property

    • breaking

      removed the enum value qms of the request property

    • warning

      the request property's maxLength was set to 64

  • 7ca7c363a732Revision changes
    • breaking

      request property was restricted to a list of enum values

    • info

      added the new admin enum value to the request property

    • info

      added the new gov enum value to the request property

    • info

      added the new hr enum value to the request property

    • info

      added the new it enum value to the request property

    • info

      added the new itsm enum value to the request property

    • info

      added the new none enum value to the request property

    • info

      added the new qms enum value to the request property