Skip to content
DISHA 4.0 HCOS
A female engineer working through code at her workstation

RESOURCES → DEVELOPER CENTER → API REFERENCE

The DISHA API, Precisely Defined.

A precise, machine-aligned reference for operations, schemas, authentication, parameters, responses, errors, limits, idempotency, pagination, versioning and operational behavior.

What exactly can a developer call, send, receive, depend on and safely automate?

Developer honesty: no public API, SDK packages, webhook deliveries, release history or status monitoring are live yet. Every contract, payload and console below is a clearly-labeled illustrative design — no fabricated endpoints, SDK support, incidents or uptime figures.
API Reference

Interactive API Explorer

6 operations shown · contract design v1.2 · illustrative — no live API

GET/v1/genome/evidence/{person_id}

List evidence objects for a person (consent-scoped)

Scopes
genome:read
Idempotent
Yes
Side effects
None — read only
Errors
401 · 403 · 404 · 429
Rate limits
Illustrative design: 600 req/min/org
Pagination
Cursor-based, 25 default

Try-It Console

Build the request, read the generated cURL — and press Send to inspect an illustrative fixture response. No live API is called; destructive operations require explicit confirmation.

Environment:Sandbox — fixture onlyProduction — fixture only
cURL (generated) · GET · illustrative
curl -X GET "https://api.disha.example/v1/genome/evidence/person_123" \
  -H "Authorization: Bearer $DISHA_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)"
GET response · fixture · 200 OK · illustrative
{
  "id": "evd_01H…",
  "subject": "person_123",
  "kind": "evidence",
  "provenance": [{ "source": "manager-attestation", "at": "2026-09-01" }],
  "data_status": "illustrative"
}

The signature relationship graph

Endpoint→Schema→Permission→Event→SDK Method→Docs Guide→Example→Observability

Error intelligence

Authentication
Authorization
Validation
Conflict
Rate limit
Dependency
Timeout
Server

Each error carries meaning, likely cause, retry safety, idempotency implications, diagnostic identifiers and an escalation path — in the full contract design.

Versioning & compatibility

Compatibility matrix (illustrative)

  • API v1.2 · SDK design TS 1.2 / PY 1.2 · webhook schema 1.1 — aligned
  • API v1.1 · SDK 1.1 · schema 1.0 — aligned
  • API v1.0 · sunset — migration to v1.2

Lifecycle labels

currentsupporteddeprecatedsunset

Breaking changes link to migration guidance in Release Notes.

Reference governance: generated or validated from authoritative contracts; executable examples; auth/scopes/limits/errors match the contract; environment boundaries respected in the explorer. No fabricated endpoints or behavior — illustrative design until the public API ships.

Was this page accurate?