v5

latestOpenAPI 3.1.02026-08-0679357226.6 KB

riskAssessments

Retrieve a risk assessment

get/v1/businesses/{business_id}/risk_assessments/{id}

Path parameters

business_idstring required

Business ID

idstring required

Risk Assessment ID

Headers

Authorizationstring required

Bearer authentication

Response

risk assessment found

level'low' | 'moderate' | 'high' | 'not_available' required

Categorical risk verdict. not_available means a Risk order ran but could not produce a conclusive verdict. New values are not expected; level is a closed set.

object'risk_assessment' required

idstring uuid required

created_atstring date-time required

order_idstring uuid nullable required

The order this assessment was produced against — the snapshot coordinate. Fetch the business as of this order with GET /businesses/{id}?order_id={order_id} to compare the assessment against the underlying record. Null for assessments not tied to an order.

business_snapshot_urlstring uri nullable required

URL of the business as of this assessment's order (GET /businesses/{id}?order_id={order_id}), resolving to the per-order snapshot to compare against the assessment's results. Null for assessments not tied to an order.

titlestring nullable required

One-line headline synthesizing the assessment. Null on assessments produced before titles shipped.

description_markdownstring nullable required

Narrative explanation of the assessment, in CommonMark markdown. Null on assessments recorded before markdown narratives shipped.

scoreinteger nullable required

Overall risk score from 0 (lowest risk) to 100 (highest risk); level is banded from it. Null when the assessment could not be scored. Note the scale — the top-level score is a 0–100 integer, while nested dimension and identifier-assessment scores are 0–1 floats.