ENTITY developer reference
Read the original immutable quote
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.
GET /v1/classification-quotes/{quote_id}
Operation identifier: getClassificationQuote
Read the original immutable quote. All effects obey the classification acquisition, accounting, cancellation, correction and retention rules on this page and in the shared contract rules; current authority and rights are rechecked. At the class(a) cutoff in x-classification-retention, return resource_expired/410 under current authority; no stale body or expired reverse join. This pure owned read creates no new business effect or debit. Its failure reports only not_started/unchanged with null operation/status references. Existing underlying financial uncertainty is shown in the successful owned status envelope; unavailable read dependencies use the existing dependency_unavailable retry path. Never report a new reservation/settlement or invent a polling operation for this read. Original-resource disclosure: The caller must match both the exact original integration service principal and original integration in this workspace/environment, or the quote must already have been consumed by an order for which this service principal has its exact original owned order relation, with current quote/source permission. No human-steward exception; an unaccepted quote has no named delegation kind. Resolve authentication and exact same-workspace/environment owned relation before action-specific disclosure. Missing/foreign relation is the same opaque resource_not_found404. Only a proved owned relation may return an action-specific permission_denied403. No role or guessed identifier reveals another creator object; an entirely unauthenticated request remains unauthenticated401. Every current credential/action/profile/source/retention guard still applies. Non-retired suspension: A non-retired organisation security/financial suspension admits only the original authenticated integration service principal status/cancellation corridor below. Credential/session/principal revocation, compromised identity or retired binding has its own stricter denial and is never bypassed. Verify the original workspace/environment and integration service-principal identity before route-specific status/reduction. No data read, result/receipt body, new quote/order, funds or entitlement restoration. Token validity alone does not prove original relation. Current organisation suspension denies new work/result routes with existing entitlement_denied403, no reference and unchanged/not_started usage; invalid principal authority uses authority_revoked403. Unknown/foreign originals remain resource_not_found404 before an action-specific denial. Existing getClassificationOrder returns only its owned obligation envelope with items_path=null; cancellation preserves original cut-off and counters. General getOperation/getReceipt remain denied when they would expose result-bearing bodies; recovery uses the existing owned order route, never a new endpoint. This operation policy is denied_new_work_or_result.
Entity-Service-Profile carries the accepted profile_id; the endpoint pins its separate immutable revision. The retained template parameter description says “revision”; follow this current interpretation when reading that historical wording. No reserved example URL in the definitions is a live service destination.
Authentication
Apply the operation’s security requirement when present, otherwise the contract default below. These definitions do not provision access or qualify an authentication flow.
[
{
"bearerAuth": []
}
]Security scheme definitions
{
"bearerAuth": {
"type": "http",
"scheme": "bearer",
"description": "Validated OAuth access token, never an ID token. Issuer/audience/token endpoint and scope mapping are deployment-profile values. ENTITY current role, data and budget policy additionally applies."
}
}Request parameters
Headers, path and query parameters from the candidate contract. Operation-specific definitions take precedence over inherited definitions with the same name and location. Request body fields appear in the reading view below.
Entity-Service-Profile
header · Required
Accepted immutable service-profile revision; missing/unknown profiles cannot activate an operation.
Reading definition for Entity-Service-Profile
{
"name": "Entity-Service-Profile",
"in": "header",
"required": true,
"schema": {
"type": "string",
"maxLength": 4096,
"x-profile-maxLength": "string_characters_max"
},
"description": "Accepted immutable service-profile revision; missing/unknown profiles cannot activate an operation."
}quote_id
path · Required
Reading definition for quote_id
{
"name": "quote_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"maxLength": 36
}
}Request and response contract
The candidate operation is shown below with the declared documentation-only public-meaning projection. References open the corresponding public schema. No server URL or credential is supplied by this page.
{
"operationId": "getClassificationQuote",
"summary": "Read the original immutable quote",
"description": "Read the original immutable quote. All effects obey the classification acquisition, accounting, cancellation, correction and retention rules on this page and in the shared contract rules; current authority and rights are rechecked. At the class(a) cutoff in x-classification-retention, return resource_expired/410 under current authority; no stale body or expired reverse join. This pure owned read creates no new business effect or debit. Its failure reports only not_started/unchanged with null operation/status references. Existing underlying financial uncertainty is shown in the successful owned status envelope; unavailable read dependencies use the existing dependency_unavailable retry path. Never report a new reservation/settlement or invent a polling operation for this read. Original-resource disclosure: The caller must match both the exact original integration service principal and original integration in this workspace/environment, or the quote must already have been consumed by an order for which this service principal has its exact original owned order relation, with current quote/source permission. No human-steward exception; an unaccepted quote has no named delegation kind. Resolve authentication and exact same-workspace/environment owned relation before action-specific disclosure. Missing/foreign relation is the same opaque resource_not_found404. Only a proved owned relation may return an action-specific permission_denied403. No role or guessed identifier reveals another creator object; an entirely unauthenticated request remains unauthenticated401. Every current credential/action/profile/source/retention guard still applies. Non-retired suspension: A non-retired organisation security/financial suspension admits only the original authenticated integration service principal status/cancellation corridor below. Credential/session/principal revocation, compromised identity or retired binding has its own stricter denial and is never bypassed. Verify the original workspace/environment and integration service-principal identity before route-specific status/reduction. No data read, result/receipt body, new quote/order, funds or entitlement restoration. Token validity alone does not prove original relation. Current organisation suspension denies new work/result routes with existing entitlement_denied403, no reference and unchanged/not_started usage; invalid principal authority uses authority_revoked403. Unknown/foreign originals remain resource_not_found404 before an action-specific denial. Existing getClassificationOrder returns only its owned obligation envelope with items_path=null; cancellation preserves original cut-off and counters. General getOperation/getReceipt remain denied when they would expose result-bearing bodies; recovery uses the existing owned order route, never a new endpoint. This operation policy is denied_new_work_or_result.",
"tags": [
"Industry Classification Intelligence"
],
"parameters": [
{
"$ref": "#/components/parameters/ServiceProfile"
},
{
"name": "quote_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"maxLength": 36
}
}
],
"responses": {
"200": {
"description": "Proposed governed response; no deployed endpoint.",
"headers": {
"Cache-Control": {
"schema": {
"const": "private, no-store"
}
},
"Entity-Request-Id": {
"schema": {
"type": "string",
"format": "uuid"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ICQuoteResponse"
},
"examples": {
"synthetic_success": {
"summary": "Synthetic retained original-contract success; not a live service result",
"value": {
"data": {
"quote_id": "11111111-1111-4111-8111-111111111111",
"quote_digest": "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
"workspace_id": "22222222-2222-4222-8222-222222222222",
"environment": "synthetic-review",
"created_at": "2026-09-26T10:00:00Z",
"expires_at": "2026-09-26T10:10:00Z",
"latest_completion_at": "2026-09-26T11:00:00Z",
"latest_accounting_at": "2026-09-26T12:00:00Z",
"estimated_ready_from": null,
"estimated_ready_until": null,
"estimate_basis": "not_qualified",
"offer": {
"id": "synthetic-classification",
"revision": 1,
"digest": "eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee"
},
"tariff_revision": "1",
"unit": "synthetic-credit",
"unit_scale": 1,
"credit_policy_revision": "1",
"requested_rows": 1,
"distinct_entities": 1,
"lines": [
{
"quote_line_id": "22222222-2222-4222-8222-222222222222",
"subject": {
"entity_id": "11111111-1111-4111-8111-111111111111",
"environment": "synthetic-review",
"manifest_id": "11111111-1111-4111-8111-111111111111",
"subject_type": "legal_entity"
},
"client_references": [
"row-1"
],
"targets": [
{
"target": {
"standard_key": "nace:rev2.1",
"level": 4,
"activity_scope": "principal_only",
"subject_type": "legal_entity"
},
"availability": "requires_preparation",
"single_result_units": "5",
"success_rule": {
"policy": {
"id": "synthetic-policy",
"revision": 1,
"digest": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
},
"minimum_confidence_basis_points": 6000,
"comparison": "greater_than_or_equal_to",
"assessment_method": "sei-0.1",
"score_scope": "each_delivered_classification",
"required_checks": [
"resolved_subject",
"requested_edition",
"requested_depth",
"activity_role",
"current_evidence",
"permitted_rights",
"no_material_conflict"
]
},
"existing_acquisition_id": null,
"reason_codes": [],
"assessment_plan": {
"purpose": "refresh",
"prior_acquisition_id": "22222222-2222-4222-8222-222222222222",
"freshness_policy": {
"id": "synthetic-policy",
"version": "1",
"sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
},
"scope_digest": "cccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc",
"reuse_existing_owned": false,
"next_eligible_at": null,
"minimum_interval_seconds": 86400,
"work_limits": {
"maximum_attempts_per_order": 2,
"maximum_elapsed_seconds": 3600,
"maximum_fetches_per_order": 10,
"maximum_response_bytes_per_order": "100000",
"maximum_model_calls_per_order": 2,
"maximum_model_tokens_per_order": "8000",
"maximum_new_credit_units_per_order": "100",
"aggregate_counter_policy": {
"id": "synthetic-policy",
"version": "1",
"sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}
}
}
}
],
"outcome_prices": [
{
"qualifying_standard_keys": [],
"new_debit_units": "0",
"assessment_outcomes": []
},
{
"qualifying_standard_keys": [
"nace:rev2.1"
],
"new_debit_units": "5",
"assessment_outcomes": [
{
"standard_key": "nace:rev2.1",
"outcome": "changed"
}
]
},
{
"qualifying_standard_keys": [
"nace:rev2.1"
],
"new_debit_units": "3",
"assessment_outcomes": [
{
"standard_key": "nace:rev2.1",
"outcome": "unchanged"
}
]
}
],
"maximum_new_units": "5",
"recognised_prior_acquisitions": []
}
],
"maximum_new_units": "5",
"rights_and_lifecycle_digest": "9999999999999999999999999999999999999999999999999999999999999999",
"research_mode": "held_or_known_site",
"acceptance_state": "unavailable",
"unavailability_reasons": [
"synthetic_only"
],
"funding_expiry_rule": "duration_eligible_then_earliest_expiry",
"offer_binding": {
"offer_id": "11111111-1111-4111-8111-111111111111",
"offer_version": 1,
"offer_sha256": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
"policy_pins": {
"tariff": {
"id": "synthetic-policy",
"version": "1",
"sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
},
"terms": {
"id": "synthetic-policy",
"version": "1",
"sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
},
"credit": {
"id": "synthetic-policy",
"version": "1",
"sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
},
"refresh": {
"id": "synthetic-policy",
"version": "1",
"sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
},
"retrieval": {
"id": "synthetic-policy",
"version": "1",
"sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
},
"eligibility": {
"id": "synthetic-policy",
"version": "1",
"sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
},
"protection": {
"id": "synthetic-policy",
"version": "1",
"sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
},
"rights": {
"id": "synthetic-policy",
"version": "1",
"sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
},
"success": {
"id": "synthetic-policy",
"version": "1",
"sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}
},
"agreement_id": "22222222-2222-4222-8222-222222222222",
"agreement_revision": 1,
"funded_period_id": "11111111-1111-4111-8111-111111111111",
"selection_evidence_id": "22222222-2222-4222-8222-222222222222"
},
"purpose": "refresh",
"accepted_order_id": null
},
"meta": {
"request_id": "00000007-1111-4111-8111-000000000007",
"served_at": "2026-09-07T10:00:00Z",
"profile_revision": "synthetic-review-1",
"synthetic": true,
"replayed": false,
"warnings": [
"Illustration only; limits, retention and units are not approved production terms."
]
}
}
}
}
}
}
},
"422": {
"description": "Bounded zero-unit refusal: input-phase is not_started; delivery-phase is unchanged. Stop the unchanged request; no fresh financial effect or reverse operation reference.",
"x-error-codes": [
"limit_out_of_range"
],
"content": {
"application/problem+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ICProblem"
},
{
"properties": {
"code": {
"const": "limit_out_of_range"
},
"status": {
"const": 422
},
"usage_state": {
"enum": [
"not_started",
"unchanged"
]
},
"retry_action": {
"const": "do_not_retry"
},
"operation_id": {
"type": "null"
},
"status_path": {
"type": "null"
}
}
},
{
"if": {
"properties": {
"delivery_limit": {
"properties": {
"phase": {
"const": "delivery"
}
},
"required": [
"phase"
]
}
},
"required": [
"delivery_limit"
]
},
"then": {
"properties": {
"usage_state": {
"const": "unchanged"
}
}
}
}
]
}
}
},
"headers": {
"Cache-Control": {
"schema": {
"const": "private, no-store"
}
},
"Entity-Request-Id": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"Retry-After": {
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"description": "Provided only when a specific retry delay is known; never implies extra spending authority. Only valid delay-seconds or HTTP-date, no CR/LF; same128-character MCP bound. Unknown timing is omitted, not truncated."
}
}
},
"default": {
"description": "Typed safe error; inspect original operation after uncertain acceptance.",
"headers": {
"Cache-Control": {
"schema": {
"const": "private, no-store"
}
},
"Entity-Request-Id": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"Retry-After": {
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"description": "Provided only when a specific retry delay is known; never implies extra spending authority. Only valid delay-seconds or HTTP-date, no CR/LF; same128-character MCP bound. Unknown timing is omitted, not truncated."
}
},
"content": {
"application/problem+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ICProblem"
},
{
"properties": {
"usage_state": {
"enum": [
"not_started",
"unchanged"
]
},
"operation_id": {
"type": "null"
},
"status_path": {
"type": "null"
},
"code": {
"not": {
"enum": [
"operation_in_progress",
"operation_reconciling",
"completion_uncertain",
"budget_exhausted",
"funding_window_too_short"
]
}
}
}
}
]
},
"examples": {
"owned_resource_expired": {
"summary": "Synthetic authorised original after its retained resource cutoff; no new effect",
"value": {
"type": "https://example.test/problems/resource-expired",
"title": "Original resource expired",
"status": 410,
"code": "resource_expired",
"request_id": "11111111-1111-4111-8111-111111111111",
"operation_id": null,
"usage_state": "unchanged",
"retry_action": "do_not_retry",
"status_path": null
}
}
}
}
}
}
},
"x-permission": "classification.quote.read",
"x-billable": false,
"x-commercial-effect": "zero_new_classification_units",
"x-cross-adapter-bound": {
"operation": "getClassificationQuote",
"rule": "#/x-delivery-bound-contract",
"before_settlement": true
},
"x-original-resource-relation": "The caller must match both the exact original integration service principal and original integration in this workspace/environment, or the quote must already have been consumed by an order for which this service principal has its exact original owned order relation, with current quote/source permission. No human-steward exception; an unaccepted quote has no named delegation kind. Resolve authentication and exact same-workspace/environment owned relation before action-specific disclosure. Missing/foreign relation is the same opaque resource_not_found404. Only a proved owned relation may return an action-specific permission_denied403. No role or guessed identifier reveals another creator object; an entirely unauthenticated request remains unauthenticated401.",
"x-owned-relation-precedence": "Resolve authentication and exact same-workspace/environment owned relation before action-specific disclosure. Missing/foreign relation is the same opaque resource_not_found404. Only a proved owned relation may return an action-specific permission_denied403. No role or guessed identifier reveals another creator object; an entirely unauthenticated request remains unauthenticated401.",
"x-non-retired-suspension": {
"policy": "denied_new_work_or_result",
"rule": "A non-retired organisation security/financial suspension admits only the original authenticated integration service principal status/cancellation corridor below. Credential/session/principal revocation, compromised identity or retired binding has its own stricter denial and is never bypassed. Verify the original workspace/environment and integration service-principal identity before route-specific status/reduction. No data read, result/receipt body, new quote/order, funds or entitlement restoration. Token validity alone does not prove original relation. Current organisation suspension denies new work/result routes with existing entitlement_denied403, no reference and unchanged/not_started usage; invalid principal authority uses authority_revoked403. Unknown/foreign originals remain resource_not_found404 before an action-specific denial. Existing getClassificationOrder returns only its owned obligation envelope with items_path=null; cancellation preserves original cut-off and counters. General getOperation/getReceipt remain denied when they would expose result-bearing bodies; recovery uses the existing owned order route, never a new endpoint."
}
}Referenced schemas
Includes schemas used by this operation and its shared or inherited parameters. Open a schema to follow its related definitions.
Shared parameter definitions
{
"Cursor": {
"name": "cursor",
"in": "query",
"required": false,
"schema": {
"type": "string",
"maxLength": 4096,
"x-profile-maxLength": "string_characters_max"
},
"description": "Opaque signed cursor bound to query, organisation, environment, profile, rights and index/publication generation."
},
"IdempotencyKey": {
"name": "Idempotency-Key",
"in": "header",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"maxLength": 36
},
"description": "Random UUID for one logical operation, including billed GETs. Same request/key/time replays without a second charge; ENTITY application semantics."
},
"Manifest": {
"name": "manifest_id",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"maxLength": 36
},
"description": "Manifest returned by identity/search. A compatibility-bound follow-on read, not unrestricted historical query. Current rights and retention apply."
},
"MaxUnits": {
"name": "Entity-Max-Units",
"in": "header",
"required": false,
"schema": {
"$ref": "#/components/schemas/Units"
},
"description": "Caller ceiling in the accepted offer atomic unit; cannot increase organisation authority."
},
"OperationCreated": {
"name": "Entity-Operation-Created-At",
"in": "header",
"required": true,
"schema": {
"type": "string",
"format": "date-time",
"maxLength": 35
},
"description": "Original creation instant, unchanged on retry. New keys outside the profile admission/skew window are refused even after tombstone expiry."
},
"PageSize": {
"name": "page_size",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1,
"x-profile-maximum": "page_size_max"
},
"description": "Default and maximum from the active profile."
},
"ReceiptContext": {
"name": "Entity-Receipt-Context",
"in": "header",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"maxLength": 36
},
"description": "Readable own-organisation receipt containing the requested entity/manifest. Binds follow-on evidence/module reads to a known permitted result within its retention window; this is not unrestricted historical access."
},
"ServiceProfile": {
"name": "Entity-Service-Profile",
"in": "header",
"required": true,
"schema": {
"type": "string",
"maxLength": 4096,
"x-profile-maxLength": "string_characters_max"
},
"description": "Accepted immutable service-profile revision; missing/unknown profiles cannot activate an operation."
}
}Inherited path parameters
[]