GeneralSettings

Properties

Property	Type	Required	Description
email_me	boolean	No	Indicates whether to send background check status change emails to the user specified in NotificationEmailAddress
notificationEmailAddress	string	No	Nullable.
email_subject_owner_on_completion	boolean	No	When true, causes emails to be sent only upon mark redressed for organizations with Analyst Assistance, or upon run complete w/o Analyst Assistance.
is_flagged	boolean	No
is_negative	boolean	No
is_positive	boolean	No
hide_logos	boolean	No
includeHelpPagesOnBackgroundReport	boolean	No
includeHyperlinksInReports	boolean	No
include_web_news_posts	boolean	No	If true, a news/web search will be performed for the subject, and results will be added as new posts
minimum_web_post_confidence_level	string	No	String representation of MinimumWebPostConfidenceLevel, because of inconsistency in the way enums are serialized in the API Nullable.
include_fcra	boolean	No	Boolean to indicate whether FCRA warnings and disclaimers are shown, and to control number of years of posts to fetch
isFCRAYearsOverriden	boolean	No	When set to true, allows for AlternativeNumberOfYearsForPosts to specify number of years of posts to fetch
alternativeNumberOfYearsForPosts	integer (int32)	No	If IsFCRAYearsOverriden is true, number of years of posts to retrieve Nullable.
anonymizeProfilePictureInReports	boolean	No
includePostInsightsInReports	boolean	No
basicInsightsIsOnePage	boolean	No
report_background_color	string	No	Background color for the report. Nullable.
hideSentimentOnReports	boolean	No	If true then don’t display sentiment icon on posts pages in reports
useAlternateDisclaimerText	boolean	No	A boolean to indicate whether the organization’s “Alternate Disclaimer Text” should be used in the report
showZeroScoreWhenNoHandles	boolean	No	“Show Score as 0 when no handles”
excludeHandleBiosOnCoverPage	boolean	No	“Exclude Handle Bio’s on cover page”
excludeScoreOnPostsInsights	boolean	No	“Exclude score on post insights”
isPrinterFriendlyReport	boolean	No	Boolean to indicate that the report style should be “printer friendly”
reportAnalyticsSections	ReportAnalyticsSections	No
includeAbstract	boolean	No
excludeFlaggedPostSummary	boolean	No
postTypesToAnalyze	array of string	No	A list of post types that will be analyzed in the report. This list is exclusionary: if it is not empty, then only the post types in this list will be analyzed. If the list is empty, all post types will be analyzed. Nullable.
showBehaviorIconsInReports	boolean	No	Gets or sets a value indicating whether to show behavior icons on reports.
redactNudeImagesInReports	boolean	No	Gets or sets a value indicating whether to redact nude images in reports.
group_posts_by	string	No	String representation of GroupPostsBy, because of inconsistency in the way enums are serialized in the API Nullable.
report_language_iso_code	string	No	Gets or sets a value indicating report language ISO code Nullable.
includePostTagsInReports	boolean	No	Boolean to indicate whether to include each post’s Tags in reports
hideSubjectProvidedPropertiesInReports	boolean	No	Boolean to indicate whether to hide section with subject provided properties in reports.
disableAutomaticAgenticSearch	boolean	No	If true, prevents automatic agentic AI profile search from being initiated when a subject is assigned to an analyst or when a background check is initiated.

Use only the documented fields.