Ndhm

Health ID Service

It is important to standardize the process of identification of an individual across healthcare providers, to ensure that the created medical records are…

Government & public#openapi#open-data

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

It is important to standardize the process of identification of an individual across healthcare providers, to ensure that the created medical records are issued to the right individual or accessed by a Health Information User through appropriate consent.
In order to issue a Health ID to an individual, one only needs basic demographic details like Name, Year of Birth, Gender. In addition, citizens should be able to update contact information easily.

Endpoints 73

Authentication

  • POSTAuthenticate using Health ID number / Health ID and password/v1/auth/authPassword
  • POSTAuthenticate request to generate Mobile OTP using Health ID number / Health ID/v1/auth/authWithMobile
  • POSTAuthenticate using verified Mobile Number and user data/v1/auth/authWithMobileToken
  • GETAuth token public key./v1/auth/cert
  • POSTAuthentication with Aadhaar Biometric based auth transaction./v1/auth/confirmWithAadhaarBio
  • POSTAuthentication with Aadhaar OTP based auth transaction./v1/auth/confirmWithAadhaarOtp
  • POSTAuthenticate using demographic data of user./v1/auth/confirmWithDemographics
  • POSTAuthentication with Mobile OTP based auth transaction./v1/auth/confirmWithMobileOTP
  • POSTAuthentication with PASSWORD based auth transaction./v1/auth/confirmWithPassword
  • POSTInitiate authentication process for given Health ID/v1/auth/init
  • POSTResend Aadhaar/Mobile OTP for Authentication Transaction./v1/auth/resendAuthOTP

Forgot health id/number

  • POSTVerify aadhar OTP sent as part of forgetHealth id./v1/forgot/healthId/aadhaarVerify aadhar OTP sent as part of forgetHealth id.
  • POSTGenerate Aadhaar OTP on registrered mobile number/v1/forgot/healthId/aadhaar/generateOtpGenerate Aadhaar OTP on registrered mobile number
  • POSTVerify Mobile OTP sent as part of forgetHealth id./v1/forgot/healthId/mobileVerify Mobile OTP sent as part of forgetHealth id.
  • POSTGenerate Mobile OTP to start registration/v1/forgot/healthId/mobile/generateOtpGenerate Mobile OTP to start registration transaction.

Health Facility

  • POSTGenerate token for heath facility id./v1/health/facility/authenticateGenerate token for heath facility id.
  • POSTChange password for heath facility id./v1/health/facility/change/passwordChange password for heath facility id.
  • POSTGenerate Health ID card SVG/v1/health/facility/createHealthIdWithPreVerified
  • POSTGenerates password for heath facility id./v1/health/facility/generate/passwordGenerates password for heath facility id.
  • POSTGenerate health hacility OTP on registrered mobile number/v1/health/facility/generateOtpGenerate health facility OTP on registrered mobile number
  • GETgenerateSvgCard/v1/health/facility/getSvgCard
  • POSTReset password for heath facility id./v1/health/facility/reset/passwordReset password for heath facility id.

Integrated Programs

  • POSTGenerate Aadhaar OTP on registrered mobile number/v1/hid/benefit/aadhaar/generateOtpGenerate Aadhaar OTP on registrered mobile number
  • POSTCreate health id using Aadhaar Number Otp./v1/hid/benefit/aadhaar/verifyAadharOtpCreate health id using Aadhaar number opt
  • POSTCreate health id using Biometric Authentication./v1/hid/benefit/aadhaar/verifyBioCreate health id using Biometric Authentication.
  • POSTCreate health id using Aadhaar Demo Auth./v1/hid/benefit/createHealthId/demo/authCreate health id using Aadhaar Demo Auth.
  • POSTDe-Linked with hid./v1/hid/benefit/delinkDe-Linked with hid.
  • POSTLinked with hid./v1/hid/benefit/linkLinked with hid.
  • POSTCreate health id using mobile Authentication./v1/hid/benefit/mobile/createHealthIdCreate health id using mobile Authentication.
  • POSTGenerate mobile OTP on registrered mobile number/v1/hid/benefit/mobile/generateOtpGenerate mobile OTP on registrered mobile number
  • POSTCreate health id using notify Benefit./v1/hid/benefit/notify/benefitCreate health id using notify Benefit.
  • POSTSearch health id number using aadhar or aadhar token./v1/hid/benefit/search/aadhaarSearch health id number using aadhar or aadhar token.
  • POSTSearch benefit using health id number./v1/hid/benefit/search/healthIdNumberSearch benefit using health id number
  • POSTUpdate mobile number for account./v1/hid/benefit/update/mobile
  • POSTUpdate account information/v1/hid/benefit/update/profile
  • POSTUpdate health id status ./v1/hid/benefit/update/statusUpdate health id status.

Profile

  • POSTGenerate Aadhaar OTP on registrered for link account with aadhar number/v1/account/aadhaar/generateOTPGenerate Aadhaar OTP on registrered for link account with aadhar number
  • POSTVerify Aadhaar OTP to complete KYC/re-KYC verification./v1/account/aadhaar/verifyOTPVerify Aadhaar OTP to complete KYC/re-KYC verification
  • GETGet List of Benefits associated with HealthID./v1/account/benefits
  • POSTChange password via Aadhar for heath id./v1/account/change/passwd/byAadhaarChange password via Aadhar for heath id.
  • POSTChange password via mobile for heath id./v1/account/change/passwd/byMobileChange password via mobile for heath id.
  • GETGenerate Aadhaar OTP on registrered mobile number./v1/account/change/passwd/generateAadhaarOTPGenerate Aadhaar OTP on registrered mobile number.
  • GETGenerate Mobile OTP to start registration./v1/account/change/passwd/generateMobileOTPGenerate Mobile OTP to start registration.
  • POSTChange password via password for heath id./v1/account/change/passwordChange password via password for heath id.
  • GETGenerate Health ID card in PDF format/v1/account/getCard
  • GETGenerate Health ID card PNG/v1/account/getPngCard
  • GETGenerate Health ID card SVG/v1/account/getSvgCard
  • GETGet account information./v1/account/profile
  • POSTUpdate account information/v1/account/profile
  • DELETEDelete account/v1/account/profile
  • GETGet Quick Response code in PNG format for this account./v1/account/qrCode
  • POSTValidate auth token/v1/account/token

Registration with Aadhaar

  • POSTVerify Aadhaar OTP on registrered mobile number to create Health ID./v1/registration/aadhaar/createHealthIdWithAadhaarOtpVerify Aadhar OTP received on registrered mobile number
  • POSTCreate Health ID using pre-verified Aadhaar & Mobile./v1/registration/aadhaar/createHealthIdWithPreVerifiedCreate Health ID using pre-verified Aadhaar & Mobile.
  • POSTGenerate Mobile OTP for verification./v1/registration/aadhaar/generateMobileOTPGenerate Mobile OTP to verify mobile number.
  • POSTGenerate Aadhaar OTP on registrered mobile number/v1/registration/aadhaar/generateOtpGenerate Aadhaar OTP on registrered mobile number
  • POSTResend Aadhaar OTP on registrered mobile number to create Health ID./v1/registration/aadhaar/resendAadhaarOtpResend Aadhar OTP on registrered mobile number
  • POSTSearch health id number using aadhar./v1/registration/aadhaar/search/aadharSearch health id number using aadhar.
  • POSTVerify Aadhaar using biometrics./v1/registration/aadhaar/verifyBioVerify Aadhaar using biometrics
  • POSTVerify Mobile OTP in an existing transaction./v1/registration/aadhaar/verifyMobileOTPVerify Mobile OTP in an existing transaction.
  • POSTVerify Aadhaar OTP and continue for mobile verification./v1/registration/aadhaar/verifyOTPVerify Aadhaar OTP received on registrered mobile number

Registration with mobile number

  • POSTCreate Health ID with verified mobile token/v1/registration/mobile/createHealthId
  • POSTGenerate Mobile OTP to start registration/v1/registration/mobile/generateOtpGenerate Mobile OTP to start registration transaction.
  • POSTResend Mobile OTP for Health ID registration/v1/registration/mobile/resendOtpResend Mobile OTP in an existing transaction in case previous OTP is not received.
  • POSTVerify Mobile OTP sent as part of registration transaction./v1/registration/mobile/verifyOtpVerify Mobile OTP in current registration transaction.

Search

  • POSTSearch a user by Health IDs./v1/search/existsByHealthId
  • POSTSearch a user by Health ID Number./v1/search/searchByHealthId
  • POSTSearch users with a mobile number./v1/search/searchByMobile

Tags

  • GETGet list of Tags against HealthID./v1/ha/tags
  • POSTAdd tag against HealthId./v1/ha/tags
  • DELETEDelete tag against HealthId./v1/ha/tags

Utility

  • GETGet a list of districts in a given State as per LGD./v1/ha/lgd/districts?stateCode=string
  • GETGet a list of states as per LGD./v1/ha/lgd/states

API details

Base URL
https://healthidsbx.ndhm.gov.in/api
Authentication
An API key in the Authorization header
An API key in the X-HIP-ID header
Operations
73 operations on 69 pathsPOST 58GET 13DELETE 2
Main resources
Profile 16Integrated Programs 14Authentication 11Registration with Aadhaar 9Health Facility 7Forgot health id/number 4Registration with mobile number 4Search 3Tags 3Utility 2
Response formats
*/* image/png
Description format
OpenAPI 3.0.1, API version 1.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Health ID Service in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Health ID Service collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Authenticate using Health ID number / Health ID and password” (POST /v1/auth/authPassword), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Health ID Service?

It is important to standardize the process of identification of an individual across healthcare providers, to ensure that the created medical records are… It is listed under Government & public and has 73 endpoints.

Who publishes the Health ID Service?

It is listed from Ndhm's public API description (an OpenAPI document), not published by Ndhm on Swastik Codes. Anyone who controls ndhm.gov.in can claim the profile by adding a DNS TXT record.

What is the base URL of the Health ID Service?

Requests go to https://healthidsbx.ndhm.gov.in/api. Endpoint paths are added to this base URL.

How do I authenticate with the Health ID Service?

It accepts 2 methods: an API key in the Authorization header; an API key in the X-HIP-ID header.

How many endpoints does the Health ID Service have?

73 operations on 69 paths (58 POST, 13 GET, 2 DELETE). The largest groups are Profile, Integrated Programs, Authentication, Registration with Aadhaar.

Is forking the Health ID Service free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.