Middesk APIRisk Assessments

Retrieve a risk assessment

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

business_idstringRequired
Business ID
idstringRequired
Risk Assessment ID

Response

risk assessment found
business_snapshot_urlstring or nullformat: "uri"

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.

created_atdatetime
description_markdownstring or null
Narrative explanation of the assessment, in CommonMark markdown. Null on assessments recorded before markdown narratives shipped.
dimensionslist of objects

Per-dimension risk scores with their top contributing factors.

idstringformat: "uuid"
identifier_assessmentslist of objects

Risk assessments of the business’s individual identifiers (email address, phone number, website). Identifiers the order did not evaluate have no entry — absence means “not evaluated,” never “evaluated and clear.”

levelenum

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.

objectenum
order_idstring or nullformat: "uuid"

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.

scoreinteger or null0-100

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.

titlestring or null

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

Errors

403
Get Risk Assessment Request Forbidden Error
404
Get Risk Assessment Request Not Found Error