Skip to main content
GET
Get resolve parent result
Poll this endpoint to check the status and retrieve the result of a parent hierarchy resolution job.

Status lifecycle

Jobs progress linearly to a terminal state:
Once a job reaches completed or failed, the status does not change.

Result structure

When status is completed, the record field contains the parent hierarchy data with parent, top_parent, top_operating_parent (conditionally present), and regional_subsidiary. For pending or processing jobs, only status is returned. For failed jobs, record is absent and error_message with error_type are present instead.

Example

curl
Response (200) — completed, parent found
Response (200) — completed, no parent (standalone entity)
Response (200) — pending
Response (200) — failed

Response fields

record.parent

object | null — The immediate parent entity. null when the entity has no parent (standalone).

record.top_parent

object | null — The ultimate parent entity at the top of the corporate hierarchy. For standalone entities, top_parent points to the entity itself and parent is null. Has the same fields as parent except it does not include reasoning (only confidence).

record.top_operating_parent

object | null — The topmost operating company (excluding HoldCo/investment vehicles) found by looking up the corporate hierarchy from the queried entity. This field is conditionally present:
  • Present when the entity is an operating company or when an operating company is found above it in the hierarchy
  • Omitted for standalone entities that are not operating companies (e.g. HoldCos with no tree)
When present, the value is null if no operating company exists in the upward chain (e.g. a HoldCo whose entire parent chain consists of other HoldCos). Has the same fields as top_parent (no reasoning, includes confidence).

record.regional_subsidiary

object — Whether the queried entity operates as a regional subsidiary of its parent.

Polling guidance

  • Use exponential backoff between polls (start at 2 seconds, cap at 30 seconds).
  • Jobs that do not exist yet (or whose ID is unknown) return { "status": "pending" }.

Authorizations

x-api-key
string
header
required

Include your API key in the x-api-key header.

Path Parameters

job_id
string
required

Job ID returned by the POST endpoint

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Response

Job status response

status
enum<string>
required

Current status of the job. Terminal states are completed and failed.

Available options:
pending,
processing,
completed,
failed
id
string

Unique identifier for the job. Present when status is pending, processing, or completed.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

jobid
string

Unique identifier for the job. Present only when status is failed.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

created_at
string<date-time>

ISO 8601 timestamp when the job was created.

Example:

"2025-06-05T12:00:00Z"

completed_at
string<date-time>

ISO 8601 timestamp when the job reached a terminal state.

Example:

"2025-06-05T12:00:05Z"

record
object

Parent hierarchy data. Present when status is completed.

error_message
string

Error message. Present when status is failed.

error_type
string

Machine-readable error type. Present when status is failed. One of: kernel_id_not_found, unknown.