RetailHardHat Developer docs

REST API documentation

Deal Risk Assessments

Individual risk factor assessments for deals

Supported operations

This resource provides field metadata only. No dedicated CRUD endpoint is advertised.

Field reference

Required means required by the underlying data model, not necessarily caller-supplied. The server derives protected identity and ownership fields; endpoint validation controls which fields are accepted. Sensitive credential fields are omitted here.

FieldTypeModel requirementDescription
idstringOptionalUnique identifier (auto-generated)
dealIduuidRequireddeal Id

Related resource: deals

factorIduuidRequiredfactor Id

Related resource: riskFactors

categoryIduuidOptionalcategory Id
scorenumberRequiredscore
rawValuestringOptionalraw Value
notesstringOptionalnotes
mitigationsstringOptionalmitigations
evidencejsonOptionalevidence
linkedObjectsjsonOptionallinked Objects
assessedBystringOptionalassessed By
assessedAtdatetimeOptionalassessed At
updatedAtdatetimeOptionalLast update timestamp (auto)