Sustema

ENTITY developer reference

ICBundleRate

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.

bundle_id

Listed in this schema’s required array.

Declared type
"string"
Reading definition for bundle_id
{
  "type": "string",
  "minLength": 1,
  "maxLength": 120,
  "x-profile-maxLength": "string_characters_max"
}

standard_keys

Listed in this schema’s required array.

Declared type
"array"
Reading definition for standard_keys
{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "nace:rev2.1",
      "naics:us:2022"
    ],
    "x-profile-maxLength": "string_characters_max"
  },
  "minItems": 2,
  "maxItems": 2,
  "uniqueItems": true,
  "x-profile-maxItems": "collection_items_max"
}

both_successful_units

Listed in this schema’s required array.

Declared type
"string"
Reading definition for both_successful_units
{
  "type": "string",
  "pattern": "^(0|[1-9][0-9]*)$",
  "maxLength": 30,
  "x-profile-maxLength": "string_characters_max"
}

partial_rule

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for partial_rule
{
  "const": "qualifying_standard_only"
}

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": {
    "bundle_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120,
      "x-profile-maxLength": "string_characters_max"
    },
    "standard_keys": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "nace:rev2.1",
          "naics:us:2022"
        ],
        "x-profile-maxLength": "string_characters_max"
      },
      "minItems": 2,
      "maxItems": 2,
      "uniqueItems": true,
      "x-profile-maxItems": "collection_items_max"
    },
    "both_successful_units": {
      "type": "string",
      "pattern": "^(0|[1-9][0-9]*)$",
      "maxLength": 30,
      "x-profile-maxLength": "string_characters_max"
    },
    "partial_rule": {
      "const": "qualifying_standard_only"
    }
  },
  "required": [
    "bundle_id",
    "standard_keys",
    "both_successful_units",
    "partial_rule"
  ],
  "additionalProperties": false
}

All API operations