DEVELOPER GUIDEREFERENCE CONTRACT

Claims API

Create, query, supersede and dispute evidence-backed claims with issuer/source/version context.

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.
POST/v1/claims

Submit an evidence-backed claim

Submit an evidence-backed claim for governed evaluation and lifecycle management.

OAuth
claim.write
State
Evidence and issuer context exist; claim is not yet accepted. → Claim enters governed processing; acceptance is not equivalent to legal authority.
Evidence
Evidence references, issuer context, policy version and audit record.
Errors
400 schema · 401/403 scope/mandate · 409 duplicate/idempotency · 422 policy/evidence failure
Retry
Use Idempotency-Key for write retry.
{"subject":"ttid:thing:01HV...","claimType":"ownership","issuer":"org:example","evidenceRefs":["evidence:transfer:123"]}
{"claimId":"claim:01...","status":"pending-governed-evaluation","correlationId":"corr-..."}
GET/v1/claims/{claimId}

Get a claim and provenance/status context

Read a claim together with provenance and status context.

OAuth
claim.read
State
Claim identifier is known. → Current governed claim/status context is returned.
Evidence
Read audit according to policy; provenance links preserved.
Errors
404 claim not found · 403 disclosure denied
Retry
Safe read retry.
{"subject":"ttid:thing:01HV...","claimType":"ownership","issuer":"org:example","evidenceRefs":["evidence:transfer:123"]}
{"claimId":"claim:01...","status":"pending-governed-evaluation","correlationId":"corr-..."}
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.