Health ID Service

Name: Health ID Service API
Brand: NDHM Health ID Service
Availability: InStock

★ Only Publicly Available OpenAPI DocumentHealthcareEhr Emrnone73 EndpointsREST

For Agents

Issue and manage ABHA Health IDs with Aadhaar or mobile-based registration, KYC, profile updates, password recovery, and Health ID card generation.

Connect the Health ID Service to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Health ID Service, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Install Jentic One Beta (Self-Hosted)

Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Health ID Service API.

Generate and verify Aadhaar OTPs for KYC and re-KYC of an existing Health ID

Reset a Health ID password using Aadhaar, mobile, or existing-password flows

Generate the Health ID card as PDF, PNG, or SVG for download

GET STARTED

Start building with Health ID Service API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI document for Health ID Service, keeping it validated and agent-ready.

Jentic publishes the only available OpenAPI specification for Health ID Service, keeping it validated and agent-ready. The NDHM Health ID Service issues and manages the ABHA Health ID — a unique identifier used across India's National Digital Health Mission to issue, access, and share health records with patient consent. The 73-endpoint surface covers Aadhaar and mobile-OTP based registration, KYC, profile management, password and credential recovery, health-facility linkage, integrated programs, search, and Health ID card generation in PDF, PNG, and SVG formats.

Use Cases

Patterns agents use Health ID Service API for, with concrete tasks.

★ ABHA Health ID Registration in a Provider App

Hospitals and telemedicine apps register patients into the NDHM ecosystem by issuing them an ABHA Health ID. The Aadhaar registration flow (POST /v1/account/aadhaar/generateOTP and /verifyOTP) completes KYC in the same call, while the mobile flow caters to patients without an Aadhaar link. Issuance now takes seconds rather than the minutes-long flow on the NDHM portal.

Call POST /v1/account/aadhaar/generateOTP with the Aadhaar number, then POST /v1/account/aadhaar/verifyOTP to complete registration

Patient Self-Service Password Reset

Patients who have forgotten their Health ID password reset it via Aadhaar OTP, mobile OTP, or existing-password flows. The /v1/account/change/passwd endpoints orchestrate OTP generation and verification while preserving the audit trail required by NDHM. Replaces a manual support-ticket process.

Call GET /v1/account/change/passwd/generateMobileOTP with the registered mobile, then POST /v1/account/change/passwd/byMobile with the OTP and new password

Health ID Card Issuance

Issue a printable or digital Health ID card to the patient after onboarding. GET /v1/account/getCard returns a PDF, /getPngCard returns a PNG suitable for in-app display, and /getSvgCard returns a vector format used by some hospital print services. Cards include the ABHA number and QR code for offline lookup.

Call GET /v1/account/getCard with a valid Health ID token and stream the resulting PDF to the patient's email

Agent-Driven ABHA Onboarding

An AI agent inside a hospital reception app onboards a new patient end-to-end — capturing their Aadhaar, generating the OTP, verifying it, and downloading the Health ID card — all through Jentic. The Aadhaar OTP and reset-password tokens stay in the encrypted vault rather than the agent's context.

Search Jentic for 'register ABHA Health ID via Aadhaar', execute the OTP and verifyOTP endpoints, then GET /v1/account/getCard

Key Endpoints

73 endpoints — jentic publishes the only available openapi specification for health id service, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

POST

/v1/account/aadhaar/generateOTP

Generate Aadhaar OTP for registration or KYC

POST

/v1/account/aadhaar/verifyOTP

Verify Aadhaar OTP

POST

/v1/account/change/passwd/byMobile

Change password via mobile OTP

GET

/v1/account/getCard

Generate Health ID card as PDF

GET

/v1/account/getPngCard

Generate Health ID card as PNG

DELETE

/v1/account/profile

Delete a Health ID account

POST

/v1/account/aadhaar/generateOTP

Generate Aadhaar OTP for registration or KYC

POST

/v1/account/aadhaar/verifyOTP

Verify Aadhaar OTP

POST

/v1/account/change/passwd/byMobile

Change password via mobile OTP

GET

/v1/account/getCard

Generate Health ID card as PDF

GET

/v1/account/getPngCard

Generate Health ID card as PNG

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Health ID bearer tokens, Aadhaar OTP transaction IDs, and client credentials are stored encrypted in the Jentic vault. Agents receive scoped execution tokens — sensitive identity material never enters the agent's context.

Intent-based discovery

Agents search by intent (e.g., 'register ABHA Health ID via Aadhaar') and Jentic returns the matching POST endpoint with its schema, so the agent walks through generateOTP and verifyOTP without browsing 73 paths.

Time to first call

Direct Health ID Service integration: 1-2 weeks including UIDAI Aadhaar setup, OTP retry handling, and certification. Through Jentic: under a day for the registration, KYC, and card-issuance flows.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Complementary

NDHM Gateway

The Gateway uses ABHA Health IDs issued by this service to identify patients across HIPs and HIUs.

Use the Health ID Service to issue or look up ABHA; use the Gateway for the consent and data-flow lifecycle that follows.

Complementary

NDHM Health Data Consent Manager

The CM stores consent records keyed on the patient's ABHA Health ID.

Use the Health ID Service for identity issuance; use the CM for the patient-facing consent UI.

Complementary

NDHM HIP Specifications

HIPs link patient records to the Health ID issued by this service via /links/link/add-contexts.

Use this service to obtain the ABHA; use the HIP spec to link the patient's care contexts at the provider.

FAQs

Specific to using Health ID Service API through Jentic.

Why is there no official OpenAPI spec for Health ID Service?

NDHM does not publish a maintained OpenAPI specification for the Health ID Service — only HTML reference docs and a deprecated apis.guru import. Jentic generates and maintains this spec so that AI agents and developers can call Health ID Service via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the Health ID Service use?

Most endpoints require a bearer JWT issued through the NDHM Health ID auth flow (POST /v1/account/aadhaar/verifyOTP returns a token). The OpenAPI spec leaves `securitySchemes` empty because the auth pattern is documented at the operation level rather than as a global scheme. Through Jentic, tokens are stored encrypted and supplied per request.

Can I register a new ABHA Health ID through this API?

Yes. The Aadhaar flow (POST /v1/account/aadhaar/generateOTP then /verifyOTP) registers and KYCs the patient in one sequence. The mobile flow uses /generateMobileOTP and /verifyMobileOTP for patients who cannot link an Aadhaar.

What are the rate limits for the Health ID Service?

Rate limits are not declared in the OpenAPI spec. The sandbox at healthidsbx.ndhm.gov.in applies per-IP throttling for development. Aadhaar OTP endpoints are additionally throttled by UIDAI and may return rate-limit errors during peak load.

How do I download a Health ID card through Jentic?

Search Jentic for 'download ABHA Health ID card', load the schema for GET /v1/account/getCard (PDF), /getPngCard (PNG), or /getSvgCard (SVG), and execute with a valid Health ID bearer token. The response is a binary stream that Jentic returns to the agent for forwarding.

Is the NDHM Health ID Service free?

Yes. The Health ID Service is operated by India's National Health Authority and is free for accredited integrators. Production access requires onboarding through the NHA developer portal.