Skip to content

BackgroundCheckResults

PropertyTypeRequiredDescription
initiatedstring (date-time)NoWhen the background check was initiated
subjectIdstring (uuid)NoThe Ferretly subject ID
subjectExternalSystemIdstringNoThe subject’s external system ID (if provided). Nullable.
riskMakeupsarray of RiskMakeupNoRisk makeups: count of posts flagged for each risk Nullable. Read-only response field.
channelVolumesarray of ChannelVolumeNoCount of posts found per-platform Nullable.
flaggedPostsinteger (int32)NoCount of flagged posts
flagCountinteger (int32)NoTotal number of flags found in Not necessarily the same value as FlaggedPosts
totalPostsinteger (int32)NoCount of posts found Read-only response field.
webSearchPostsinteger (int32)NoCount of web search posts found
scoreinteger (int32)NoCalculated score
totalSentimentnumber (double)NoThe total sentiment (sum of sentiment from all posts)
finishedScrapingstring (date-time)NoWhen the post fetcher completed fetching the last post Nullable.
runStatusRunStatusEnumNo
isRedressedbooleanNoA boolean indicating whether this subject has been “marked as redressed”
lastMarkAsRedressedOnstring (date-time)NoThe most recent time the subject was “marked as redressed”. Will be null if the subject has not been “marked as redressed” Nullable.
postSummaryTextstringNoA string that represents AI-generated text that summarizes the subject’s most-recent flagged posts Nullable.

Use only the documented fields.