KYB / API REFERENCE

Corporate tree · lite

Inspect the immediate group relationships available for a company.

GET/kyb/{id}/group-structures/liteOfficial reference

Parameters

idpath · integerRequired

Company ID returned by a company lookup. It is not the registration number.

include_provenancequery · booleanOptional

Include source metadata. Some endpoints also change their response structure.

Working with this response

With provenance enabled, the response becomes { data: [...], source: {...} }.
The reference labels group-structure provenance as Modelled. Retain that distinction; a modelled link is not the same as a verified ownership filing.

Response

200 · application/json

Illustrative default array excerpt. children holds nested relationships.

[
  {
    "id": 12345678,
    "name": "EXAMPLE LIMITED",
    "country": "GB",
    "registration_number": "GB 01234567",
    "selected": true,
    "children": []
  }
]

Request example

curl --fail-with-body --request GET 'https://api.globaldatabase.com/v2/kyb/YOUR_COMPANY_ID/group-structures/lite' \
  --header "Authorization: Token $GDB_API_KEY" \
  --header 'Accept: application/json'

Set GDB_API_KEY in your server environment. Replace YOUR_COMPANY_ID with the ID returned by your lookup. These examples are not executed by this page.