Screening model

A subject represents the person being screened. A screening run processes that subject’s information. Results and the downloadable report are separate outputs.

Your organization’s service configuration determines the workflow. An API developer does not choose a different workflow for each request. Confirm whether your organization has Analyst Assistance with your Ferretly contact.

Analyst Assistance

Your integration creates and assigns subjects. Ferretly analysts manage identity resolution, the screening workflow and review. Use callbacks to receive processing and reviewed-completion updates.

Do not call initiateBackgroundCheck with Analyst Assistance

Analyst Assistance integrations must not call initiateBackgroundCheck. Follow the analyst-managed workflow, including when investigating an unexpected status or a report that is not ready.

• Add a subject with Analyst Assistance
• Analyst Assistance status callbacks and Mermaid flow

Without Analyst Assistance

Use the separate screening lifecycle and status callback flow for organizations without Analyst Assistance. The prerequisites and integration responsibilities differ from the analyst-managed path.

Results and reports

Creating a subject does not mean the workflow is complete. Retain the returned id and your externalSystemId, consume completion callbacks, then retrieve results and reports. Report readiness can differ from workflow completion.

Preference profiles and recurring screening

A subject can specify preferencesProfile by name or UUID. See Preference profiles for read/write models and the permission required for changes.

Continuous screening requires the appropriate organization subscription and add-ons. Confirm recurring-screening configuration with Ferretly before enabling it.