# Party routes: screen

URL: /code/api/party/verbs · Id: `page:code/api/party/verbs`

> The Party Verbs screen as api.sb routes, with inputs, result, refusals and an example.

Reference for [Party](/business/nouns/party), one group of [Party routes](/code/api/party).

### Party.screen
Screen checks a Party against official registers and restricted-party lists and keeps the result as a Screening. [Verb page](/business/nouns/party/screen?interface=api).

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

Path: `party`. Body, as JSON: the other inputs. Emits [`Party.screened`](/business/events/Party.screened).

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `party` | [Party](/business/nouns/party) | Yes | The Party to check: a Customer, Supplier, Partner or the Company’s own owners. |
| `markets` | list of [Market](/business/nouns/market) | No | The Markets whose lists apply. Defaults to the Party’s and the Startup’s Markets. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `screening` | [Screening](/business/nouns/screening) | Yes | The Screening, with the lists checked, their versions, any matches and the outcome. |
| `party` | [Party](/business/nouns/party) | Yes | The Party screened. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

```bash
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"
  }
}
```