Skip to main content
GET
Get Review Report

Headers

authorization
string | null
X-Api-Key
string | null

Path Parameters

review_id
string<uuid>
required

Response

Successful Response

The customer-facing report for a completed review.

Only available once the review is completed (i.e. the internal publication gate has released the case). Before that, the report endpoint returns 404 so verdict-adjacent signal never leaks early.

generated_at
string<date-time>
required
review_id
string<uuid>
required
status
enum<string>
required

Customer-facing review lifecycle.

A deliberately coarse projection of the internal CaseStatus. Internal states that are not meaningful to a customer (e.g. the admin-release gate pending_review, the publication-blocker state) collapse to processing so we never surface internal workflow detail or verdict-adjacent signal before the publication gate passes.

Available options:
queued,
awaiting_documents,
processing,
completed,
failed
summary
IssueCounts · object
required

Roll-up of issue counts by severity.

Example:
issues
ReviewIssue · object[]
outcome
string | null

Overall outcome, e.g. 'clear' or 'issues_found'.

Example:

"issues_found"

report_pdf_expires_at
string<date-time> | null

Expiry timestamp for report_pdf_url.

report_pdf_url
string | null

Fresh, short-lived download URL for the current released report PDF. Request this report endpoint again after an amendment or after expiry.

sandbox
boolean
default:false

True for sandbox (test-mode) reviews: the issues below are canned sample data.