Skip to content

Party commands: screen

The Party Verbs screen as CLI commands, with inputs, result, refusals and an example.

Reference for Party, one group of Party commands.

Party.screen

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

Text
npx startup-builder do Party.screen --json '<input>' [--try | --send | --do]

Emits Party.screened.

Inputs

InputTypeRequiredDescription
partyPartyrequiredThe Party to check: a Customer, Supplier, Partner or the Company’s own owners.
marketslist of MarketThe Markets whose lists apply. Defaults to the Party’s and the Startup’s Markets.

Returns

OutputTypeRequiredDescription
screeningScreeningrequiredThe Screening, with the lists checked, their versions, any matches and the outcome.
partyPartyrequiredThe Party screened.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

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