Skip to main content

Risk Assessments API

Product-scoped risk assessments with multi-category scoring, mitigation tracking, and optional sync to product classification.

All endpoints are scoped under /catalog/spaces/{space_slug}/products/{product_id}/risk-assessments and require authentication.

Endpoints Overview

MethodEndpointDescription
POST.../risk-assessmentsCreate assessment
GET.../risk-assessmentsList assessments
GET.../risk-assessments/{id}Get assessment
PUT.../risk-assessments/{id}Update assessment
POST.../risk-assessments/{id}/completeComplete assessment
PATCH.../risk-assessments/{id}/mitigations/{mid}Update mitigation

Create Assessment

POST /catalog/spaces/{space_slug}/products/{product_id}/risk-assessments

Request Body

{
"assessment_type": "initial",
"lifecycle_stage": "development",
"evaluations": [
{
"category": "bias",
"severity": 3,
"likelihood": 2,
"impact": 4,
"notes": "Potential demographic bias in training data"
},
{
"category": "privacy",
"severity": 4,
"likelihood": 3,
"impact": 5,
"notes": "PII in feature pipeline"
}
],
"summary": "Initial risk assessment for customer scoring model",
"mitigations": [
{
"title": "Implement fairness metrics",
"category": "bias_mitigation",
"owner_name": "Alice",
"deadline": "2026-03-15",
"priority": "high"
}
]
}

Fields

FieldTypeRequiredDescription
assessment_typestringinitial, pre_deployment, periodic, incident
lifecycle_stagestringStage at time of assessment
evaluationsRiskEvaluation[]Category-level risk scores
summarystringAssessment summary
mitigationsMitigationAction[]Planned mitigation actions

RiskEvaluation

FieldTypeRangeDescription
categorystringbias, fairness, robustness, privacy, security, explainability
severityinteger1–5Severity score
likelihoodinteger1–5Likelihood score
impactinteger1–5Impact score
scoreintegerAuto-computed: severity × likelihood × impact
notesstringFree-form notes

List Assessments

GET /catalog/spaces/{space_slug}/products/{product_id}/risk-assessments

Query Parameters

ParameterTypeDefaultDescription
limitinteger20Max items (1–100)
offsetinteger0Pagination offset

Get Assessment

GET /catalog/spaces/{space_slug}/products/{product_id}/risk-assessments/{assessment_id}

Update Assessment

PUT /catalog/spaces/{space_slug}/products/{product_id}/risk-assessments/{assessment_id}

All fields are optional. Cannot update a completed assessment.


Complete Assessment

POST /catalog/spaces/{space_slug}/products/{product_id}/risk-assessments/{assessment_id}/complete

Marks the assessment as completed and computes the final risk tier.

Request Body

{
"risk_tier": "high",
"sync_to_product": true
}
FieldTypeDefaultDescription
risk_tierstringauto-derivedOverride: unacceptable, high, limited, minimal
sync_to_productboolfalseUpdate the product's risk_classification

Risk Tier Thresholds (Auto-Derived)

TierScore Range
unacceptable≥ 80
high≥ 50
limited≥ 25
minimal< 25

Overall score = average of (severity × likelihood × impact) across categories, normalised to 0–100.


Update Mitigation

PATCH /catalog/spaces/{space_slug}/products/{product_id}/risk-assessments/{assessment_id}/mitigations/{mitigation_id}

Update a single mitigation action within an assessment.

Request Body

{
"status": "in_progress",
"evidence": ["https://jira.example.com/PROJ-123"],
"linked_issue_id": "uuid"
}
FieldTypeDescription
statusstringpending, in_progress, completed, cancelled
evidencestring[]References (links, issue IDs)
linked_issue_idUUIDLink to platform issue/ticket
owner_idUUIDReassign owner
owner_namestringUpdated owner display name
deadlinestringISO 8601 date
prioritystringlow, medium, high, critical

Response Model

RiskAssessmentResponse

FieldTypeDescription
idUUIDAssessment identifier
product_idUUIDAssessed product
space_idUUIDSpace scope
assessment_typestringType of assessment
lifecycle_stagestring | nullLifecycle stage
statusstringdraft, completed
evaluationsobject[]Category evaluations
overall_risk_scoreinteger | nullComputed 0–100 score
risk_tierstring | nullDerived or overridden tier
summarystring | nullSummary text
mitigationsobject[] | nullMitigation actions
assessed_by_idUUIDUser who created the assessment
assessed_atdatetimeAssessment timestamp
reviewed_by_idUUID | nullReviewer (if reviewed)
reviewed_atdatetime | nullReview timestamp
created_atdatetimeCreation timestamp
updated_atdatetimeLast update

MitigationAction

FieldTypeDescription
idstringAuto-generated UUID
titlestringAction description
categorystringbias_mitigation, retraining, robustness_testing, privacy_enhancement, explainability, monitoring_improvement, process_change, other
statusstringpending, in_progress, completed, cancelled
prioritystringlow, medium, high, critical
owner_idUUIDResponsible user
owner_namestringDisplay name
deadlinestringTarget date
evidencestring[]Evidence references
linked_issue_idUUIDLinked platform issue