API reference

Use this reference to look up requests, parameters, and response schemas. Follow the workflow configured for your organization: with Analyst Assistance or without Analyst Assistance. Analyst Assistance integrations must not call initiateBackgroundCheck.

Base URL: https://api.ferretly.com
Authentication: X-Api-Key request header

Download OpenAPI · Download Postman collection · Authentication guide

API client

Method	Endpoint	Purpose
GET	/api/ApiClient	Verify your API key
POST	/api/ApiClient/updateWebHook	Set the webhook URL
GET	/api/ApiClient/refreshApiKey	Rotate the API key
GET	/api/ApiClient/getOrganization	Get your organization
POST	/api/ApiClient/updateClientSpecificProperties	Update client properties
POST	/api/ApiClient/updateTechnicalContact	Update the technical contact

Subjects

Method	Endpoint	Purpose
GET	/api/Subjects	List subjects
POST	/api/Subjects	Create a subject
GET	/api/Subjects/{subjectId}	Get a subject
GET	/api/Subjects/getByExternalId/{externalId}	Get a subject by external ID
GET	/api/Subjects/{subjectId}/screeningstatus	Get screening status
GET	/api/Subjects/{externalId}/screeningStatusByExternalId	Get status by external ID
GET	/api/Subjects/{subjectId}/backgroundCheckResults	Get screening results
GET	/api/Subjects/getByExternalId/{externalId}/backgroundCheckResults	Get results by external ID
GET	/api/Subjects/{subjectId}/initiateBackgroundCheck	Start a screening (without Analyst Assistance)
GET	/api/Subjects/{subjectId}/filteredPosts	Get filtered posts
GET	/api/Subjects/{externalId}/filteredPostsByExternalId	Get filtered posts by external ID
GET	/api/Subjects/{subjectId}/downloadBackgroundReport	Download a report

Preference profiles

Method	Endpoint	Purpose
GET	/api/PreferenceProfiles/behavior-categories	List behavior categories
GET	/api/PreferenceProfiles	List preference profiles
POST	/api/PreferenceProfiles	Create a preference profile
GET	/api/PreferenceProfiles/{id}	Get a preference profile
PUT	/api/PreferenceProfiles/{id}	Update a preference profile
DELETE	/api/PreferenceProfiles/{id}	Delete a preference profile

Health

Method	Endpoint	Purpose
GET	/api/Health/settings	Check API health and settings

Schemas

• AffiliateInfo
• ApiClient
• ApiClientWithApiKey
• ApiSubjectHandle
• AppSettings
• AuditInfo
• BackgroundCheckResults
• BackgroundCheckStatus
• BehaviorSource
• CandidateProfileModel
• CandidateProfileSource
• ChannelVolume
• ContinuousScreeningInterval
• Coordinates
• DataRetentionPeriod
• EditSubject
• ETag
• FlagInfo
• GeneralSettings
• GeoLocation
• HandleSource
• HandleStatus
• IElasticSearchSettings
• ImageMatchType
• ITableNames
• Keyword
• KeyWords
• KeywordType
• MediaItem
• NewSubject
• NewSubjectContinuousScreening
• OceanPersonalityTraits
• Organization
• OrganizationPreferencesProfile
• OrganizationRiskCategory
• PaymentMethod
• PlanType
• Platform
• PlatformSearchStatus
• Post
• PostDateFilter
• PostType
• PostTypeFilter
• PreferenceProfile
• PreferenceProfileBehaviorCategory
• PreferenceProfileUpsert
• PricingModel
• ProfileIdentifiers
• ReportAnalyticsSections
• RiskMakeup
• RiskType
• RunStatusEnum
• SearchPlatform
• SearchStatusEnum
• SentimentFlag
• Subject
• SubjectHandle
• SubjectStatus
• UploadSubjectDocument