Screen a person or company name against sanctions, PEP and watchlists.
- Providers
- 0
- Calls, 30 days
- 0
- Lowest per hit
- n/a
Overview
Hit: A screening result is returned: candidate matches, or a clear result. Accuracy: Share of flagged matches confirmed on the source list.
No provider routes this capability through GridRouter yet.
Vendors that document it
3 vendors list sanctions and pep screening in their own API docs. Scores appear once calls are routed.
API
Same input for every provider. Set provider.sort to route by price, reliability or latency, or provider.only to pin vendors; X-Grid-Max-Cost caps what one call can spend.
| Input | Description |
|---|---|
| name* | Person or company name (required) |
| entity_type | person or company |
| country | ISO country code, to narrow matches |
curl https://api.gridrouter.io/v1/run/compliance.sanctions.screen \
-H "Authorization: Bearer $GRID_API_KEY" \
-H "Content-Type: application/json" \
-H "X-Grid-Max-Cost: 0.05" \
-d '{"input":{"name":"Northwind Holdings Ltd","entity_type":"company"},"provider":{"sort":"price"}}'Fields
The normalized output every provider maps into. Suppliers come from integrated endpoint mappings (verified) or field names in each vendor's API docs (vendor-claimed).
| Field | Type | PII | Description | Supplied by |
|---|---|---|---|---|
| name | string | Identifier | Name screened | Not mapped yet |
| entity_type | string | None | person or company | Not mapped yet |
| match_count | integer | None | Candidate matches returned | Not mapped yet |
| match_score | number | None | Best candidate's match score, 0 to 1 | Not mapped yet |
| matched_name | string | Identifier | Best candidate's name | Not mapped yet |
| lists | array<string> | None | Sanctions, PEP and watchlists with a match | Not mapped yet |
| sanctioned | boolean | Sensitive | A candidate is on a sanctions list | Not mapped yet |
| pep | boolean | Sensitive | A candidate is a politically exposed person | Not mapped yet |
| adverse_media | boolean | Sensitive | Adverse-media hits found | Not mapped yet |