> ## Documentation Index > Fetch the complete documentation index at: https://docs.gdeltcloud.com/llms.txt > Use this file to discover all available pages before exploring further. # Screen a counterparty > 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. ## OpenAPI ````yaml /api-reference/openapi-v2.json get /api/v2/screening/match openapi: 3.0.3 info: title: GDELT Cloud API v2 version: 2.0.0 description: >- Clean v2 REST API for generated GDELT Cloud structured Events, clustered Stories, linked Entities, summaries, admin1 discovery, significance ranking, and paginated article evidence. Event significance is a family-scoped weighted blend, renormalized so every event family spans a true 0-1: each event's raw total is divided by the maximum its own family can reach (Conflict 1.00, CAMEO+ POLITICAL 0.90, other CAMEO+ domains 0.65). All events: Goldstein severity 0.25, article evidence 0.05, confidence 0.05. Conflict only: fatalities 0.55 (log-scaled by body count) and civilian targeting 0.10. CAMEO+ only: magnitude 0.20, systemic importance 0.15, propagation potential 0.10, market sensitivity 0.10. When magnitude is unmeasured its term AND its 0.20 weight are both dropped. The four CAMEO+ metrics are rubric scores produced by published formulas - ordinal ranking signals, not measurements, probabilities, or predicted price moves. goldstein_scale is one canonical public metric, populated for Conflict Events and CAMEO+ POLITICAL Events where meaningful. Story linked_event_count is a Story-to-Event link aggregate, not a distinct Event total. servers: - url: https://gdeltcloud.com description: Production - url: http://localhost:3000 description: Local development security: - ApiKeyAuth: [] tags: - name: Events description: Coded CAMEO+ / conflict events — search, fetch, and summarize. - name: Stories description: Clustered narratives (stories) and their articles. - name: Entities description: >- People & organizations — resolve a name to an entity, then fetch its profile and tone. - name: Geography description: Admin-1 geography lookups. - name: Energy description: Global Energy Monitor assets + ownership registry. - name: Facilities description: >- Unified physical-asset directory — GEM energy assets + World Port Index ports + Epoch AI data centers on one keyed surface, resolved to spine owners. Plan-gated (Analyst plan and up). - name: Screening and Reference description: >- Restricted-party lists, screening, and ownership-chain exposure. Plan-gated (`can_use_screening` / `can_use_exposure`). - name: China description: >- China overseas development finance (AidData GCDF). Plan-gated (`can_use_china`). - name: Media Intelligence description: >- Entity tone (`can_use_tone`) and Share of Voice (`can_use_share_of_voice`) are plan-gated. Social signal remains an admin-only preview. - name: Filings description: >- SEC EDGAR filings, XBRL financials, and AI-extracted relations. Requires a plan with SEC filings access (`can_use_filings`) — the Corporate & Supply Chain plan and above. - name: Macro Finance description: >- FRED economic time series (catalog, point-in-time observations, releases). Plan-gated (`can_use_macro`). - name: Maritime description: >- AIS-derived vessel-flow signals across maritime chokepoints — chokepoint transits, last-known vessel positions, carriers, dwell, and AIS-dark gaps. Plan-gated (`can_use_maritime`). - name: Briefs description: Source-backed monitoring briefs. paths: /api/v2/screening/match: get: tags: - Screening and Reference summary: Screen a counterparty description: >- 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. operationId: screening-match-v2 parameters: - name: q in: query required: false schema: type: string description: Counterparty name to screen. - name: id in: query required: false schema: type: string description: Strong id (LEI / registration number) for an exact match. - name: as_of in: query required: false schema: type: string description: Screen against lists as of this date (YYYY-MM-DD). - name: threshold in: query required: false schema: type: number minimum: 0 maximum: 1 description: Minimum match score 0–1 (default 0.85). - name: limit in: query required: false schema: type: integer default: 25 description: Max matches. responses: '200': description: Screen a counterparty. content: application/json: schema: type: object properties: success: type: boolean query: type: object properties: q: type: string id: {} as_of: type: string threshold: type: number disclaimer: type: string coverage: type: string match_count: type: integer matches: type: array items: type: object properties: entity_id: type: string name: type: string score: type: number confidence: type: string method: type: string lists: type: array items: type: object properties: source_key: type: string entry_uid: type: string name: type: string entity_kind: type: string country_iso3: type: string programs: type: array items: type: string legal_basis: type: string source_url: type: string ids: type: object properties: ticker: type: string first_seen_date: type: string last_seen_date: type: string match_score: type: number exposure: type: object properties: lenses: type: array items: type: string direct: type: boolean lists: type: array items: type: string china_edges: type: array items: type: string examples: example: summary: GET /api/v2/screening/match — example response value: success: true query: q: Hikvision id: null as_of: '2026-06-29' threshold: 0.85 disclaimer: >- Risk-intelligence signal derived from public restricted-party lists and proprietary exposure data, as of the date shown. Not a sanctions-compliance determination or a substitute for due diligence. coverage: >- Public restricted-party lists ingested into ref.list_entries (institution-only). match_count: 1 matches: - entity_id: e_7c2a4f1b8e9d3056 name: Hangzhou Hikvision Digital Technology Co., Ltd. score: 0.972 confidence: strong method: fuzzy_name lists: - source_key: dod_1260h entry_uid: 1260h-2026-041 name: Hikvision Digital Technology Co., Ltd. entity_kind: entity country_iso3: CHN programs: - Section 1260H legal_basis: Section 1260H, NDAA FY2021 source_url: https://www.defense.gov/News/Releases/ ids: ticker: 002415.SZ first_seen_date: '2022-10-05' last_seen_date: '2026-06-29' match_score: 0.972 - source_key: fcc_covered entry_uid: fcc-2021-007 name: Hikvision Digital Technology Co., Ltd. entity_kind: entity country_iso3: CHN programs: - FCC Covered List legal_basis: >- Secure and Trusted Communications Networks Act of 2019 source_url: https://www.fcc.gov/supplychain/coveredlist ids: {} first_seen_date: '2021-03-12' last_seen_date: '2026-06-29' match_score: 0.948 exposure: lenses: - china - state_owned direct: true lists: - dod_1260h - fcc_covered china_edges: - list_1260h - gem_parent '401': description: Missing/invalid API key content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: >- Plan required (PLAN_REQUIRED) — the caller's plan does not carry the required source entitlement. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - ApiKeyAuth: [] components: schemas: ErrorResponse: type: object properties: success: type: boolean enum: - false error: type: string code: type: string details: type: object description: >- Recoverable validation context when available, such as param, invalid_value, accepted_values, nearest_values, and a corrected example. additionalProperties: true securitySchemes: ApiKeyAuth: type: http scheme: bearer bearerFormat: gdelt_sk_... description: 'GDELT Cloud API key. Send as `Authorization: Bearer gdelt_sk_...`.' ````