ENTITY developer reference
Submit an owned field report
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/feedback
Operation identifier: submitFeedback
Submit an owned field report. The field-feedback rules govern private allegations, original-scope checks, no customer debit and bounded Sustema-funded rechecks. Original-resource disclosure: New report owned by the authenticated reporting integration service principal, never an invented human. Require feedback.submit and that integration's currently permitted original receipt or its related order's own committed delivery receipt. FeedbackTarget.receipt_id identifies that relation-bearing delivery; acquisition_id is a committed item of the same order and field_path resolves inside the permitted delivered response. Missing relation is opaque before subject/field validation; related invalid field is invalid_request. No other integration/human relation, original unrelated receipt, new subject, source acquisition or spending is implied. The signed-in console separately verifies its current human reporter, workspace, original delivery scope and report 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": "submitFeedback",
"summary": "Submit an owned field report",
"description": "Submit an owned field report. The field-feedback rules govern private allegations, original-scope checks, no customer debit and bounded Sustema-funded rechecks. Original-resource disclosure: New report owned by the authenticated reporting integration service principal, never an invented human. Require feedback.submit and that integration's currently permitted original receipt or its related order's own committed delivery receipt. FeedbackTarget.receipt_id identifies that relation-bearing delivery; acquisition_id is a committed item of the same order and field_path resolves inside the permitted delivered response. Missing relation is opaque before subject/field validation; related invalid field is invalid_request. No other integration/human relation, original unrelated receipt, new subject, source acquisition or spending is implied. The signed-in console separately verifies its current human reporter, workspace, original delivery scope and report permission; an API credential cannot borrow that authority.",
"tags": [
"Data quality feedback"
],
"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"
}
},
"ETag": {
"schema": {
"type": "string",
"pattern": "^\"[1-9][0-9]*\"$"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FeedbackResponse"
},
"example": {
"data": {
"feedback_id": "00000000-0000-4000-8000-000000000007",
"revision": 1,
"state": "received",
"projection": "full_permitted",
"target": {
"kind": "claim",
"receipt_id": "00000000-0000-4000-8000-000000000003",
"subject": {
"entity_id": "00000000-0000-4000-8000-000000000001",
"environment": "synthetic-review",
"manifest_id": "00000000-0000-4000-8000-000000000002",
"subject_type": "legal_entity"
},
"field_path": "/data/claims/0",
"claim_id": "00000000-0000-4000-8000-000000000004",
"claim_version_id": "00000000-0000-4000-8000-000000000005"
},
"reason_code": "accepted",
"explanation": "Report recorded. Eligibility and bounded maintenance capacity will be checked. No customer credits were used.",
"next_action": "poll_status",
"created_at": "2026-09-14T05:00:00Z",
"updated_at": "2026-09-14T05:00:00Z",
"expires_at": "2026-09-21T05:00:00Z",
"recheck_reference": null,
"updated_subject": null,
"related_adjustment_request_id": null,
"customer_debit_units": "0",
"policy_revision": "synthetic-proposed-only-1"
},
"meta": {
"request_id": "00000000-0000-4000-8000-000000000006",
"served_at": "2026-09-14T05:00:00Z",
"profile_revision": "synthetic-feedback-1",
"synthetic": true,
"replayed": false,
"warnings": [
"Illustrative only; no company or service is real."
]
}
}
}
}
},
"default": {
"description": "FeedbackProblem; status/retry bound by errors.json, same-key retry after uncertain submission; no charge or arbitrary provider work.",
"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/FeedbackProblem"
}
}
}
}
},
"x-permission": "feedback.submit",
"x-billable": false,
"x-commercial-effect": "zero_customer_units",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FeedbackRequest"
},
"example": {
"target": {
"kind": "claim",
"receipt_id": "00000000-0000-4000-8000-000000000003",
"subject": {
"entity_id": "00000000-0000-4000-8000-000000000001",
"environment": "synthetic-review",
"manifest_id": "00000000-0000-4000-8000-000000000002",
"subject_type": "legal_entity"
},
"field_path": "/data/claims/0",
"claim_id": "00000000-0000-4000-8000-000000000004",
"claim_version_id": "00000000-0000-4000-8000-000000000005"
},
"reason": "wrong_value",
"evidence": {
"explanation": "The reported registered name differs from this result. Please recheck the original claim.",
"proposed_value": "Example Manufacturing Ltd",
"source_urls": [
"https://example.com/company"
],
"resubmitted_reference": null
}
}
}
}
},
"x-recovery-lane": "feedback",
"x-entitlement-rule": "Current feedback grant plus ownership of original receipt/report; no spendable balance needed. Current data rights independently gate payload/updated-result disclosure.",
"x-cross-adapter-bound": {
"operation": "submitFeedback",
"rule": "#/x-delivery-bound-contract",
"before_settlement": true
},
"x-original-resource-relation": "New report owned by the authenticated reporting integration service principal, never an invented human. Require feedback.submit and that integration's currently permitted original receipt or its related order's own committed delivery receipt. FeedbackTarget.receipt_id identifies that relation-bearing delivery; acquisition_id is a committed item of the same order and field_path resolves inside the permitted delivered response. Missing relation is opaque before subject/field validation; related invalid field is invalid_request. No other integration/human relation, original unrelated receipt, new subject, source acquisition or spending is implied. The signed-in console separately verifies its current human reporter, workspace, original delivery scope and report 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
[]