Party routes: screen · StartupBuilder

Reference for Party, one group of Party routes.

Party.screen

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

Text

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

Path: party. Body, as JSON: the other inputs. Emits Party.screened.

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

Terminal

curl -X POST https://api.sb/leaseline.app/parties/party_hmQWaPrAyZ/screen \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

JSON

{
  "api": "https://api.sb/leaseline.app",
  "screening": {
    "$id": "https://api.sb/leaseline.app/screenings/screening_oSWMvQUeCH",
    "$type": "Screening",
    "lists": {},
    "outcome": "clear",
    "via": "platform"
  },
  "party": {
    "$id": "https://api.sb/leaseline.app/parties/party_hmQWaPrAyZ",
    "$type": "Party",
    "name": "Leaseline"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Party.screen",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Party.screenCopy Anchor Link

Party.screen