HEherondata
Clear

Download the stored Risk Inform response as XML

Changed on

Returns the vendor's XML for the stored result, unaltered.

get/api/admin/clear/risk-inform/raw

Request

  • Base URL
    https://app.herondata.io
  • URL
    https://app.herondata.io/api/admin/clear/risk-inform/raw
  • 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.

Response

OK

file_b64string required

The stored XML, base64-encoded

filenamestring required

Suggested download filename

mime_typestring required

Media type of the encoded bytes

Changes