HEherondata
Clear

Read a stored Risk Inform result

Changed on

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.

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

Query parameters

end_user_heron_idstring required

The end user the result is stored under

subject_type'business' | 'person' required

Which CLEAR subject the entity id names

entity_idstring required

The resolved CLEAR entity that was scored

definition_namestring required

The Risk Inform definition the result was scored against

definition_versionstring

The definition version the result was scored against, if one was pinned. A result scored without a pinned version is stored under a different path.

include'document'

Pass document to add the stored response rendered whole as JSON

Response

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

costnumber required

Always zero, this route cannot charge

group_countinteger required

Entities on the scored page

resultsobject 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.

Changes