ENTITY developer reference
Report an owned classification debit or evidence issue without a new charge
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.
POST /v1/classification-adjustment-requests
Operation identifier: createClassificationAdjustmentRequest
Report an owned classification debit or evidence issue without a new charge. 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. After the owned retained order cutoff, identical createClassificationOrder replay, cancelClassificationOrder and createClassificationAdjustmentRequest return resource_expired/410, do_not_retry, unchanged and null operation/status; never revive a subject-linked body or create a new effect from a tombstone. Expired generic getOperation returns operation_expired/410 with unchanged, do_not_retry and null references, never uncertain/poll-to-self. Underlying uncertain effects continue server-side and survive only in authorised subject-free finance/case status. Legitimate financial claims use existing support-case intake in the signed-in console with original permitted invoice/payment/finance evidence, not expired classification IDs. Current ownership and foreign-resource opacity precede expiry. Original-resource disclosure: Current original order relation of the authenticated requesting integration and classification.adjustment.request. The claim is owned by that integration service principal; it is not a refund, transfer of the order or borrowed human/named relation. Current credentials, action/profile/source/retention and foreign-resource opacity apply. The signed-in console separately verifies its current human requester, workspace, original-order relation and claim permission; an API credential cannot borrow that authority.
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."
}Idempotency-Key
header · Required
Random UUID for one logical operation, including billed GETs. Same request/key/time replays without a second charge; ENTITY application semantics.
Reading definition for Idempotency-Key
{
"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."
}Entity-Operation-Created-At
header · Required
Original creation instant, unchanged on retry. New keys outside the profile admission/skew window are refused even after tombstone expiry.
Reading definition for Entity-Operation-Created-At
{
"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."
}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": "createClassificationAdjustmentRequest",
"summary": "Report an owned classification debit or evidence issue without a new charge",
"description": "Report an owned classification debit or evidence issue without a new charge. 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. After the owned retained order cutoff, identical createClassificationOrder replay, cancelClassificationOrder and createClassificationAdjustmentRequest return resource_expired/410, do_not_retry, unchanged and null operation/status; never revive a subject-linked body or create a new effect from a tombstone. Expired generic getOperation returns operation_expired/410 with unchanged, do_not_retry and null references, never uncertain/poll-to-self. Underlying uncertain effects continue server-side and survive only in authorised subject-free finance/case status. Legitimate financial claims use existing support-case intake in the signed-in console with original permitted invoice/payment/finance evidence, not expired classification IDs. Current ownership and foreign-resource opacity precede expiry. Original-resource disclosure: Current original order relation of the authenticated requesting integration and classification.adjustment.request. The claim is owned by that integration service principal; it is not a refund, transfer of the order or borrowed human/named relation. Current credentials, action/profile/source/retention and foreign-resource opacity apply. The signed-in console separately verifies its current human requester, workspace, original-order relation and claim permission; an API credential cannot borrow that authority.",
"tags": [
"Industry Classification Intelligence"
],
"parameters": [
{
"$ref": "#/components/parameters/ServiceProfile"
},
{
"$ref": "#/components/parameters/IdempotencyKey"
},
{
"$ref": "#/components/parameters/OperationCreated"
}
],
"responses": {
"202": {
"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/ICAdjustmentResponse"
}
}
}
},
"410": {
"description": "Original owned history expired; use existing account case intake for surviving financial claims.",
"headers": {
"Cache-Control": {
"schema": {
"const": "private, no-store"
}
},
"Entity-Request-Id": {
"schema": {
"type": "string",
"format": "uuid"
}
}
},
"content": {
"application/problem+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ICProblem"
},
{
"properties": {
"code": {
"const": "resource_expired"
},
"status": {
"const": 410
},
"usage_state": {
"const": "unchanged"
},
"retry_action": {
"const": "do_not_retry"
},
"operation_id": {
"type": "null"
},
"status_path": {
"type": "null"
}
}
}
]
}
}
},
"x-error-codes": [
"resource_expired"
]
},
"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": {
"$ref": "#/components/schemas/ICProblem"
}
}
}
}
},
"x-permission": "classification.adjustment.request",
"x-billable": false,
"x-commercial-effect": "zero_new_classification_units",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ICAdjustmentRequest"
}
}
}
},
"x-cross-adapter-bound": {
"operation": "createClassificationAdjustmentRequest",
"rule": "#/x-delivery-bound-contract",
"before_settlement": true
},
"x-original-resource-relation": "Current original order relation of the authenticated requesting integration and classification.adjustment.request. The claim is owned by that integration service principal; it is not a refund, transfer of the order or borrowed human/named relation. Current credentials, action/profile/source/retention and foreign-resource opacity apply. The signed-in console separately verifies its current human requester, workspace, original-order relation and claim permission; an API credential cannot borrow that authority."
}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
[]