ENTITY developer reference
ICQuoteRequest
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.
IDs only; source URLs, raw customer files and unresolved names are outside this operation. Repeated IDs are deduplicated while retaining client references. Paid discovery is never performed just to quote.
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.
entities
Listed in this schema’s required array.
- Declared type
"array"
Reading definition for entities
{
"type": "array",
"items": {
"$ref": "#/components/schemas/ICInputEntity"
},
"minItems": 1,
"x-profile-maxItems": "quote_entities_max",
"maxItems": 1000
}targets
Listed in this schema’s required array.
- Declared type
"array"
Reading definition for targets
{
"type": "array",
"items": {
"$ref": "#/components/schemas/ICTarget"
},
"minItems": 1,
"maxItems": 2,
"x-profile-maxItems": "collection_items_max"
}offer
Listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for offer
{
"$ref": "#/components/schemas/ICVersionRef"
}pricing_choice
Listed in this schema’s required array.
- Declared type
"string"
Reading definition for pricing_choice
{
"type": "string",
"enum": [
"per_standard",
"prefer_bundle"
],
"x-profile-maxLength": "string_characters_max"
}research_mode
Listed in this schema’s required array.
- Declared type
"string"
Reading definition for research_mode
{
"type": "string",
"enum": [
"existing_only",
"held_or_known_site",
"bounded_discovery"
],
"x-profile-maxLength": "string_characters_max"
}latest_completion_at
Listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for latest_completion_at
{
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-profile-maxLength": "string_characters_max"
},
{
"type": "null"
}
]
}purpose
Not listed in this schema’s required array.
- Declared type
"string"
Reading definition for purpose
{
"type": "string",
"enum": [
"acquisition",
"refresh"
],
"default": "acquisition",
"x-profile-maxLength": "string_characters_max"
}freshness_policy
Not listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for freshness_policy
{
"anyOf": [
{
"$ref": "#/components/schemas/PolicyPin"
},
{
"type": "null"
}
]
}prior_acquisitions
Not listed in this schema’s required array.
- Declared type
"array"
Reading definition for prior_acquisitions
{
"type": "array",
"items": {
"$ref": "#/components/schemas/PriorAssessment"
},
"minItems": 0,
"x-profile-maxItems": "quote_entities_max",
"x-profile-factor": 2
}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": {
"entities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ICInputEntity"
},
"minItems": 1,
"x-profile-maxItems": "quote_entities_max",
"maxItems": 1000
},
"targets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ICTarget"
},
"minItems": 1,
"maxItems": 2,
"x-profile-maxItems": "collection_items_max"
},
"offer": {
"$ref": "#/components/schemas/ICVersionRef"
},
"pricing_choice": {
"type": "string",
"enum": [
"per_standard",
"prefer_bundle"
],
"x-profile-maxLength": "string_characters_max"
},
"research_mode": {
"type": "string",
"enum": [
"existing_only",
"held_or_known_site",
"bounded_discovery"
],
"x-profile-maxLength": "string_characters_max"
},
"latest_completion_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-profile-maxLength": "string_characters_max"
},
{
"type": "null"
}
]
},
"purpose": {
"type": "string",
"enum": [
"acquisition",
"refresh"
],
"default": "acquisition",
"x-profile-maxLength": "string_characters_max"
},
"freshness_policy": {
"anyOf": [
{
"$ref": "#/components/schemas/PolicyPin"
},
{
"type": "null"
}
]
},
"prior_acquisitions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PriorAssessment"
},
"minItems": 0,
"x-profile-maxItems": "quote_entities_max",
"x-profile-factor": 2
}
},
"required": [
"entities",
"targets",
"offer",
"pricing_choice",
"research_mode",
"latest_completion_at"
],
"additionalProperties": false,
"description": "IDs only; source URLs, raw customer files and unresolved names are outside this operation. Repeated IDs are deduplicated while retaining client references. Paid discovery is never performed just to quote.",
"allOf": [
{
"if": {
"properties": {
"purpose": {
"const": "refresh"
}
},
"required": [
"purpose"
]
},
"then": {
"required": [
"freshness_policy",
"prior_acquisitions"
],
"properties": {
"freshness_policy": {
"$ref": "#/components/schemas/PolicyPin"
},
"prior_acquisitions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PriorAssessment"
},
"minItems": 1,
"x-profile-maxItems": "quote_entities_max",
"x-profile-factor": 2
}
}
},
"else": {
"properties": {
"prior_acquisitions": {
"maxItems": 0
}
}
}
}
]
}