Subject
Properties
Section titled “Properties”| Property | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | No | |
subscriberId | string (uuid) | No | The ID of the subscriber that added this subject or who currently “owns” it (see OwnerFirstName and OwnerLastName) |
ownerFirstName | string | No | First name of the subscriber that added this subject or who currently “owns” it Nullable. |
ownerLastName | string | No | Last name of the subscriber that added this subject or who currently “owns” it Nullable. |
ownerEmail | string | No | Email of the subscriber that added this subject or who currently “owns” it Nullable. |
ownerProfilePhotoUrl | string | No | Profile photo url of the subscriber that added this subject or who currently “owns” it Nullable. |
organizationId | string (uuid) | No | |
name | string | No | Nullable. |
nickname | string | No | Another name/alias property for the subject Nullable. |
handles | string | No | Nullable. |
handleList | array of SubjectHandle | No | Nullable. |
mostRecentRunId | string (uuid) | No | Nullable. |
dateAdded | string (date-time) | No | Nullable. |
subjectAddedAuditInfo | AuditInfo | No | |
profilePicUrl | string | No | Nullable. |
lastRunDate | string (date-time) | No | Represents the date/time that the most recent run completed Nullable. |
score | integer (int32) | No | Nullable. |
status | SubjectStatus | No | |
lastRunStatus | RunStatusEnum | No | |
lastRunStatusMessage | string | No | Nullable. |
lastRunFinishedScraping | string (date-time) | No | Nullable. |
currentRunStarted | string (date-time) | No | Nullable. |
currentBackgroundCheckStartedBy | string | No | Nullable. |
currentRunStatus | RunStatusEnum | No | |
currentRunId | string (uuid) | No | Nullable. |
backgroundReportFileName | string | No | Gets and sets the name of a newly-generated background report file. Also sets IsBackgroundReportStale to false. Nullable. |
isBackgroundReportStale | boolean | No | A Boolean to indicate that there have been data changes which cause the current background report file to be outdated |
address | string | No | Nullable. |
city | string | No | Nullable. |
state | string | No | Nullable. |
country | string | No | Nullable. |
coordinates | GeoLocation | No | |
email | string | No | Nullable. |
highSchool | string | No | Nullable. |
college | string | No | Nullable. |
company | string | No | Nullable. |
phoneNumber | string | No | Nullable. |
twitterUrl | string | No | Nullable. |
facebookUrl | string | No | Nullable. |
instagramUrl | string | No | Nullable. |
linkedInUrl | string | No | Nullable. |
tiktokUrl | string | No | Nullable. |
redditUrl | string | No | Nullable. |
pinterestUrl | string | No | Nullable. |
youtubeUrl | string | No | Nullable. |
tags | array of string | No | Nullable. |
riskMakeups | array of RiskMakeup | No | Nullable. |
channelVolumes | array of ChannelVolume | No | Nullable. |
isRedressed | boolean | No | |
lastMarkAsRedressedOn | string (date-time) | No | Nullable. |
lastMarkedAsRedressedBy | string (uuid) | No | Nullable. |
lastMarkedAsRedressedEmail | string | No | Nullable. |
lastMarkedAsRedressedName | string | No | Nullable. |
lastMarkedAsRedressedAuditInfo | AuditInfo | No | |
totalPosts | integer (int32) | No | Note that this does not include WebSearch posts Read-only response field. |
flaggedPosts | integer (int32) | No | |
totalSentiment | number (double) | No | |
webSearchPosts | integer (int32) | No | |
sanctionsSearchPosts | integer (int32) | No | |
hasAvailablePosts | boolean | No | Read-only response field. |
isBackgroundCheckInProgress | boolean | No | Read-only response field. |
preferencesProfileID | string (uuid) | No | The ID of the OrganizationPreferencesProfile used in background checks Nullable. |
isEnabledForContinuousScreening | boolean | No | Boolean to indicate whether this subject is enabled for continuous screening |
subscriberEnablingContinuousScreening | string (uuid) | No | Nullable. |
continuousScreeningPreferences | OrganizationPreferencesProfile | No | |
continuousScreeningInterval | ContinuousScreeningInterval | No | |
continuousScreeningHourBucket | integer (int32) | No | Round-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. |
continuousScreeningNotificationEmail | string | No | Nullable. |
continuousScreeningLastCreditChargedAt | string (date-time) | No | The 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. |
supplementaryDocumentBlobName | string | No | Nullable. |
supplementaryDocumentFilename | string | No | Nullable. |
supplementaryDocumentContentType | string | No | Nullable. |
previousRunDate | string (date-time) | No | Nullable. |
nextScreeningDate | string (date-time) | No | Nullable. |
originalScreeningDate | string (date-time) | No | Nullable. |
isAssignedToFerretlyAnalyst | boolean | No | |
dateAssignedToAnalyst | string (date-time) | No | Nullable. |
assignedToAnalystAuditInfo | AuditInfo | No | |
assignedAnalystId | string (uuid) | No | Gets and sets the ID of the analyst assigned to this subject Nullable. |
slaTimeInHours | integer (int32) | No | Gets or sets the number of hours that was used for calculating SLA expiration time. Nullable. |
slaExpirationTime | string (date-time) | No | Gets and sets the date/time when the SLA expires. Nullable. |
turnAroundTimeInHours | number (double) | No | Gets and sets the turn-around, in hours, for this subject. The calculation is performed differently for subjects assigned to an analyst than otherwise. Nullable. |
ageOrDateOfBirth | string | No | Nullable. |
isExternalApiSubject | boolean | No | Indicates whether the subject was created via the external API |
externalSystemId | string | No | An identifier for the subject as it’s known to the external system Nullable. |
isPostMigrationScheduled | boolean | No | |
areSubjectProfilesReviewed | boolean | No | Indicates whether the subject’s profiles have been reviewed by Analyst after search |
runBGCheckAfterSearchIsFinished | boolean | No | If true, a background check will be automatically triggered after agentic search completes profile validation, provided the organization has no Analyst Assistance. |
notes | string | No | Notes about this subject. Free-form text. Nullable. |
lastUpdated | string (date-time) | No | Date/time of the last update to this subject Nullable. Read-only response field. |
lastUpdatedBy | string | No | The name of the person who last updated this subject Nullable. Read-only response field. |
lastUpdatedByEmail | string | No | The email address of the person who last updated this subject Nullable. Read-only response field. |
lastUpdatedBySubscriberId | string (uuid) | No | The ID of the subscriber who last updated this subject Nullable. Read-only response field. |
lastUpdatedAuditInfo | AuditInfo | No | |
platformSearchStatuses | array of PlatformSearchStatus | No | Nullable. |
hasAgenticProfileSearch | boolean | No | True 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. |
postSummaryText | string | No | A string that represents AI-generated text that summarizes the subject’s most-recent flagged posts Nullable. |
oceanPersonalityTraits | OceanPersonalityTraits | No | |
partitionKey | string | No | Nullable. |
rowKey | string | No | Nullable. |
timestamp | string (date-time) | No | Nullable. |
eTag | ETag | No |
Use only the documented fields.