---
title: "Read a stored Risk Inform result"
method: GET
path: "/api/admin/clear/risk-inform"
tags: ["Clear"]
---

# Read a stored Risk Inform result

`GET /api/admin/clear/risk-inform`

## Request

- Base URL: `https://app.herondata.io`
- URL: `https://app.herondata.io/api/admin/clear/risk-inform`
- Auth: API key in header `x-api-key`

Returns the Risk Inform result stored for an end user, entity and definition, and with `include=document` the stored response rendered whole as JSON. Reads storage only: Thomson Reuters is never called and nothing is charged.

## Query parameters

- `end_user_heron_id` string, required
- `subject_type` 'business' | 'person', required
- `entity_id` string, required
- `definition_name` string, required
- `definition_version` string
- `include` 'document'

## Response `200`

The stored result, and the rendered document when it was asked for.

- object
  - `cost` number, required: Always zero, this route cannot charge
  - `document` object: Present only when `include=document` was passed
    - `byte_size` integer: Size of the stored XML
    - `element_count` integer: Elements in the stored XML
    - `root` object: The document, one node per element
    - `state` 'parsed' | 'unparseable' | 'absent', required: Whether the stored response could be rendered as JSON
  - `group_count` integer, required: Entities on the scored page
  - `results` object, required: The scored entities and the vendor status
  - `score_state` 'present' | 'absent' | 'unreadable', required: Whether a score is stored. `absent` means nothing is stored for this end user, entity and definition; `unreadable` means a response is stored but no score could be parsed from it.

## Other responses

- `404`: No such end user

## Changes

- **2026-11-03** `bd8008e49534`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/herondata/apis/heron-data-api/changes/api/admin/clear/risk-inform/get.md)

---

[API](https://skmtc.dev/herondata/apis/heron-data-api.md) - [All operations](https://skmtc.dev/herondata/apis/heron-data-api/llms.txt) - [OpenAPI document](https://skmtc.dev/herondata/apis/heron-data-api/revisions/1ec936e17fef?raw)