Skip to main content

Screening – Added

New V3 Entity endpoints are now available. These replace the existing V1/V2 entity endpoints and introduce two key improvements: support for multiple addresses per entity in SearchCriteria, and per-configuration-set targeting when toggling Ongoing Screening.

Additionally, the ConfigurationSetId field is now exposed in the Ongoing Screening results callback, enabling adapters to identify which configuration set a screening result belongs to.

New V3 Entity Endpoints​

Create Entities (V3)​

SearchCriteria now accepts a list of addresses (addresses) instead of a single address object. All other fields are unchanged from V2.

Update Entity (V3)​

Same SearchCriteria change as Create Entities — addresses is now a list.

Toggle Ongoing Screening (V3)​

The new endpoint replaces the V1/V2 PUT /api/entity/ongoingScreening endpoint. Note the HTTP method has changed from PUT to POST. The key addition is configurationSetId on each provider entry in the request. This field is mandatory for any provider configured to use the "Per Configuration Set" Ongoing Screening mode; it can be omitted when that mode is not in use.

Generate Ongoing Screening Report (V3)​

Replaces the V1/V2 POST /api/entity/ongoingScreening/generate-report endpoint. The route segment has been renamed to generate-ongoing-screening-report but the contract is otherwise unchanged — the same includeSearchCriteria query parameter is supported.

Updated: Ongoing Screening Results (ConfigurationSetId)​

The configurationSetId field is now included in the entity object returned in Ongoing Screening result callbacks sent to the Receptor. This field identifies the configuration set used for the screening. If not provided by the adapter, the provider's default configuration set is assumed.

Affected Endpoints​

  • POST /screeningcommand/api/v3/entity
  • PUT /screeningcommand/api/v3/entity/{entityId}
  • POST /screeningcommand/api/v3/entity/toggle-ongoing-screening
  • POST /screeningcommand/api/v3/entity/generate-ongoing-screening-report
  • POST /screeningreceptor/api/receptor (entity object in request body — configurationSetId added)