---
title: "Screen a counterparty"
method: GET
path: "/api/v2/screening/match"
tags: ["Screening and Reference"]
---

# Screen a counterparty

`GET /api/v2/screening/match`

Screen a counterparty NAME (or strong id) against restricted-party lists; returns resolved matches with evidence, programmes, dates, and ownership-chain exposure. Risk signal, not a compliance determination. Requires a plan with Restricted-party screening access (`can_use_screening`) — the Corporate & Supply Chain plan and above.

## Query parameters

- `q` string
- `id` string
- `as_of` string
- `threshold` number
- `limit` integer

## Response `200`

Screen a counterparty.

- object
  - `success` boolean
  - `query` object
    - `q` string
    - `id` unknown
    - `as_of` string
    - `threshold` number
  - `disclaimer` string
  - `coverage` string
  - `match_count` integer
  - `matches` object[]
    - `entity_id` string
    - `name` string
    - `score` number
    - `confidence` string
    - `method` string
    - `lists` object[]
      - `source_key` string
      - `entry_uid` string
      - `name` string
      - `entity_kind` string
      - `country_iso3` string
      - `programs` string[]
      - `legal_basis` string
      - `source_url` string
      - `ids` object
        - `ticker` string
      - `first_seen_date` string
      - `last_seen_date` string
      - `match_score` number
    - `exposure` object
      - `lenses` string[]
      - `direct` boolean
      - `lists` string[]
      - `china_edges` string[]

## Other responses

- `401` — Missing/invalid API key
- `403` — Plan required (PLAN_REQUIRED) — the caller's plan does not carry the required source entitlement.
- `500` — Server error

---

[API](https://skmtc.net/gdeltcloud/apis/gdelt-cloud-api-v2.md) · [All operations](https://skmtc.net/gdeltcloud/apis/gdelt-cloud-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gdeltcloud/gdelt-cloud-api-v2/versions/01aaa6255180/schema)