Screening

A screening hit is a potential match against an application’s entities — a sanctions listing, PEP (politically exposed person) record, adverse-media article, or watchlist warning. Your team reviews each hit and records a decision.

Hit types and statuses

type	Match against
SANCTIONS	Sanctions lists
PEP	Politically exposed persons
ADVERSE_MEDIA	Negative news / media
WARNING	Watchlist and other warnings

A hit’s review status moves through the values below. New hits start NOT_REVIEWED.

status	Meaning
NOT_REVIEWED	Awaiting review (default)
IN_REVIEW	Under review
TRUE_MATCH / CONFIRMED	Confirmed as a real match
FALSE_POSITIVE / DISMISSED	Determined not to be a match

Working with hits

• GET /screening/hits?applicationId=… returns the application’s hits grouped into sanctions, pep, adverseMedia, and warning arrays.
• PATCH /screening/hits/{hitId} records a review decision — the new status, an optional note, and an optional severity tier. Updating a hit re-triggers risk calculation.
• POST /screening/hits creates a manual hit — a match your team adds directly (rather than one surfaced by a provider), from a title, type, status, and optional source details.

The screening/individuals/{id} and screening/businesses/{id} endpoints (and their /summary variants) let you correct the screened entity’s details or record a written summary.

Example

# List an application's hits, grouped by type
curl "https://api.getsteward.ai/api/v1/screening/hits?applicationId={id}" \
  -H "Authorization: Bearer stw_live_your_api_key_here"

# Record a review decision on a hit
curl -X PATCH https://api.getsteward.ai/api/v1/screening/hits/{hitId} \
  -H "Authorization: Bearer stw_live_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{ "status": "FALSE_POSITIVE", "note": "Different date of birth" }'

Environment: Examples use Production (https://api.getsteward.ai) with an stw_live_… key. For Sandbox, use https://api.steward-sandbox.com with an stw_test_… key.