eHR · Developers

Public API

Programmatic access to the National Health Professionals Council (NHPC) registry: verify a licence and read aggregate statistics. The API exposes only public information — never contact details or uploaded documents.

Authentication

Every request needs an API key in the x-api-key header. Keys are issued by an NHPC super-admin and are scoped to verify and/or stats. Email info@ehr.so to request one.

curl https://ehr.so/api/public/v1/verify/EH-PHY-2026-00481 \
  -H "x-api-key: ehr_xxxxxxxxxxxxxxxxxxxxxxxx"

Endpoints

GET/v1/verify/{licenseNo}scope: verify

Returns the holder name, profession, status, validity, and dates for a licence number.

{
  "licenseNo": "EH-PHY-2026-00481",
  "holderName": "Dr Faadumo Hassan Aden",
  "profession": "physician",
  "status": "active",
  "valid": true,
  "issuedAt": 1746230400000,
  "expiresAt": 1777766400000
}

GET/v1/registry/statsscope: stats

Active / expired / revoked counts, in total and by profession. No personal data. Cached ~5 minutes.

{
  "totals": { "active": 1240, "expired": 88, "revoked": 4 },
  "byProfession": {
    "physician": { "active": 410, "expired": 22, "revoked": 1 },
    "nurse":     { "active": 520, "expired": 40, "revoked": 2 }
  },
  "generatedAt": 1749300000000
}

Rate limits & errors

60 requests / minute / key. Over the limit returns 429 rate_limited.
401 missing_api_key / 401 invalid_api_key — no/unknown/revoked key.
403 missing_scope — the key lacks the scope for that endpoint.
404 not_found — no licence with that number.

OpenAPI

Machine-readable spec: /api/public/v1/openapi.json