DEVELOPER GUIDEREFERENCE CONTRACT

Search API

Search derived read models without treating search indexes as authoritative records.

CONTRACT PRINCIPLES

The protocol carries business semantics.

Each integration must preserve authority, policy, evidence and recovery context.

Version boundary

Pin API/schema/profile versions in test evidence.

Correlation

Carry a correlation ID across request, event, connector and evidence records.

Idempotency

Protect material write operations from accidental replay.

Authority context

Never infer legal authority solely from transport success.

REFERENCE ENDPOINTS

Explore the full OpenAPI contract.

The downloadable contract contains request/response models, OAuth scopes, idempotency and representative errors.

Reference API surface
AreaReference routeSemantics
ResolverGET /v1/resolve/{identifier}Official ID → TTID resolution with authority context
DPPGET /v1/dpp/{identifier}Policy-qualified DPP read
ClaimsPOST /v1/claimsEvidence-backed claim submission
EvidencePOST /v1/evidenceEvidence/provenance reference
MandatePOST /v1/mandatesDelegation lifecycle
LifecyclePOST /v1/things/{thingId}/transitionsMaterial transition
SearchGET /v1/searchDerived read model
ConnectorPOST /v1/connectors/{id}/reconcileBusiness reconciliation
VIEW ONLINE FIRSTYAML is a download artifact; operation semantics are read here.
GET/v1/search

Search a derived read model

Search a derived read model without treating the search index as a system of record.

OAuth
thing.read
State
Search query and disclosure context are supplied. → Derived results are returned and can be resolved back to authoritative/source-aware records.
Evidence
Search access may be audited by deployment policy.
Errors
400 invalid query · 403 disclosure denied · 503 index unavailable
Retry
Safe read retry.
{"q":"battery model X"}
{"results":[{"thingId":"ttid:thing:01...","officialIdentifier":"...","source":"derived-index"}],"authoritative":false}
ARCHITECTURE WORKSHOP

Move from integration to evidence-backed approval.

Align product-group applicability, authority boundaries, portal journeys, integration contracts and evidence before committing to production claims.