Clear

Score a resolved CLEAR entity with Risk Inform

Changed on

Scores the entity and stores the vendor's response under the end user. Always charges Thomson Reuters: nothing is read from storage first.

post/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

Request body

definition_namestring required
definition_versionstring
end_user_heron_idstring required

The end user the result is stored under

entity_idstring required
subject_type'business' | 'person' required

Response

The Risk Inform score, threshold and per-flag breakdown.

costnumber required

What this call cost

group_countinteger required

Entities on the scored page

resultsobject required

The scored entities and the vendor status

score_state'present' | 'absent' required

Whether a score was produced

Changes