Health ID Service

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

★ Only Publicly Available OpenAPI DocumentIdentity AuthIdentity Verificationnone73 EndpointsREST

For Agents

Register and manage ABHA (Health ID) accounts for Indian citizens, including Aadhaar and mobile OTP flows, KYC, profile updates, and ABHA card retrieval.

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 OTP for ABHA registration via /v1/account/aadhaar/generateOTP and verifyOTP

Generate and verify mobile OTP for ABHA registration without Aadhaar

Retrieve account profile, change passwords, and delete accounts under /v1/account/profile

Issue ABHA cards in PDF, PNG, and SVG formats from /v1/account/getCard, getPngCard, getSvgCard

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 Health ID Service is the ABHA (formerly Health ID) issuance and lifecycle API of India's National Digital Health Mission, allowing citizens to register a unique health identifier using either Aadhaar or a mobile number. The 73 endpoints cover OTP-based registration, KYC verification, profile updates, password management, ABHA card generation in PDF, PNG, and SVG formats, QR code retrieval, and integrated programme tagging. It is the citizen-facing identity layer underneath the NDHM Consent Manager and Gateway.

Use Cases

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

★ Citizen ABHA Registration with Mobile Number

A health-tech app onboards a new user by capturing their mobile number, requesting a mobile OTP via the Health ID Service, verifying it, and creating a Health ID with basic demographic details. The service issues the ABHA card in PNG or PDF that the citizen can save to their wallet. End-to-end registration takes a few minutes when the OTP delivery is reliable.

GET /v1/account/change/passwd/generateMobileOTP for the user's mobile, then complete the registration flow and call GET /v1/account/getPngCard to retrieve the ABHA card PNG.

Aadhaar-Based KYC for Health ID

Hospitals and insurers running KYC on a patient generate an Aadhaar OTP through the Health ID Service, verify it against the citizen's mobile-linked Aadhaar, and complete demographic verification. This satisfies the NDHM e-KYC requirement and is the prerequisite for issuing care contexts under the patient's ABHA id in downstream Consent Manager flows.

POST /v1/account/aadhaar/generateOTP with the patient's Aadhaar number, then POST /v1/account/aadhaar/verifyOTP with the OTP to complete e-KYC.

ABHA Card Self-Service Retrieval

Citizens lose or replace their ABHA card frequently, and apps offer a one-tap retrieval. The Health ID Service returns the card in PDF for printing, PNG for in-app display, or SVG for crisp rendering. The QR code endpoint provides an offline-scannable artefact for clinic intake desks that do not have internet access.

GET /v1/account/getSvgCard for the authenticated Health ID and embed the SVG in the user's profile screen.

Agent-Driven Health ID Lifecycle

An AI assistant inside a hospital intake workflow can use Jentic to discover and chain Health ID Service operations — register, verify, fetch card — without hard-coding the OTP-and-callback choreography. The agent retrieves the operation schema at runtime, so it adapts when the ABHA service evolves to v2.

Search Jentic for 'register an ABHA account by mobile OTP', load the schema for the OTP generation endpoint, and execute it for the patient mobile number.

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 KYC

POST

/v1/account/aadhaar/verifyOTP

Verify Aadhaar OTP

GET

/v1/account/change/passwd/generateMobileOTP

Generate mobile OTP for registration

GET

/v1/account/profile

Get Health ID profile

POST

/v1/account/profile

Update Health ID profile

GET

/v1/account/getCard

Get ABHA card as PDF

GET

/v1/account/getPngCard

Get ABHA card as PNG

GET

/v1/account/qrCode

Get ABHA QR code

POST

/v1/account/aadhaar/generateOTP

Generate Aadhaar OTP for KYC

POST

/v1/account/aadhaar/verifyOTP

Verify Aadhaar OTP

GET

/v1/account/change/passwd/generateMobileOTP

Generate mobile OTP for registration

GET

/v1/account/profile

Get Health ID profile

POST

/v1/account/profile

Update Health ID profile

Why though Jentic?

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

Credential isolation

ABHA participant access tokens and Aadhaar X-Token KYC tokens are stored encrypted in the Jentic vault and injected at execution time. Agents never see the raw bearer token in their context.

Intent-based discovery

Agents search by intent such as 'register an ABHA account by mobile OTP' and Jentic returns the matching Health ID Service operation with its request schema, removing the need to read the ABHA portal docs.

Time to first call

Direct ABHA integration: 1-3 weeks for participant onboarding, OTP retry handling, and Aadhaar token wiring. Through Jentic: under a day to call individual ABHA operations with managed credentials.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Complementary

Health Data Consent Manager

Uses the ABHA id issued by the Health ID Service as the patient identifier for consent

Use when the agent must raise consent against the Health ID issued in this flow.

Complementary

NDHM Gateway

Routes consent and data flows that reference the Health ID issued here

Use when the agent needs to call other NDHM participants on behalf of the registered ABHA holder.

Complementary

NDHM HIP Specifications

HIP endpoints that link care contexts under a citizen's ABHA id

Use when the agent represents a hospital that must link encounters to a registered Health ID.

FAQs

Specific to using Health ID Service API through Jentic.

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

The National Health Authority publishes ABHA APIs as portal documentation rather than a machine-readable OpenAPI file. 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 published ABHA 1.0 specification and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the Health ID Service use?

The OpenAPI spec does not declare a top-level security scheme; ABHA endpoints require a bearer access token issued via the participant onboarding flow plus, for Aadhaar paths, an X-Token header carrying the OTP-derived KYC token. Through Jentic these credentials are stored encrypted in the vault and injected at execution time.

Can I create an ABHA account with this API?

Yes. Use the mobile flow with GET /v1/account/change/passwd/generateMobileOTP and the registration verify endpoints, or the Aadhaar flow with POST /v1/account/aadhaar/generateOTP followed by /v1/account/aadhaar/verifyOTP. After verification the service issues a Health ID and returns it in the response.

What are the rate limits for the Health ID Service?

OTP endpoints are throttled per Aadhaar number and per mobile number by the National Health Authority; the OpenAPI does not list explicit numeric limits. Expect 429 responses on rapid retries and back off; for production access, request quota uplift through the NHA participant agreement.

How do I retrieve an ABHA card through Jentic?

Run pip install jentic, then search for 'get ABHA card PNG', load the schema for GET /v1/account/getPngCard, and execute it with the authenticated Health ID. Jentic returns the binary PNG response ready for display.

Does the Health ID Service handle clinical records?

No. The Health ID Service only manages the citizen identity, KYC, and ABHA card lifecycle. Clinical record exchange flows through the NDHM Gateway and Consent Manager APIs.