Skip to content

by Startups.Studio

Party.screen

POST /{namespace}/parties/{party}/screen

Screen checks a Party against official registers and restricted-party lists and keeps the result as a Screening.

Noun: Party
Mode: do
Event: Party.screened

You, to your agent

Screen the latest party.

curl -X POST https://api.sb/quietcopy.com/parties/party_1/screen \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const { screening, party } = await $.Party.screen({ party: 'party_1' })

npx startup-builder do Party.screen --json '{"party":"party_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Party.screen({ party: 'party_1' })"
  }
}

Inputs

Input	Type	Required	Description
`party`	Party	required	The Party to check: a Customer, Supplier, Partner or the Company’s own owners.
`markets`	list of Market		The Markets whose lists apply. Defaults to the Party’s and the Startup’s Markets.

Outputs

Output	Type	Required	Description
`screening`	Screening	required	The Screening, with the lists checked, their versions, any matches and the outcome.
`party`	Party	required	The Party screened.

Effects

Emits Party.screened.
Performed by the Risk Analyst.
Two-way: it runs at once, in the try, send and do modes.
Runs before the Party’s first money move and again when its details change.
A match holds the Party’s pending Orders and opens an Approval with the match attached.
Records Stripe’s own verification result as a Screening with via: stripe on the same Party.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	Party.screen

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.