RetailHardHat Developer docs

REST API documentation

Deal Risk Summary

Aggregated risk scores 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

frameworkIduuidOptionalframework Id
overallScorenumberOptionaloverall Score
riskRatingstringOptionalrisk Rating
statusstringOptionalstatus
isFinalizedbooleanOptionalis Finalized
categoryNotesjsonOptionalcategory Notes
categoryMitigationsjsonOptionalcategory Mitigations
overallNotesstringOptionaloverall Notes
overallMitigationsstringOptionaloverall Mitigations
categoryScoresSnapshotjsonOptionalcategory Scores Snapshot
topRiskDriversSnapshotjsonOptionaltop Risk Drivers Snapshot
lastAssessedAtdatetimeOptionallast Assessed At
lastAssessedBystringOptionallast Assessed By
finalizedAtdatetimeOptionalfinalized At
finalizedBystringOptionalfinalized By
createdAtdatetimeOptionalCreation timestamp (auto)
updatedAtdatetimeOptionalLast update timestamp (auto)