Skip to content

Subject

PropertyTypeRequiredDescription
idstring (uuid)No
subscriberIdstring (uuid)NoThe ID of the subscriber that added this subject or who currently “owns” it (see OwnerFirstName and OwnerLastName)
ownerFirstNamestringNoFirst name of the subscriber that added this subject or who currently “owns” it Nullable.
ownerLastNamestringNoLast name of the subscriber that added this subject or who currently “owns” it Nullable.
ownerEmailstringNoEmail of the subscriber that added this subject or who currently “owns” it Nullable.
ownerProfilePhotoUrlstringNoProfile photo url of the subscriber that added this subject or who currently “owns” it Nullable.
organizationIdstring (uuid)No
namestringNoNullable.
nicknamestringNoAnother name/alias property for the subject Nullable.
handlesstringNoNullable.
handleListarray of SubjectHandleNoNullable.
mostRecentRunIdstring (uuid)NoNullable.
dateAddedstring (date-time)NoNullable.
subjectAddedAuditInfoAuditInfoNo
profilePicUrlstringNoNullable.
lastRunDatestring (date-time)NoRepresents the date/time that the most recent run completed Nullable.
scoreinteger (int32)NoNullable.
statusSubjectStatusNo
lastRunStatusRunStatusEnumNo
lastRunStatusMessagestringNoNullable.
lastRunFinishedScrapingstring (date-time)NoNullable.
currentRunStartedstring (date-time)NoNullable.
currentBackgroundCheckStartedBystringNoNullable.
currentRunStatusRunStatusEnumNo
currentRunIdstring (uuid)NoNullable.
backgroundReportFileNamestringNoGets and sets the name of a newly-generated background report file. Also sets IsBackgroundReportStale to false. Nullable.
isBackgroundReportStalebooleanNoA Boolean to indicate that there have been data changes which cause the current background report file to be outdated
addressstringNoNullable.
citystringNoNullable.
statestringNoNullable.
countrystringNoNullable.
coordinatesGeoLocationNo
emailstringNoNullable.
highSchoolstringNoNullable.
collegestringNoNullable.
companystringNoNullable.
phoneNumberstringNoNullable.
twitterUrlstringNoNullable.
facebookUrlstringNoNullable.
instagramUrlstringNoNullable.
linkedInUrlstringNoNullable.
tiktokUrlstringNoNullable.
redditUrlstringNoNullable.
pinterestUrlstringNoNullable.
youtubeUrlstringNoNullable.
tagsarray of stringNoNullable.
riskMakeupsarray of RiskMakeupNoNullable.
channelVolumesarray of ChannelVolumeNoNullable.
isRedressedbooleanNo
lastMarkAsRedressedOnstring (date-time)NoNullable.
lastMarkedAsRedressedBystring (uuid)NoNullable.
lastMarkedAsRedressedEmailstringNoNullable.
lastMarkedAsRedressedNamestringNoNullable.
lastMarkedAsRedressedAuditInfoAuditInfoNo
totalPostsinteger (int32)NoNote that this does not include WebSearch posts Read-only response field.
flaggedPostsinteger (int32)No
totalSentimentnumber (double)No
webSearchPostsinteger (int32)No
sanctionsSearchPostsinteger (int32)No
hasAvailablePostsbooleanNoRead-only response field.
isBackgroundCheckInProgressbooleanNoRead-only response field.
preferencesProfileIDstring (uuid)NoThe ID of the OrganizationPreferencesProfile used in background checks Nullable.
isEnabledForContinuousScreeningbooleanNoBoolean to indicate whether this subject is enabled for continuous screening
subscriberEnablingContinuousScreeningstring (uuid)NoNullable.
continuousScreeningPreferencesOrganizationPreferencesProfileNo
continuousScreeningIntervalContinuousScreeningIntervalNo
continuousScreeningHourBucketinteger (int32)NoRound-robin hour-of-day bucket (0-23) this subject’s Daily-interval continuous screening run is assigned to. Only set when ContinuousScreeningInterval is Daily; null for Monthly+ subjects and when continuous screening is disabled. Nullable.
continuousScreeningNotificationEmailstringNoNullable.
continuousScreeningLastCreditChargedAtstring (date-time)NoThe date/time when a credit was last charged for a continuous screening background check for this subject. Used to determine whether a credit should be charged when a new continuous screening check is initiated (a charge is made if this is null or more than 12 months ago). Nullable.
supplementaryDocumentBlobNamestringNoNullable.
supplementaryDocumentFilenamestringNoNullable.
supplementaryDocumentContentTypestringNoNullable.
previousRunDatestring (date-time)NoNullable.
nextScreeningDatestring (date-time)NoNullable.
originalScreeningDatestring (date-time)NoNullable.
isAssignedToFerretlyAnalystbooleanNo
dateAssignedToAnalyststring (date-time)NoNullable.
assignedToAnalystAuditInfoAuditInfoNo
assignedAnalystIdstring (uuid)NoGets and sets the ID of the analyst assigned to this subject Nullable.
slaTimeInHoursinteger (int32)NoGets or sets the number of hours that was used for calculating SLA expiration time. Nullable.
slaExpirationTimestring (date-time)NoGets and sets the date/time when the SLA expires. Nullable.
turnAroundTimeInHoursnumber (double)NoGets and sets the turn-around, in hours, for this subject. The calculation is performed differently for subjects assigned to an analyst than otherwise. Nullable.
ageOrDateOfBirthstringNoNullable.
isExternalApiSubjectbooleanNoIndicates whether the subject was created via the external API
externalSystemIdstringNoAn identifier for the subject as it’s known to the external system Nullable.
isPostMigrationScheduledbooleanNo
areSubjectProfilesReviewedbooleanNoIndicates whether the subject’s profiles have been reviewed by Analyst after search
runBGCheckAfterSearchIsFinishedbooleanNoIf true, a background check will be automatically triggered after agentic search completes profile validation, provided the organization has no Analyst Assistance.
notesstringNoNotes about this subject. Free-form text. Nullable.
lastUpdatedstring (date-time)NoDate/time of the last update to this subject Nullable. Read-only response field.
lastUpdatedBystringNoThe name of the person who last updated this subject Nullable. Read-only response field.
lastUpdatedByEmailstringNoThe email address of the person who last updated this subject Nullable. Read-only response field.
lastUpdatedBySubscriberIdstring (uuid)NoThe ID of the subscriber who last updated this subject Nullable. Read-only response field.
lastUpdatedAuditInfoAuditInfoNo
platformSearchStatusesarray of PlatformSearchStatusNoNullable.
hasAgenticProfileSearchbooleanNoTrue if an Agentic Profile Search has been initiated for this subject at least once. A credit is charged on first initiation, so this indicates that credit has been paid and the first background check can be run without an additional charge. Read-only response field.
postSummaryTextstringNoA string that represents AI-generated text that summarizes the subject’s most-recent flagged posts Nullable.
oceanPersonalityTraitsOceanPersonalityTraitsNo
partitionKeystringNoNullable.
rowKeystringNoNullable.
timestampstring (date-time)NoNullable.
eTagETagNo

Use only the documented fields.