> ## 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.

# GLEIF Level-2 relationships

> Parent/child relationship records as filed with the Global LEI System. `lei` matches EITHER endpoint. Note the direction convention in the source data: the start node is the CHILD and the end node is the PARENT. Corporate hierarchy as reported to the Global LEI System: accounting consolidation under IFRS/US-GAAP, not percentage ownership and not beneficial ownership. Natural persons are out of scope, and reporting is partial — an absent parent usually means the filer declared a reporting exception rather than that none exists. Plan-gated: requires the `can_use_gleif` entitlement (Analyst plan and up); non-entitled plans receive 403 PLAN_REQUIRED. Source: GLEIF Golden Copy, published under CC0 1.0. Every response carries `meta.attributions[]` with GLEIF's required non-endorsement notice.



## OpenAPI

````yaml /api-reference/openapi-v2.json get /api/v2/gleif/relationships
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/gleif/relationships:
    get:
      tags:
        - Reference Data
      summary: GLEIF Level-2 relationships
      description: >-
        Parent/child relationship records as filed with the Global LEI System.
        `lei` matches EITHER endpoint. Note the direction convention in the
        source data: the start node is the CHILD and the end node is the PARENT.
        Corporate hierarchy as reported to the Global LEI System: accounting
        consolidation under IFRS/US-GAAP, not percentage ownership and not
        beneficial ownership. Natural persons are out of scope, and reporting is
        partial — an absent parent usually means the filer declared a reporting
        exception rather than that none exists. Plan-gated: requires the
        `can_use_gleif` entitlement (Analyst plan and up); non-entitled plans
        receive 403 PLAN_REQUIRED. Source: GLEIF Golden Copy, published under
        CC0 1.0. Every response carries `meta.attributions[]` with GLEIF's
        required non-endorsement notice.
      operationId: get-gleif-relationships-v2
      parameters:
        - name: lei
          in: query
          required: false
          schema:
            type: string
          description: >-
            Match relationships where this LEI is either endpoint. Must pass the
            ISO 17442 check digit.
          example: 7LTWFZYICNSX8D621K86
        - name: relationship_type
          in: query
          required: false
          schema:
            type: string
          description: >-
            e.g. IS_DIRECTLY_CONSOLIDATED_BY, IS_ULTIMATELY_CONSOLIDATED_BY,
            IS_INTERNATIONAL_BRANCH_OF. Validated — 400 INVALID_ENUM otherwise.
          example: IS_DIRECTLY_CONSOLIDATED_BY
        - name: relationship_status
          in: query
          required: false
          schema:
            type: string
          description: ACTIVE or INACTIVE.
          example: ACTIVE
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 500
            default: 50
          description: Rows to return.
        - name: cursor
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
          description: Offset cursor.
      responses:
        '200':
          description: >-
            Relationship records with `pagination`, `applied_filters` and
            `meta`.
          content:
            application/json:
              schema:
                type: object
        '400':
          description: >-
            Invalid parameter — `code` is one of INVALID_LEI, INVALID_ENUM,
            INVALID_LIMIT or FILTER_REQUIRED, with `details.accepted_values`
            where an enum was rejected.
        '403':
          description: PLAN_REQUIRED — the caller's plan lacks `can_use_gleif`.
      security:
        - ApiKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: gdelt_sk_...
      description: 'GDELT Cloud API key. Send as `Authorization: Bearer gdelt_sk_...`.'

````