Sustema

ENTITY developer reference

Completeness

Candidate documentation for reading and synthetic examples. Account creation, live API access, SDKs, collections and MCP are not available here. A released service profile and matching integration instructions are required before use.

This is a documentation reading view of an unreleased candidate, not a downloadable replacement schema. Public wire names, types and constraints are retained except for the explicitly marked private-only subsets and route patterns. Private governance references are explained in public language. Use only a separately released, verified generation for clients. Read the explicit exclusions.

This is the public candidate schema reading view. Read it with the operation that uses it; a representable field does not establish enabled coverage or entitlement.

Declared type: "object"

Declared fields

This list shows only properties declared directly in this schema. Required labels refer only to this schema’s own required array. Referenced, composed and conditional rules can add constraints; a field not listed as required here is not guaranteed to be optional.

state

Listed in this schema’s required array.

Declared type
"string"
Reading definition for state
{
  "type": "string",
  "enum": [
    "complete_for_requested_scope",
    "incomplete",
    "unknown"
  ],
  "x-profile-maxLength": "string_characters_max"
}

scope

Listed in this schema’s required array.

Released population and bounded query scope; never the whole world's companies.

Declared type
"string"
Reading definition for scope
{
  "type": "string",
  "description": "Released population and bounded query scope; never the whole world's companies.",
  "x-profile-maxLength": "string_characters_max"
}

reasons

Listed in this schema’s required array.

Declared type
"array"
Reading definition for reasons
{
  "type": "array",
  "items": {
    "type": "string",
    "x-profile-maxLength": "string_characters_max"
  },
  "x-profile-maxItems": "collection_items_max"
}

Schema reading view

Read all retained constraints, including any allOf, oneOf, anyOf, conditional and additional-property constraints. The field list does not combine branches. Explicitly marked private-only omissions mean this view is not an executable substitute for the original schema or a released contract.

{
  "type": "object",
  "properties": {
    "state": {
      "type": "string",
      "enum": [
        "complete_for_requested_scope",
        "incomplete",
        "unknown"
      ],
      "x-profile-maxLength": "string_characters_max"
    },
    "scope": {
      "type": "string",
      "description": "Released population and bounded query scope; never the whole world's companies.",
      "x-profile-maxLength": "string_characters_max"
    },
    "reasons": {
      "type": "array",
      "items": {
        "type": "string",
        "x-profile-maxLength": "string_characters_max"
      },
      "x-profile-maxItems": "collection_items_max"
    }
  },
  "required": [
    "state",
    "scope",
    "reasons"
  ],
  "additionalProperties": false
}

All API operations