Skip to content

Screening

A Screening is one check of a Party against official registers and restricted-party lists, with each list’s version, any matches and the outcome.

Properties

PropertyTypeRequiredDescription
listsjsonrequiredEach register or list checked, with the version read, such as a sanctions list dated 2026-10-20.
matchesjsonEach entry that resembled the Party, with the list it came from and how closely it matched.
outcomestringrequiredclear lets money move; match holds pending Orders; review opens an Approval. Never randomized.
viastringrequiredplatform for a Startup-side screen; stripe for Stripe’s own verification result, recorded on the same Party.

Object

JSON
{
  "$id": "https://api.sb/quietcopy.com/screenings/screening_1",
  "$type": "Screening",
  "lists": {},
  "matches": {},
  "outcome": "clear",
  "via": "platform"
}

Relationships

  • A Screening screens one Party: a Party is screened before its first money move and again when its details change; every result stays. screens, inverse screenings.

Verbs

  1. getReturns one Screening by id.
    GET /{namespace}/screenings/{id}readNo Event
  2. listReturns Screenings, newest first, one page at a time.
    GET /{namespace}/screeningsreadNo Event

A Screening is kept forever and never edited: it has no update or delete.

Permissions

Which Access level may call each Verb. One-way Verbs wait their delay window.

Operationowneradminmemberviewer
Screening.getYesYesYesYes
Screening.listYesYesYesYes

Call it

Text
Show me the latest screening.

Example

A new buyer at a data marketplace places a $12,000 Order. The Screening checks three sanctions lists, finds no match, and records the outcome clear, so the charge proceeds.