Party programs: screen · StartupBuilder

Reference for Party, one group of Party programs.

Party.screen

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

Text

do: return await $.Party.screen(input)

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.

Returns

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.

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.	None.

Example

JSON

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