integrations.sh
← all integrations

ndhm.gov.in – ndhm-healthid

OpenAPI apis-guru open_data

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.

Homepage
https://api.apis.guru/v2/specs/ndhm.gov.in:ndhm-healthid/1.0.json
Provider
ndhm.gov.in:ndhm-healthid / ndhm-healthid
OpenAPI version
3.0.1
Spec (JSON)
https://api.apis.guru/v2/specs/ndhm.gov.in/ndhm-healthid/1.0/openapi.json
Spec (YAML)
https://api.apis.guru/v2/specs/ndhm.gov.in/ndhm-healthid/1.0/openapi.yaml

Tools (75)

Extracted live via the executor SDK.

  • authentication.authAccountPasswordRequestUsingPost

    Authentication with PASSWORD based auth transaction.

  • authentication.authenticateUserUsingPost

    Authenticate request to generate Mobile OTP using Health ID number / Health ID

  • authentication.authenticateWithPasswordUsingPost

    Authenticate using Health ID number / Health ID and password

  • authentication.authWithMobileTokenUsingPost

    Authenticate using verified Mobile Number and user data

  • authentication.certUsingGet

    Auth token public key.

  • authentication.confirmWithAadhaarBioUsingPost

    Authentication with Aadhaar Biometric based auth transaction.

  • authentication.confirmWithAadhaarOtpUsingPost

    Authentication with Aadhaar OTP based auth transaction.

  • authentication.confirmWithDemographicsUsingPost

    Authenticate using demographic data of user.

  • authentication.confirmWithMobileUsingPost

    Authentication with Mobile OTP based auth transaction.

  • authentication.initiateAuthUsingPost

    Initiate authentication process for given Health ID

  • authentication.resendAuthMobileOtpUsingPost

    Resend Aadhaar/Mobile OTP for Authentication Transaction.

  • forgotHealthIdNumber.generateAadharOtpUsingPost1

    Generate Aadhaar OTP on registrered mobile number

  • forgotHealthIdNumber.generateMobileOtpUsingPost

    Generate Mobile OTP to start registration transaction.

  • forgotHealthIdNumber.retrievalHealthIdByAadharUsingPost

    Verify aadhar OTP sent as part of forgetHealth id.

  • forgotHealthIdNumber.retrievalHealthIdByMobileUsingPost

    Verify Mobile OTP sent as part of forgetHealth id.

  • healthFacility.authenticateHealthFacilityUsingPost

    Generate token for heath facility id.

  • healthFacility.changePasswordUsingPost

    Change password for heath facility id.

  • healthFacility.createAadhaarAccountUsingPost1

    Generate Health ID card SVG

  • healthFacility.generateFacilityOtpUsingPost

    Generate health facility OTP on registrered mobile number

  • healthFacility.generatePasswordUsingPost

    Generates password for heath facility id.

  • healthFacility.generateSvgCardUsingGet1

    generateSvgCard

  • healthFacility.resetPasswordUsingPost

    Reset password for heath facility id.

  • integratedPrograms.createHealthIdByDemoAuthUsingPost

    Create health id using Aadhaar Demo Auth.

  • integratedPrograms.createHealthIdByMobileUsingPost

    Create health id using mobile Authentication.

  • integratedPrograms.delinkHidBenefitUsingPost

    De-Linked with hid.

  • integratedPrograms.findByAadharUsingPost

    Search health id number using aadhar or aadhar token.

  • integratedPrograms.findByHealthIdUsingPost

    Search benefit using health id number

  • integratedPrograms.generateAadharOtpUsingPost2

    Generate Aadhaar OTP on registrered mobile number

  • integratedPrograms.generateMobileOtpUsingPost

    Generate mobile OTP on registrered mobile number

  • integratedPrograms.linkHidBenefitUsingPost

    Linked with hid.

  • integratedPrograms.notifyBenefitUsingPost

    Create health id using notify Benefit.

  • integratedPrograms.updateAccountInformationUsingPost1

    Update account information

  • integratedPrograms.updateMobileInformationUsingPost

    Update mobile number for account.

  • integratedPrograms.updateStatusUsingPost

    Update health id status.

  • integratedPrograms.verifyAadharOtpUsingPost

    Create health id using Aadhaar number opt

  • integratedPrograms.verifyBioUsingPost

    Create health id using Biometric Authentication.

  • profile.changePasswordViaAadharUsingPost

    Change password via Aadhar for heath id.

  • profile.changePasswordViaMobileUsingPost

    Change password via mobile for heath id.

  • profile.changePasswordViaUsingPost

    Change password via password for heath id.

  • profile.deleteAccountUsingDelete

    Delete account

  • profile.generateAadharOtpUsingGet

    Generate Aadhaar OTP on registrered mobile number.

  • profile.generateCardUsingGet

    Generate Health ID card in PDF format

  • profile.generateMobileOtpUsingGet

    Generate Mobile OTP to start registration.

  • profile.generatePngCardUsingGet

    Generate Health ID card PNG

  • profile.generatereKycAadharOtpUsingPost

    Generate Aadhaar OTP on registrered for link account with aadhar number

  • profile.generateSvgCardUsingGet

    Generate Health ID card SVG

  • profile.getAccountInformationUsingGet

    Get account information.

  • profile.getBenefitsUsingGet

    Get List of Benefits associated with HealthID.

  • profile.getQrCodeUsingGet

    Get Quick Response code in PNG format for this account.

  • profile.updateAccountInformationUsingPost

    Update account information

  • profile.validateTokenUsingPost

    Validate auth token

  • profile.verifyAadharOtpOnlyUsingPost1

    Verify Aadhaar OTP to complete KYC/re-KYC verification

  • registrationWithAadhaar.createAadhaarAccountUsingPost

    Create Health ID using pre-verified Aadhaar & Mobile.

  • registrationWithAadhaar.generateAadharOtpUsingPost

    Generate Aadhaar OTP on registrered mobile number

  • registrationWithAadhaar.generateMobileOtpForTxnUsingPost

    Generate Mobile OTP to verify mobile number.

  • registrationWithAadhaar.getHealthIdNumbersByAadharUsingPost

    Search health id number using aadhar.

  • registrationWithAadhaar.resendAadharOtpUsingPost

    Resend Aadhar OTP on registrered mobile number

  • registrationWithAadhaar.verifyAadharBioUsingPost

    Verify Aadhaar using biometrics

  • registrationWithAadhaar.verifyAadharOtpOnlyUsingPost

    Verify Aadhaar OTP received on registrered mobile number

  • registrationWithAadhaar.verifyAadharOtpUsingPost

    Verify Aadhar OTP received on registrered mobile number

  • registrationWithAadhaar.verifyMobileOtpForTxnUsingPost

    Verify Mobile OTP in an existing transaction.

  • registrationWithMobileNumber.generateMobileOtpUsingPost1

    Generate Mobile OTP to start registration transaction.

  • registrationWithMobileNumber.resentOtpUsingPost

    Resend Mobile OTP in an existing transaction in case previous OTP is not received.

  • registrationWithMobileNumber.verifyMobileOtpUsingPost

    Verify Mobile OTP in current registration transaction.

  • registrationWithMobileNumber.verifyUserViaMobileUsingPost

    Create Health ID with verified mobile token

  • search.searchUserByAccountUsingPost

    Search a user by Health ID Number.

  • search.searchUserByMobileUsingPost

    Search users with a mobile number.

  • search.searchUserByUseridUsingPost

    Search a user by Health IDs.

  • tags.addTagUsingPost

    Add tag against HealthId.

  • tags.deleteTagUsingDelete

    Delete tag against HealthId.

  • tags.getTagsUsingGet

    Get list of Tags against HealthID.

  • utility.getDistrictsInStateUsingGet

    Get a list of districts in a given State as per LGD.

  • utility.getStatesUsingGet

    Get a list of states as per LGD.

  • openapi.previewSpec

    Preview an OpenAPI document before adding it as a source

  • openapi.addSource

    Add an OpenAPI source and register its operations as tools