# ABDM Developer Portal > Documentation for integrating with ABDM, India's health data exchange: the HIE-CM gateway milestones M1 to M3, the ABHA, HPR and HFR registries, UHI, and the NHCX claims exchange between hospitals and insurers. Nothing here has been run against the ABDM sandbox unless a page says so, so treat request and response shapes as unconfirmed. Add `.md` to any link below to get that page as markdown. Individual API operations are not listed here: each module has its own `llms.txt` naming every call it carries, linked under Optional. `llms-full.txt` beside this file carries every page in one document. ## docs/hiecm - [Get started](https://nhcx.sbxstage.in/docs/hiecm/v3): Connect your application to India's Interoperable Digital Health Infrastructure, from sandbox credentials to your first call to going live. - [API references](https://nhcx.sbxstage.in/docs/hiecm/v3/api): Every operation published for this gateway, module by module. - [Gateway session](https://nhcx.sbxstage.in/docs/hiecm/v3/api/gateway): Every ABDM call carries a bearer token from one endpoint. This is that endpoint, plus the certificate and bridge registration calls that sit beside it. - [1. Fetch the service ids registered against a bridge](https://nhcx.sbxstage.in/docs/hiecm/v3/api/gateway/endpoints/gateway-abdm-gateway/01-gateway-get-gateway-v3-bridge-services): Retrieve the unique identifiers, known as service IDs, that are associated with a specific bridge. In this context, a bridge acts as an intermediary... - [2. Fetch the details of a service ID](https://nhcx.sbxstage.in/docs/hiecm/v3/api/gateway/endpoints/gateway-abdm-gateway/02-gateway-get-gateway-v3-bridge-service-serviceid-service-id): Retrieve the details associated with a specific service ID. When invoked, it queries the system to fetch comprehensive information about the service... - [3. Update the bridge URL](https://nhcx.sbxstage.in/docs/hiecm/v3/api/gateway/endpoints/gateway-abdm-gateway/03-gateway-patch-gateway-v3-bridge-url): Update the URL of a bridge. When invoked, it allows users to modify the existing URL associated with a specific bridge. This functionality is crucial for... - [1. Generate access token](https://nhcx.sbxstage.in/docs/hiecm/v3/api/gateway/endpoints/gateway-abdm-sessions/01-gateway-post-gateway-v3-sessions): Generate an access token. When invoked, it facilitates the authentication process by providing a secure token that can be used to access various services... - [M1 Identity: Create and verify ABHA](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1): M1 base URLs and the operations grouped by use case. - [1. Search ABHA address (auth methods)](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-abha-address-login-aadhaar-otp/01-m1-post-v3-phr-web-login-abha-search-abha-address-login-a-de8184): Endpoint: POST /abha/api/v3/phr/web/login/abha/search - [2. ABHA address login via Aadhaar OTP - send OTP](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-abha-address-login-aadhaar-otp/02-m1-post-v3-phr-web-login-abha-request-otp-aadhaar-otp): Starts login with an ABHA address. UIDAI sends an OTP to the Aadhaar-linked mobile. loginId is the RSA-encrypted ABHA address. Use *Search ABHA address... - [3. ABHA address login via Aadhaar OTP - verify](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-abha-address-login-aadhaar-otp/03-m1-post-v3-phr-web-login-abha-verify-aadhaar-otp): Verifies the Aadhaar OTP for ABHA-address login. Returns the linked ABHA address(es) in users and tokens.token. Send that token as the X-token header to the... - [4. Get ABHA-address profile](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-abha-address-login-aadhaar-otp/04-m1-get-v3-phr-web-login-profile-abha-profile-abha-address-c04e83): Endpoint: GET /abha/api/v3/phr/web/login/profile/abha-profile - [5. Get PHR card](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-abha-address-login-aadhaar-otp/05-m1-get-v3-phr-web-login-profile-abha-phr-card-abha-addres-817c0d): Endpoint: GET /abha/api/v3/phr/web/login/profile/abha/phr-card - [6. Get ABHA-address QR code](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-abha-address-login-aadhaar-otp/06-m1-get-v3-phr-web-login-profile-abha-qr-code-abha-address-26c955): Endpoint: GET /abha/api/v3/phr/web/login/profile/abha/qr-code - [1. ABHA address login via Fingerprint - send authentication request](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-abha-address-login-fingerprint/01-m1-post-v3-phr-web-login-abha-request-otp-fingerprint): Starts fingerprint login with an ABHA address. loginId is the RSA-encrypted ABHA address. Use the returned txnId in *ABHA address login via Fingerprint -... - [2. ABHA address login via Fingerprint - verify](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-abha-address-login-fingerprint/02-m1-post-v3-phr-web-login-abha-verify-fingerprint): Completes fingerprint login with an ABHA address. Send the txnId and the fingerprint PID. Returns users and tokens.token (send it as X-token to the profile,... - [3. Get ABHA-address profile](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-abha-address-login-fingerprint/03-m1-get-v3-phr-web-login-profile-abha-profile-abha-address-8ec4ee): Endpoint: GET /abha/api/v3/phr/web/login/profile/abha-profile - [4. Get PHR card](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-abha-address-login-fingerprint/04-m1-get-v3-phr-web-login-profile-abha-phr-card-abha-addres-e751bf): Endpoint: GET /abha/api/v3/phr/web/login/profile/abha/phr-card - [5. Get ABHA-address QR code](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-abha-address-login-fingerprint/05-m1-get-v3-phr-web-login-profile-abha-qr-code-abha-address-91c62b): Endpoint: GET /abha/api/v3/phr/web/login/profile/abha/qr-code - [1. ABHA address login via IRIS - send authentication request](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-abha-address-login-iris/01-m1-post-v3-phr-web-login-abha-request-otp-iris): Starts IRIS login with an ABHA address. loginId is the RSA-encrypted ABHA address. Use the returned txnId in *ABHA address login via IRIS - verify*. - [2. ABHA address login via IRIS - verify](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-abha-address-login-iris/02-m1-post-v3-phr-web-login-abha-verify-iris): Completes IRIS login with an ABHA address. Send the txnId and the IRIS PID. Returns users and tokens.token (send it as X-token to the profile, PHR card and... - [3. Get ABHA-address profile](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-abha-address-login-iris/03-m1-get-v3-phr-web-login-profile-abha-profile-abha-address-809900): Endpoint: GET /abha/api/v3/phr/web/login/profile/abha-profile - [4. Get PHR card](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-abha-address-login-iris/04-m1-get-v3-phr-web-login-profile-abha-phr-card-abha-addres-b64ebf): Endpoint: GET /abha/api/v3/phr/web/login/profile/abha/phr-card - [5. Get ABHA-address QR code](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-abha-address-login-iris/05-m1-get-v3-phr-web-login-profile-abha-qr-code-abha-address-4b4e10): Endpoint: GET /abha/api/v3/phr/web/login/profile/abha/qr-code - [1. Search ABHA address (auth methods)](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-abha-address-login-mobile-otp/01-m1-post-v3-phr-web-login-abha-search-abha-address-login-m-27a20f): Endpoint: POST /abha/api/v3/phr/web/login/abha/search - [2. ABHA address login via Mobile OTP - send OTP](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-abha-address-login-mobile-otp/02-m1-post-v3-phr-web-login-abha-request-otp-mobile-otp): Starts login with an ABHA address. ABDM sends an OTP to the mobile linked with the ABHA address. loginId is the RSA-encrypted ABHA address. Use *Search ABHA... - [3. ABHA address login via Mobile OTP - verify](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-abha-address-login-mobile-otp/03-m1-post-v3-phr-web-login-abha-verify-mobile-otp): Verifies the mobile OTP for ABHA-address login. Returns the linked ABHA address(es) in users and tokens.token. Send that token as the X-token header to the... - [4. Get ABHA-address profile](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-abha-address-login-mobile-otp/04-m1-get-v3-phr-web-login-profile-abha-profile-abha-address-b038c4): Endpoint: GET /abha/api/v3/phr/web/login/profile/abha-profile - [5. Get PHR card](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-abha-address-login-mobile-otp/05-m1-get-v3-phr-web-login-profile-abha-phr-card-abha-addres-e1bae9): Endpoint: GET /abha/api/v3/phr/web/login/profile/abha/phr-card - [6. Get ABHA-address QR code](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-abha-address-login-mobile-otp/06-m1-get-v3-phr-web-login-profile-abha-qr-code-abha-address-a48785): Endpoint: GET /abha/api/v3/phr/web/login/profile/abha/qr-code - [1. Get ABHA QR code](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-abha-card-profile/01-m1-get-v3-profile-account-qrcode): Endpoint: GET /abha/api/v3/profile/account/qrCode - [2. Retrieve ABHA card image](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-abha-card-profile/02-m1-get-v3-profile-account-abha-card): Endpoint: GET /abha/api/v3/profile/account/abha-card - [3. Get ABHA profile](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-abha-card-profile/03-m1-get-v3-profile-account): Endpoint: GET /abha/api/v3/profile/account - [4. Download ABHA card](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-abha-card-profile/04-m1-get-v3-profile-account-download-abha-card): Endpoint: GET /abha/api/v3/profile/account/download-ABHA-card - [5. Refresh user token](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-abha-card-profile/05-m1-get-v3-profile-account-request-token): Endpoint: GET /abha/api/v3/profile/account/request/token - [1. Generate access token](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-access-tokens-encryption/01-gateway-post-gateway-v3-sessions): Generate an access token. When invoked, it facilitates the authentication process by providing a secure token that can be used to access various services... - [2. Get public certificate (RSA encryption key)](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-access-tokens-encryption/02-m1-get-v3-profile-public-certificate): Fetch the public key used for encryption of Aadhaar, OTP, mobile and other fields which require encryption. - [1. Create ABHA - Demographic authentication (Demo Auth)](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-benefit-child-abha/01-m1-post-v3-enrollment-enrol-byaadhaar-demo-auth-benefit-c-d20a11): Creates an ABHA number from Aadhaar demographic details (name, DOB, gender, state/district, mobile), without OTP or biometric. If an ABHA already exists for... - [2. Create Child ABHA](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-benefit-child-abha/02-m1-post-v3-enrollment-enrol-byaadhaar-child-benefit-child-abha): Creates a Child ABHA linked to the parent's ABHA. Send the parent's X-token (from the parent's ABHA creation or login) and Benefit-Name.Only for Government... - [3. Get Child ABHA list of the parent](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-benefit-child-abha/03-m1-get-v3-enrollment-profile-children-benefit-child-abha): Endpoint: GET /abha/api/v3/enrollment/profile/children - [4. Update Child ABHA profile](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-benefit-child-abha/04-m1-patch-v3-profile-account-child-benefit-child-abha): Updates the demographic details (name, DOB, gender) of a Child ABHA. Send Benefit-Name and the X-token from the Child ABHA creation response. A non-KYC... - [5. Child ABHA KYC - send Aadhaar OTP](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-benefit-child-abha/05-m1-post-v3-profile-account-request-otp-child-kyc-benefit-ec9035): Starts KYC of a non-KYC Child ABHA. UIDAI sends an OTP to the mobile linked with the child's Aadhaar number. Send the child's X-token. - [6. Child ABHA KYC - verify Aadhaar OTP](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-benefit-child-abha/06-m1-post-v3-profile-account-verify-child-kyc-benefit-child-abha): Verifies the Aadhaar OTP sent by *Child ABHA KYC - send Aadhaar OTP* and marks the Child ABHA as KYC verified. - [1. Create ABHA - Demographic authentication (Demo Auth)](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-benefit-create-abha-via-demo-auth/01-m1-post-v3-enrollment-enrol-byaadhaar-demo-auth-benefit-c-d5c7c3): Creates an ABHA number from Aadhaar demographic details (name, DOB, gender, state/district, mobile), without OTP or biometric. If an ABHA already exists for... - [1. Link / De-link benefit using X-token](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-benefit-link-de-link/01-m1-post-v3-profile-benefit-linkanddelink-x-token): Links (scope: [\"link\"]) or de-links (scope: [\"de-link\"]) the benefit named in the BENEFIT_NAME header for the ABHA of the logged-in user (X-token). The body... - [2. Link / De-link benefit using ABHA number](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-benefit-link-de-link/02-m1-post-v3-profile-benefit-linkanddelink-abha-number): Links (scope: [\"link\"]) or de-links (scope: [\"de-link\"]) the benefit named in the BENEFIT_NAME header for an ABHA number. loginId is the RSA-encrypted ABHA... - [3. Link / De-link benefit using xmlUid](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-benefit-link-de-link/03-m1-post-v3-profile-benefit-linkanddelink-xmluid): Links (scope: [\"link\"]) or de-links (scope: [\"de-link\"]) the benefit named in the BENEFIT_NAME header for an Aadhaar xmlUid. loginId is the RSA-encrypted... - [1. Benefit search by xmlUid](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-benefit-search/01-m1-post-v3-profile-benefit-search-xmluid): Lists the benefit programmes linked to an Aadhaar xmlUid. loginId is the RSA-encrypted xmlUid. - [2. Benefit search by ABHA number](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-benefit-search/02-m1-post-v3-profile-benefit-search-abha-number): Lists the benefit programmes linked to an ABHA number. loginId is the RSA-encrypted ABHA number. - [3. Get benefits linked to an ABHA number](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-benefit-search/03-m1-get-v3-profile-benefit-abha-abhanumber): Endpoint: GET /abha/api/v3/profile/benefit/abha/{abhanumber} - [1. Create Child ABHA](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-child-abha/01-m1-post-v3-enrollment-enrol-byaadhaar-child-child-abha): Creates a Child ABHA linked to the parent's ABHA. Send the parent's X-token (from the parent's ABHA creation or login) and Benefit-Name.Only for Government... - [2. Get Child ABHA list of the parent](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-child-abha/02-m1-get-v3-enrollment-profile-children-child-abha): Endpoint: GET /abha/api/v3/enrollment/profile/children - [3. Update Child ABHA profile](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-child-abha/03-m1-patch-v3-profile-account-child-child-abha): Updates the demographic details (name, DOB, gender) of a Child ABHA. Send Benefit-Name and the X-token from the Child ABHA creation response. A non-KYC... - [4. Child ABHA KYC - send Aadhaar OTP](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-child-abha/04-m1-post-v3-profile-account-request-otp-child-kyc-child-abha): Starts KYC of a non-KYC Child ABHA. UIDAI sends an OTP to the mobile linked with the child's Aadhaar number. Send the child's X-token. - [5. Child ABHA KYC - verify Aadhaar OTP](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-child-abha/05-m1-post-v3-profile-account-verify-child-kyc-child-abha): Verifies the Aadhaar OTP sent by *Child ABHA KYC - send Aadhaar OTP* and marks the Child ABHA as KYC verified. - [1. Send Aadhaar OTP for ABHA enrolment](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-create-abha-aadhaar-otp/01-m1-post-v3-enrollment-request-otp-aadhaar-otp): Starts ABHA creation with Aadhaar OTP. UIDAI sends an OTP to the mobile number linked with the Aadhaar number. Use the txnId from the response in *Create... - [2. Create ABHA - verify Aadhaar OTP](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-create-abha-aadhaar-otp/02-m1-post-v3-enrollment-enrol-byaadhaar-otp): Verifies the Aadhaar OTP and creates the ABHA number, or returns the existing ABHA if one is already linked to the Aadhaar. The response contains the ABHA... - [3. After ABHA creation - send OTP to verify mobile (optional)](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-create-abha-aadhaar-otp/03-m1-post-v3-enrollment-request-otp-mobile-verify-create-ab-1b66bb): Optional, called after the ABHA is created. Needed only when the mobile sent in the create-ABHA call is not the Aadhaar-linked mobile. ABDM sends an OTP to... - [4. After ABHA creation - verify mobile OTP (optional)](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-create-abha-aadhaar-otp/04-m1-post-v3-enrollment-auth-byabdm-mobile-verify-create-ab-091285): Verifies the OTP sent by *After ABHA creation - send OTP to verify mobile (optional)* and links the mobile number to the newly created ABHA. - [5. After ABHA creation - send OTP to verify email (optional)](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-create-abha-aadhaar-otp/05-m1-post-v3-enrollment-request-otp-email-verify-create-abh-ddbed1): Optional. Sends an ABDM OTP to an email address so it can be linked to the newly created ABHA. Send the txnId from the previous enrolment step. - [6. After ABHA creation - verify email OTP (optional)](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-create-abha-aadhaar-otp/06-m1-post-v3-enrollment-auth-byabdm-email-verify-create-abh-6d732c): Verifies the OTP sent by *After ABHA creation - send OTP to verify email (optional)* and links the email address to the newly created ABHA. - [7. After ABHA creation - get ABHA address suggestions](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-create-abha-aadhaar-otp/07-m1-get-v3-enrollment-enrol-suggestion-create-abha-aadhaar-otp): Endpoint: GET /abha/api/v3/enrollment/enrol/suggestion - [8. After ABHA creation - create ABHA address](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-create-abha-aadhaar-otp/08-m1-post-v3-enrollment-enrol-abha-address-create-abha-aadhaar-otp): Endpoint: POST /abha/api/v3/enrollment/enrol/abha-address - [1. Create ABHA - Demographic authentication (Demo Auth)](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-create-abha-demo-auth/01-m1-post-v3-enrollment-enrol-byaadhaar-demo-auth-create-ab-81107d): Creates an ABHA number from Aadhaar demographic details (name, DOB, gender, state/district, mobile), without OTP or biometric. If an ABHA already exists for... - [1. Face auth - generate transaction ID (init)](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-create-abha-face-authentication/01-m1-post-v3-enrollment-enrol-auth-init-create-abha-face-au-4dea33): Endpoint: POST /abha/api/v3/enrollment/enrol/auth/init - [2. Face auth - capture PID / track status](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-create-abha-face-authentication/02-m1-post-v3-enrollment-enrol-capturepid-create-abha-face-a-417d5e): Endpoint: POST /abha/api/v3/enrollment/enrol/capturePID - [3. Create ABHA - Aadhaar face authentication](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-create-abha-face-authentication/03-m1-post-v3-enrollment-enrol-byaadhaar-face): Creates an ABHA number with Aadhaar face authentication. First call *Face auth - generate transaction ID (init)*, then poll *Face auth - capture PID / track... - [4. After ABHA creation - send OTP to verify mobile (optional)](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-create-abha-face-authentication/04-m1-post-v3-enrollment-request-otp-mobile-verify-create-ab-6474ce): Optional, called after the ABHA is created. Needed only when the mobile sent in the create-ABHA call is not the Aadhaar-linked mobile. ABDM sends an OTP to... - [5. After ABHA creation - verify mobile OTP (optional)](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-create-abha-face-authentication/05-m1-post-v3-enrollment-auth-byabdm-mobile-verify-create-ab-b555fb): Verifies the OTP sent by *After ABHA creation - send OTP to verify mobile (optional)* and links the mobile number to the newly created ABHA. - [6. After ABHA creation - send OTP to verify email (optional)](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-create-abha-face-authentication/06-m1-post-v3-enrollment-request-otp-email-verify-create-abh-880d7e): Optional. Sends an ABDM OTP to an email address so it can be linked to the newly created ABHA. Send the txnId from the previous enrolment step. - [7. After ABHA creation - verify email OTP (optional)](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-create-abha-face-authentication/07-m1-post-v3-enrollment-auth-byabdm-email-verify-create-abh-d8de3e): Verifies the OTP sent by *After ABHA creation - send OTP to verify email (optional)* and links the email address to the newly created ABHA. - [8. After ABHA creation - get ABHA address suggestions](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-create-abha-face-authentication/08-m1-get-v3-enrollment-enrol-suggestion-create-abha-face-au-848b26): Endpoint: GET /abha/api/v3/enrollment/enrol/suggestion - [9. After ABHA creation - create ABHA address](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-create-abha-face-authentication/09-m1-post-v3-enrollment-enrol-abha-address-create-abha-face-4b1f33): Endpoint: POST /abha/api/v3/enrollment/enrol/abha-address - [1. Create ABHA - Aadhaar fingerprint (bio)](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-create-abha-fingerprint/01-m1-post-v3-enrollment-enrol-byaadhaar-fingerprint): Creates an ABHA number by authenticating the Aadhaar holder's fingerprint. The PID block is captured with a UIDAI-registered fingerprint RD device. The... - [2. After ABHA creation - send OTP to verify mobile (optional)](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-create-abha-fingerprint/02-m1-post-v3-enrollment-request-otp-mobile-verify-create-ab-64b04e): Optional, called after the ABHA is created. Needed only when the mobile sent in the create-ABHA call is not the Aadhaar-linked mobile. ABDM sends an OTP to... - [3. After ABHA creation - verify mobile OTP (optional)](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-create-abha-fingerprint/03-m1-post-v3-enrollment-auth-byabdm-mobile-verify-create-ab-3b237a): Verifies the OTP sent by *After ABHA creation - send OTP to verify mobile (optional)* and links the mobile number to the newly created ABHA. - [4. After ABHA creation - send OTP to verify email (optional)](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-create-abha-fingerprint/04-m1-post-v3-enrollment-request-otp-email-verify-create-abh-4833d9): Optional. Sends an ABDM OTP to an email address so it can be linked to the newly created ABHA. Send the txnId from the previous enrolment step. - [5. After ABHA creation - verify email OTP (optional)](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-create-abha-fingerprint/05-m1-post-v3-enrollment-auth-byabdm-email-verify-create-abh-b696ba): Verifies the OTP sent by *After ABHA creation - send OTP to verify email (optional)* and links the email address to the newly created ABHA. - [6. After ABHA creation - get ABHA address suggestions](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-create-abha-fingerprint/06-m1-get-v3-enrollment-enrol-suggestion-create-abha-fingerprint): Endpoint: GET /abha/api/v3/enrollment/enrol/suggestion - [7. After ABHA creation - create ABHA address](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-create-abha-fingerprint/07-m1-post-v3-enrollment-enrol-abha-address-create-abha-fingerprint): Endpoint: POST /abha/api/v3/enrollment/enrol/abha-address - [1. Create ABHA - Aadhaar IRIS](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-create-abha-iris/01-m1-post-v3-enrollment-enrol-byaadhaar-iris): Creates an ABHA number by authenticating the Aadhaar holder's IRIS. The PID block is captured with a UIDAI-registered IRIS RD device. The response contains... - [2. After ABHA creation - send OTP to verify mobile (optional)](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-create-abha-iris/02-m1-post-v3-enrollment-request-otp-mobile-verify-create-abha-iris): Optional, called after the ABHA is created. Needed only when the mobile sent in the create-ABHA call is not the Aadhaar-linked mobile. ABDM sends an OTP to... - [3. After ABHA creation - verify mobile OTP (optional)](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-create-abha-iris/03-m1-post-v3-enrollment-auth-byabdm-mobile-verify-create-abha-iris): Verifies the OTP sent by *After ABHA creation - send OTP to verify mobile (optional)* and links the mobile number to the newly created ABHA. - [4. After ABHA creation - send OTP to verify email (optional)](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-create-abha-iris/04-m1-post-v3-enrollment-request-otp-email-verify-create-abha-iris): Optional. Sends an ABDM OTP to an email address so it can be linked to the newly created ABHA. Send the txnId from the previous enrolment step. - [5. After ABHA creation - verify email OTP (optional)](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-create-abha-iris/05-m1-post-v3-enrollment-auth-byabdm-email-verify-create-abha-iris): Verifies the OTP sent by *After ABHA creation - send OTP to verify email (optional)* and links the email address to the newly created ABHA. - [6. After ABHA creation - get ABHA address suggestions](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-create-abha-iris/06-m1-get-v3-enrollment-enrol-suggestion-create-abha-iris): Endpoint: GET /abha/api/v3/enrollment/enrol/suggestion - [7. After ABHA creation - create ABHA address](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-create-abha-iris/07-m1-post-v3-enrollment-enrol-abha-address-create-abha-iris): Endpoint: POST /abha/api/v3/enrollment/enrol/abha-address - [1. Search ABHA by mobile](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-find-abha-aadhaar-otp/01-m1-post-v3-profile-account-abha-search-find-abha-aadhaar-otp): Endpoint: POST /abha/api/v3/profile/account/abha/search - [2. Find ABHA via Aadhaar OTP - send OTP](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-find-abha-aadhaar-otp/02-m1-post-v3-profile-login-request-otp-find-abha-aadhaar): Sends an Aadhaar OTP for the ABHA account picked from *Search ABHA by mobile*. Send loginHint: index, the RSA-encrypted index of the chosen account, and the... - [3. Find ABHA via Aadhaar OTP - verify OTP](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-find-abha-aadhaar-otp/03-m1-post-v3-profile-login-verify-find-abha-aadhaar): Verifies the Aadhaar OTP for the chosen account. Returns the ABHA details and the user token. - [1. Search ABHA by mobile](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-find-abha-face/01-m1-post-v3-profile-account-abha-search-find-abha-face): Endpoint: POST /abha/api/v3/profile/account/abha/search - [2. Find ABHA via Face - send authentication request](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-find-abha-face/02-m1-post-v3-profile-login-request-otp-find-abha-face): Starts face authentication for the ABHA account picked from *Search ABHA by mobile*. Send loginHint: index, the RSA-encrypted index of the chosen account,... - [3. Face auth - capture PID / track status](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-find-abha-face/03-m1-post-v3-enrollment-enrol-capturepid-find-abha-face): Endpoint: POST /abha/api/v3/enrollment/enrol/capturePID - [4. Find ABHA via Face - verify](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-find-abha-face/04-m1-post-v3-profile-login-verify-find-abha-face): Completes face authentication for the chosen account. Once *Face auth - capture PID / track status* reports COMPLETE, send the same txnId here (the body has... - [1. Search ABHA by mobile](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-find-abha-fingerprint/01-m1-post-v3-profile-account-abha-search-find-abha-fingerprint): Endpoint: POST /abha/api/v3/profile/account/abha/search - [2. Find ABHA via Fingerprint - send authentication request](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-find-abha-fingerprint/02-m1-post-v3-profile-login-request-otp-find-abha-fingerprint): Starts fingerprint authentication for the ABHA account picked from *Search ABHA by mobile*. Send loginHint: index, the RSA-encrypted index of the chosen... - [3. Find ABHA via Fingerprint - verify](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-find-abha-fingerprint/03-m1-post-v3-profile-login-verify-find-abha-fingerprint): Completes fingerprint authentication for the chosen account. Send the txnId from *Find ABHA via Fingerprint - send authentication request* with the... - [1. Search ABHA by mobile](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-find-abha-iris/01-m1-post-v3-profile-account-abha-search-find-abha-iris): Endpoint: POST /abha/api/v3/profile/account/abha/search - [2. Find ABHA via IRIS - send authentication request](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-find-abha-iris/02-m1-post-v3-profile-login-request-otp-find-abha-iris): Starts IRIS authentication for the ABHA account picked from *Search ABHA by mobile*. Send loginHint: index, the RSA-encrypted index of the chosen account,... - [3. Find ABHA via IRIS - verify](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-find-abha-iris/03-m1-post-v3-profile-login-verify-find-abha-iris): Completes IRIS authentication for the chosen account. Send the txnId from *Find ABHA via IRIS - send authentication request* with the IRIS PID. - [1. Search ABHA by mobile](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-find-abha-mobile-otp/01-m1-post-v3-profile-account-abha-search-find-abha-mobile-otp): Endpoint: POST /abha/api/v3/profile/account/abha/search - [2. Find ABHA via Mobile - send OTP](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-find-abha-mobile-otp/02-m1-post-v3-profile-login-request-otp-find-abha-mobile): Sends a mobile OTP for the ABHA account picked from *Search ABHA by mobile*. Send loginHint: index, the RSA-encrypted index of the chosen account, and the... - [3. Find ABHA via Mobile - verify OTP](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-find-abha-mobile-otp/03-m1-post-v3-profile-login-verify-find-abha-mobile): Verifies the mobile OTP for the chosen account. Returns the ABHA details and the user token. - [1. Forgot ABHA via Aadhaar - send OTP](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-forgot-abha-aadhaar-otp/01-m1-post-v3-profile-login-request-otp-forgot-abha-aadhaar): Starts recovery of a forgotten ABHA number. UIDAI sends an OTP to the Aadhaar-linked mobile. - [2. Forgot ABHA via Aadhaar - verify OTP](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-forgot-abha-aadhaar-otp/02-m1-post-v3-profile-login-verify-forgot-abha-aadhaar): Verifies the Aadhaar OTP. Returns the ABHA linked to the Aadhaar number, with the user token. - [1. Forgot ABHA via Mobile - send OTP](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-forgot-abha-mobile-otp/01-m1-post-v3-profile-login-request-otp-forgot-abha-mobile): Starts recovery of a forgotten ABHA number. ABDM sends an OTP to the mobile number. - [2. Forgot ABHA via Mobile - verify OTP](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-forgot-abha-mobile-otp/02-m1-post-v3-profile-login-verify-forgot-abha-mobile): Verifies the mobile OTP. Returns the ABHA accounts linked to the mobile number, and a short-lived token. - [1. Login via Aadhaar number - send Aadhaar OTP](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-login-aadhaar-number/01-m1-post-v3-profile-login-request-otp-aadhaar): Starts login with an Aadhaar number. UIDAI sends an OTP to the Aadhaar-linked mobile. - [2. Login via Aadhaar number - verify Aadhaar OTP](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-login-aadhaar-number/02-m1-post-v3-profile-login-verify-aadhaar-otp): Verifies the Aadhaar OTP for Aadhaar-number login. Returns the user X-token (token) of the ABHA linked to the Aadhaar. - [1. Login via ABHA number - send Aadhaar OTP](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-login-abha-number-aadhaar-otp/01-m1-post-v3-profile-login-request-otp-abha-number-aadhaar-otp): Starts login with an ABHA number. UIDAI sends an OTP to the mobile linked with the Aadhaar of this ABHA. - [2. Login via ABHA number - verify Aadhaar OTP](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-login-abha-number-aadhaar-otp/02-m1-post-v3-profile-login-verify-abha-number-aadhaar-otp): Verifies the Aadhaar OTP for ABHA-number login. Returns the user X-token (token) and a refresh token. - [1. Login via ABHA number - send ABHA (mobile) OTP](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-login-abha-number-mobile-otp/01-m1-post-v3-profile-login-request-otp-abha-number-abha-otp): Starts login with an ABHA number. ABDM sends an OTP to the mobile registered with this ABHA. - [2. Login via ABHA number - verify ABHA (mobile) OTP](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-login-abha-number-mobile-otp/02-m1-post-v3-profile-login-verify-abha-number-abha-otp): Verifies the ABHA (mobile) OTP for ABHA-number login. Returns the user X-token (token) and a refresh token. - [1. Login via Biometric (Fingerprint) - v3.1 single step](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-login-biometric-v3-1/01-m1-post-v3-1-profile-login-verify-fingerprint): v3.1 fingerprint login in a single call. Send the encrypted Aadhaar number and the fingerprint PID. Returns the user X-token (token). No send-request step... - [2. Login via Biometric (Iris) - v3.1 single step](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-login-biometric-v3-1/02-m1-post-v3-1-profile-login-verify-iris): v3.1 IRIS login in a single call. Send the encrypted Aadhaar number and the IRIS PID. Returns the user X-token (token). No send-request step is needed. - [1. Login via Biometric (Fingerprint) - send authentication request](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-login-biometric-v3-fingerprint/01-m1-post-v3-profile-login-request-otp-biometric-fingerprint): Starts fingerprint login for an ABHA number. Use the returned txnId in *Login via Biometric (Fingerprint) - verify*. - [2. Login via Biometric (Fingerprint) - verify](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-login-biometric-v3-fingerprint/02-m1-post-v3-profile-login-verify-biometric-fingerprint): Completes fingerprint login. Send the txnId from *Login via Biometric (Fingerprint) - send authentication request* with the fingerprint PID. Returns the... - [1. Login via Biometric (Iris) - send authentication request](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-login-biometric-v3-iris/01-m1-post-v3-profile-login-request-otp-biometric-iris): Starts IRIS login for an ABHA number. Use the returned txnId in *Login via Biometric (Iris) - verify*. - [2. Login via Biometric (Iris) - verify](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-login-biometric-v3-iris/02-m1-post-v3-profile-login-verify-biometric-iris): Completes IRIS login. Send the txnId from *Login via Biometric (Iris) - send authentication request* with the IRIS PID. Returns the user X-token (token). - [1. Face auth - generate transaction ID (init)](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-login-face-auth-qr-v3-1/01-m1-post-v3-enrollment-enrol-auth-init-login-face-auth-qr-v3-1): Endpoint: POST /abha/api/v3/enrollment/enrol/auth/init - [2. Face auth - capture PID / track status](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-login-face-auth-qr-v3-1/02-m1-post-v3-enrollment-enrol-capturepid-login-face-auth-qr-v3-1): Endpoint: POST /abha/api/v3/enrollment/enrol/capturePID - [3. Login via Face Auth (QR) - verify](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-login-face-auth-qr-v3-1/03-m1-post-v3-1-profile-login-verify-face-auth-qr): Completes login through the face-auth QR / ABHA-app flow. First call *Face auth - generate transaction ID (init)*, then poll *Face auth - capture PID /... - [1. Login via Mobile number - send OTP](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-login-mobile-number/01-m1-post-v3-profile-login-request-otp-mobile): Starts login with a mobile number. ABDM sends an OTP to the mobile number. - [2. Login via Mobile number - verify OTP](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-login-mobile-number/02-m1-post-v3-profile-login-verify-mobile-otp): Verifies the mobile OTP. Returns a short-lived token (token, used as the T-token header) and the list of ABHA accounts linked to the mobile. Then call... - [3. Login via Mobile number - verify user (select ABHA)](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-login-mobile-number/03-m1-post-v3-profile-login-verify-user): Endpoint: POST /abha/api/v3/profile/login/verify/user - [1. Re-KYC - send Aadhaar OTP](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-profile-re-kyc/01-m1-post-v3-profile-account-request-otp-re-kyc): Starts Re-KYC of a logged-in ABHA (X-token). UIDAI sends an OTP to the Aadhaar-linked mobile. - [2. Re-KYC - verify Aadhaar OTP](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-profile-re-kyc/02-m1-post-v3-profile-account-verify-re-kyc): Verifies the Aadhaar OTP sent by *Re-KYC - send Aadhaar OTP* and refreshes the ABHA's KYC details from Aadhaar. - [1. Update mobile - send OTP](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-profile-update-mobile/01-m1-post-v3-profile-account-request-otp-update-mobile): Starts a mobile number change for a logged-in ABHA user (X-token). ABDM sends an OTP to the new mobile number. - [2. Update mobile - verify OTP](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-profile-update-mobile/02-m1-post-v3-profile-account-verify-update-mobile): Verifies the OTP sent by *Update mobile - send OTP* and updates the mobile number on the ABHA profile. - [1. Update profile photo](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/endpoints/m1-profile-update-photo/01-m1-patch-v3-profile-account-profile-photo): Updates the profile photo of the logged-in ABHA user (X-token). Send the photo as a Base64 string. - [M1 Identity errors](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/errors): What M1 Identity returns when a call fails, and what to do about it. - [M2 Health Information Provider: Create and link records](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m2): M2 base URLs and the operations grouped by use case. - [1. Perform HIP initiated linking](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m2/endpoints/m2-abdm-hip-initiated-linking-hip/01-m2-post-hip-v3-link-carecontext): Note: While generating the link-token the user/patient is providing both ABHA_number and ABHA_address, then at the time of linking both must be mandatory.... - [2. Notify a change to a linked care context](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m2/endpoints/m2-abdm-hip-initiated-linking-hip/02-m2-post-hip-v3-link-context-notify): Notify the Consent Management (CM) system about any updates HiTypes of the already linked care context for a patient. By invoking this API, Health... - [3. Send SMS notification to patient that a care context is linked](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m2/endpoints/m2-abdm-hip-initiated-linking-hip/03-m2-post-hip-v3-link-patient-links-sms-notify2): Send SMS notifications to patients, informing them that a care context has been successfully linked to their ABHA (Ayushman Bharat Health Account) address.... - [1. Generate link token to link the health records](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m2/endpoints/m2-abdm-link-token-hip/01-m2-post-v3-token-generate-token): Generate a link token which will be valid for 6 months.. This token can be used for Health Information Provider (HIP) Initiated Linking, enabling HIPs to... - [1. Answer the care context discovery](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m2/endpoints/m2-abdm-user-initiated-linking-hip/01-m2-post-user-initiated-linking-v3-patient-care-context-on-8c9340): Is invoked by the Hospital Management Information System (HMIS) or Laboratory Information Management System (LIMS) or HIP application to share the response... - [2. Link care context on init](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m2/endpoints/m2-abdm-user-initiated-linking-hip/02-m2-post-user-initiated-linking-v3-link-care-context-on-init): Share the response of the /api/hiecm/user-initiated-linking/v3/link/care-context/on-init API. By using this API, the HIP communicates the outcome of the... - [3. Link care context on confirm](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m2/endpoints/m2-abdm-user-initiated-linking-hip/03-m2-post-user-initiated-linking-v3-link-care-context-on-confirm): Share the response of the /api/hiecm/user-initiated-linking/v3/link/care-context/on-confirm API. By using this API, the HIP communicates the outcome of the... - [1. Receive the HIP token on generate token](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m2/endpoints/m2-callbacks/01-m2-post-v3-hip-token-on-generate-token): Hosted by the HIP/HIU, not by ABDM. ABDM calls this endpoint at the callback URL registered for your bridge, so the path below is relative to that URL.... - [2. Link on carecontext](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m2/endpoints/m2-callbacks/02-m2-post-v3-link-on-carecontext): Hosted by the HIP/HIU, not by ABDM. ABDM calls this endpoint at the callback URL registered for your bridge, so the path below is relative to that URL. This... - [3. Receive the links context on notify](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m2/endpoints/m2-callbacks/03-m2-post-v3-links-context-on-notify): Hosted by the HIP/HIU, not by ABDM. ABDM calls this endpoint at the callback URL registered for your bridge, so the path below is relative to that URL. This... - [4. Receive the patients SMS on notify](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m2/endpoints/m2-callbacks/04-m2-post-v3-patients-sms-on-notify): Hosted by the HIP/HIU, not by ABDM. ABDM calls this endpoint at the callback URL registered for your bridge, so the path below is relative to that URL. This... - [5. Discover care contexts associated with a patient](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m2/endpoints/m2-callbacks/05-m2-post-v3-hip-patient-care-context-discover): Hosted by the HIP/HIU, not by ABDM. ABDM calls this endpoint at the callback URL registered for your bridge, so the path below is relative to that URL. The... - [6. Initiate the linking of care contexts for a patient](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m2/endpoints/m2-callbacks/06-m2-post-v3-hip-link-care-context-init): Hosted by the HIP/HIU, not by ABDM. ABDM calls this endpoint at the callback URL registered for your bridge, so the path below is relative to that URL. The... - [7. Confirm the linking of care contexts for a patient](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m2/endpoints/m2-callbacks/07-m2-post-v3-hip-link-care-context-confirm): Hosted by the HIP/HIU, not by ABDM. ABDM calls this endpoint at the callback URL registered for your bridge, so the path below is relative to that URL. The... - [8. Receive the consent decision](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m2/endpoints/m2-callbacks/08-m2-post-v3-consent-request-hip-notify): Hosted by the HIP/HIU, not by ABDM. ABDM calls this endpoint at the callback URL registered for your bridge, so the path below is relative to that URL.... - [9. Receive the health information data request to HIP](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m2/endpoints/m2-callbacks/09-m2-post-v3-hip-health-information-request): Hosted by the HIP/HIU, not by ABDM. ABDM calls this endpoint at the callback URL registered for your bridge, so the path below is relative to that URL.... - [10. Receive the transferred health information](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m2/endpoints/m2-callbacks/10-m2-post-health-information-transfer): NOTE: This API is actually the callback URL that is passed as dataPushUrl in the data request API - /api/v3/hip/health-information/request. This API is... - [1. Acknowledge the consent notification](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m2/endpoints/m2-consent-management-data-flow-hip/01-m2-post-consent-v3-request-hip-on-notify): Notification of consents, in cases of consent approval, revocation and expiration. Notified by CM earlier via Gateway API - /api/v3/consent/request/hip/notify - [2. Submit the health information data request acknowledgement from HIP](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m2/endpoints/m2-consent-management-data-flow-hip/02-m2-post-data-flow-v3-health-information-hip-on-request): Acknowledge the Health information request receipt. Either the hiRequest or error must be specified. hiRequest element returns the same transaction ID as... - [3. Submit the notifications corresponding to events during data flow](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m2/endpoints/m2-consent-management-data-flow-hip/03-m2-post-data-flow-v3-health-information-notify): HIU and HIP during data transfer. HIP on the transfer of data would send sessionStatus - one of [TRANSFERRED, FAILED] HIP would also send hiStatus for each... - [M2 Health Information Provider errors](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m2/errors): What M2 Health Information Provider returns when a call fails, and what to do about it. - [M3 Health Information User: Fetch data with consent](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m3): The M3 operations grouped by use case. - [1. Receive the consent request for patient HIU](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m3/endpoints/m3-callbacks/01-m3-post-v3-hiu-consent-request-on-init): Hosted by the HIP/HIU, not by ABDM. ABDM calls this endpoint at the callback URL registered for your bridge, so the path below is relative to that URL.... - [2. Receive the consent status request](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m3/endpoints/m3-callbacks/02-m3-post-v3-hiu-consent-request-on-status): Hosted by the HIP/HIU, not by ABDM. ABDM calls this endpoint at the callback URL registered for your bridge, so the path below is relative to that URL. This... - [3. Notify HIU when consent is APPROVED, DENIED or REVOKED](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m3/endpoints/m3-callbacks/03-m3-post-v3-hiu-consent-request-notify): Hosted by the HIP/HIU, not by ABDM. ABDM calls this endpoint at the callback URL registered for your bridge, so the path below is relative to that URL.... - [4. Receive the provide fetched consent artefact details to HIU](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m3/endpoints/m3-callbacks/04-m3-post-v3-hiu-consent-on-fetch): Hosted by the HIP/HIU, not by ABDM. ABDM calls this endpoint at the callback URL registered for your bridge, so the path below is relative to that URL. This... - [5. Receive the health information data request acknowledgement to HIU](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m3/endpoints/m3-callbacks/05-m3-post-v3-hiu-health-information-on-request): Hosted by the HIP/HIU, not by ABDM. ABDM calls this endpoint at the callback URL registered for your bridge, so the path below is relative to that URL.... - [1. Initiate the consent request](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m3/endpoints/m3-consent-management-data-flow-hiu/01-m3-post-consent-v3-request-init): Create a consent request by a Health Information User (HIU) to access a patient’s health data. By invoking this API, the HIU initiates the process of... - [2. Get consent request status](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m3/endpoints/m3-consent-management-data-flow-hiu/02-m3-post-consent-v3-request-status): Retrieve the status of a previously initiated consent request. By invoking this API, users can check the current state of their consent request, whether it... - [3. Acknowledge the consent notification](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m3/endpoints/m3-consent-management-data-flow-hiu/03-m3-post-consent-v3-request-hiu-on-notify): Consent notifications, specifically for cases when consent is APPROVED, DENIED, or REVOKED or EXPIRED. Notified by CM earlier via Gateway API -... - [4. Fetch the consent details](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m3/endpoints/m3-consent-management-data-flow-hiu/04-m3-post-consent-v3-fetch): Fetch the details of a consent using the consent artefact ID. By invoking this API, HIUs can retrieve comprehensive information about a specific consent,... - [5. Submit the health information data request from HIU](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m3/endpoints/m3-consent-management-data-flow-hiu/05-m3-post-data-flow-v3-health-information-request): Facilitates the exchange of health data between Health Information Providers (HIP) and Health Information Users (HIU) within the ABDM system. It ensures... - [6. Submit the notifications corresponding to events during data flow](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m3/endpoints/m3-consent-management-data-flow-hiu/06-m3-post-data-flow-v3-health-information-notify): HIU and HIP during data transfer. HIP on the transfer of data would send sessionStatus - one of [TRANSFERRED, FAILED] HIP would also send hiStatus for each... - [7. Get the current status of the health information request](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m3/endpoints/m3-consent-management-data-flow-hiu/07-m3-get-data-flow-v3-health-information-request-status-tra-550104): Allow Health Information Users (HIU) and Health Information Providers (HIP) to retrieve the current status of a specific Health Information Request. By... - [M3 Health Information User errors](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m3/errors): What M3 Health Information User returns when a call fails, and what to do about it. - [Milestone 4 (M4): Register Healthcare Professionals and Facilities](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4): M4 base URLs and the HPR and HFR operations. - [1. Login via password](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-authentication/01-m4-post-v1-auth-authpassword): Login Via Password - [2. Get public certificate](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-authentication/02-m4-get-v1-auth-cert): Get Public Certificate - [3. Verify Aadhaar OTP 1](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-authentication/03-m4-post-v1-auth-confirmwithaadhaarotp): Verify Aadhaar OTP 1 - [4. Send via Aadhaar OTP](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-authentication/04-m4-post-v1-auth-init): Send Via Aadhaar OTP - [5. Send verify OTP](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-authentication/05-m4-post-v2-auth-loginviamobilesendotp): Send Verify OTP - [1. Register professional](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-enrollment/01-m4-post-v1-doctors-register-professional-new): Register Professional - [2. Update professional](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-enrollment/02-m4-post-v1-doctors-update-professional-new): Update Professional - [3. Fetch documents](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-enrollment/03-m4-post-v1-doctors-fetch-documents-list): Fetch Documents - [4. Upload documents](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-enrollment/04-m4-post-v1-uploads-upload-document): Upload Documents - [5. Get professional info](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-enrollment/05-m4-post-v1-doctors-fetch-professional-info): Get Professional Info - [1. Submit the retrieval health ID by Aadhaar](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-forgot-healthcare-professional-id-number/01-m4-post-v1-forgot-hprid-aadhaar): Retrieval Health ID By Aadhaar - [2. Submit the retrieval health ID by mobile](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-forgot-healthcare-professional-id-number/02-m4-post-v1-forgot-hprid-mobile): Retrieval Health ID By Mobile - [3. Generate mobile OTP](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-forgot-healthcare-professional-id-number/03-m4-post-v1-forgot-hprid-mobile-generateotp): Generate Mobile OTP - [1. Send OTP to contact](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-hfr-hrp-linkage-apis/01-m4-post-v1-5-facility-sendotptocontact): Send OTP To Contact - [2. Validate OTP](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-hfr-hrp-linkage-apis/02-m4-post-v1-5-facility-validateotp): Validate OTP - [1. Get admin token](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-hpid/01-m4-post-getmanagementtoken): Get Admin Token - [2. Submit the healdthloginwithmobile](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-hpid/02-m4-post-healdthloginwithmobile): Healdthloginwithmobile - [3. Update role and category](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-hpid/03-m4-post-profile-updaterole): Update Role And Category - [1. Fetch professional facility](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-hpr/01-m4-post-fetchprofessionalfacility): Fetch Professional Facility - [2. Create facility suggestion](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-hpr/02-m4-post-hprfacilitysuggestions): Create Facility Suggestion - [1. Submit the facility add and update](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-multiple-hrp-api/01-m4-post-v1-bridges-mutiplehrpaddupdateservices): Facility Add And Update - [1. Get filtered address post](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-onboarding-apis/01-m4-post-search-address-filter-deduplicate): Get Filtered Address Post - [2. Submit the v15Basic facility information](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-onboarding-apis/02-m4-post-v1-5-facility-basic-information): V15Basic Facility Information - [3. Submit the v15Facility additional information](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-onboarding-apis/03-m4-post-v1-5-facility-additional-information): V15Facility Additional Information - [4. Submit the v15Facility detailed information](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-onboarding-apis/04-m4-post-v1-5-facility-detailed-information): V15Facility Detailed Information - [5. Submit the v15Submit facility details](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-onboarding-apis/05-m4-post-v1-5-facility-submit-facility): V15Submit Facility Details - [1. Change password](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-profile/01-m4-post-password-change-bypassword): Change Password - [2. Recover password via Aadhaar](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-profile/02-m4-post-password-recover-byaadhaar): Recover Password Via Aadhaar - [3. Generate mobile OTP 1](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-profile/03-m4-post-password-recover-bymobile-sendmobileotp): Generate Mobile OTP 1 - [4. Verify mobile OTP 1](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-profile/04-m4-post-password-recover-bymobile-verifymobileotp): Verify Mobile OTP 1 - [5. Recover password confirm by Aadhaar](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-profile/05-m4-post-password-recover-confirmbyaadhaar): Recover Password Confirm By Aadhaar - [6. Reset password and session](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-profile/06-m4-post-password-reset-password): Reset Password And Session - [7. Reset password](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-profile/07-m4-post-password-resetpassword): Reset Password - [8. Get account png card](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-profile/08-m4-get-v1-account-getidcard): Get Account Png Card - [9. Get user profile by JWT](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-profile/09-m4-get-v1-account-information): Get User Profile By JWT - [10. Generate Aadhaar OTPFor re KYC](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-profile/10-m4-post-v1-account-rekyc-generateaadhaarotp): Generate Aadhaar OTPFor Re KYC - [11. Verify Aadhaar OTP](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-profile/11-m4-post-v1-account-rekyc-verifyaadhaarotp): Verify Aadhaar OTP - [12. Verify Aadhaar OTPGet details](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-profile/12-m4-post-v1-account-rekyc-verifyaadhaarotpgetdetails): Verify Aadhaar OTPGet Details - [13. Get user details](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-profile/13-m4-get-v1-account-user-details-hprid): Get User Details - [14. Logout](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-profile/14-m4-get-v4-auth-logout): Logout - [1. Generate Aadhaar link](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-registration-api-s-collection-via-aadhaar/01-m4-post-aadhaar-generatelink): Generate Aadhaar Link - [2. Submit the is Aadhaar authenticated](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-registration-api-s-collection-via-aadhaar/02-m4-post-aadhaar-isauthenticated): Is Aadhaar Authenticated - [3. Verify OTP](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-registration-api-s-collection-via-aadhaar/03-m4-post-v2-registration-aadhaar-verifyotp): Verify OTP - [4. Submit the demographic auth via mobile](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-registration-api-s-collection-via-aadhaar/04-m4-post-v2-registration-aadhaar-demographicauthviamobile): Demographic Auth Via Mobile - [5. Submit the account exist](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-registration-api-s-collection-via-aadhaar/05-m4-post-v1-registration-aadhaar-checkhpidaccountexist): Account Exist - [6. Get suggesstion](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-registration-api-s-collection-via-aadhaar/06-m4-post-v1-registration-aadhaar-hpid-suggestion): Get Suggesstion - [7. Generate mobile OTP](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-registration-api-s-collection-via-aadhaar/07-m4-post-v1-registration-aadhaar-generatemobileotp): Generate Mobile OTP - [8. Verify mobile OTP](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-registration-api-s-collection-via-aadhaar/08-m4-post-v1-registration-aadhaar-verifymobileotp): Verify Mobile OTP - [9. Create HPR ID V2](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-registration-api-s-collection-via-aadhaar/09-m4-post-v2-registration-aadhaar-createhpridwithpreverified): Create HPR ID V2 - [1. Get facility and infrastructure within radius with filter](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-search/01-m4-post-facilitymanagement-v1-5-facility-bygeolocation-se-907b10): Get Facility And Infrastructure Within Radius With Filter - [2. Search facility](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-search/02-m4-post-facilitymanagement-v1-5-facility-search): Search Facility - [1. Get the exists by HPR ID](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-searched/01-m4-get-v1-search-existsbyhprid-hprid): Exists By HPR ID - [2. Search user by HPR ID](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-searched/02-m4-get-v1-search-searchbyhprid-hprid): Search User By HPR ID - [3. Search user by mobile no](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-searched/03-m4-get-v1-search-searchbymobile-mobile): Search User By Mobile No - [1. Fetch HPID categories](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-util/01-m4-get-hpid-get-categories): Fetch HPID Categories - [2. Fetch HPID sub categories from category](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-util/02-m4-get-hpid-get-subcategories): Fetch HPID Sub Categories From Category - [1. Get PSU details by ministry](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-utilities/01-m4-get-getpsudetailsbyministry): Get Psu Data - [2. Get all facility sub type by facility type](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-utilities/02-m4-post-v1-5-facility-fetch-facility-sub-type): Get All Facility Sub Type By Facility Type - [3. Get all facility type by ownership and sys of med](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-utilities/03-m4-post-v1-5-facility-fetch-facility-type): Get All Facility Type By Ownership And Sys Of Med - [4. Get master data](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-utilities/04-m4-get-v1-5-facility-get-master-data): Get Master Data - [5. Get all master types](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-utilities/05-m4-get-v1-5-facility-get-master-types): Get All Master Type - [6. Get all sub types by owner ship type and sub type](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-utilities/06-m4-post-v1-5-facility-get-owner-subtype): Get All Sub Types By Owner Ship Type And Sub Type - [7. Get all specialities by system of medicine code](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-utilities/07-m4-post-v1-5-facility-get-specialities): Get All Specialities By System Of Medicine Code - [8. Get all district by state ID](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-utilities/08-m4-get-v1-5-facility-lgd-districts): Get All District By State ID - [9. Get all states by LGD](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-utilities/09-m4-get-v1-5-facility-lgd-states): Get All States By LGD - [10. Get all sub district by district code](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-utilities/10-m4-get-v1-5-facility-lgd-subdistricts): Get All Sub District By District Code - [1. Get all affiliated board](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-utility/01-m4-get-v1-masters-affiliated-board): Get All Affiliated Board - [2. Get affiliated board by state ID](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-utility/02-m4-get-v1-masters-affiliated-board-states-id): Get Affiliated Board By State ID - [3. Get affiliated board by ID](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-utility/03-m4-get-v1-masters-affiliated-board-id): Get Affiliated Board By ID - [4. Get college by state](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-utility/04-m4-get-v1-masters-colleges-id): Get College By State - [5. Get college by state and medicine ID](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-utility/05-m4-get-v1-masters-colleges-stateid-medicineid): Get College By State And Medicine ID - [6. Get all countries](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-utility/06-m4-get-v1-masters-countries): Get All Countries - [7. Get countries by ID](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-utility/07-m4-get-v1-masters-countries-id): Get Countries By ID - [8. List courses](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-utility/08-m4-post-v1-masters-courses): List Courses - [9. Get all districts](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-utility/09-m4-get-v1-masters-district): Get All Districts - [10. Get districts by state](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-utility/10-m4-get-v1-masters-district-id): Get Districts By State - [11. List government health programmes](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-utility/11-m4-get-v1-masters-languages): List Government Health Programmes - [12. Get pi languages by ID](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-utility/12-m4-get-v1-masters-languages-id): Get Pi Languages By ID - [13. Get all medical council](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-utility/13-m4-get-v1-masters-medical-councils): Get All Medical Council - [14. Get medical council by system of medicine name](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-utility/14-m4-get-v1-masters-medical-councils-name): Get Medical Council By System Of Medicine Name - [15. Get all nurse councils](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-utility/15-m4-get-v1-masters-nurse-councils): Get All Nurse Councils - [16. Get all states](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-utility/16-m4-get-v1-masters-states): Get All States - [17. Get status](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-utility/17-m4-get-v1-masters-states-id): Get Status - [18. Get all sub districts](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-utility/18-m4-get-v1-masters-sub-districts): Get All Sub Districts - [19. Get all sub districts 1](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-utility/19-m4-get-v1-masters-sub-districts-id): Get All Sub Districts 1 - [20. Get all medical system](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-utility/20-m4-get-v1-masters-system-of-medicines): Get All Medical System - [21. List all university](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-utility/21-m4-get-v1-masters-universites): List All University - [22. Get university by college](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-utility/22-m4-get-v1-masters-universites-id): Get University By College - [23. Get facilities created by HPR ID](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-utility/23-m4-post-getfacilitycreatedbyhprid): Get Facilities Created By HPR ID - [24. Get facilities declared by HPR ID](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-utility/24-m4-post-getfacilitydeclaredbyhprid): Get Facilities Declared By HPR ID - [25. Update status](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-utility/25-m4-put-hprworkdetails-status): Update Status - [26. Link delink existing facility](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-utility/26-m4-post-relinkordelinkprofessionalfromfacility): Link Delink Existing Facility - [1. Generate mobile OTP 2](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-verification/01-m4-post-v1-doctors-generate-mobile-otp): Generate Mobile OTP 2 - [2. Send verification email](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-verification/02-m4-post-v1-doctors-generate-verification-email): Send Verification Email - [3. Submit the regenerate mobile OTP](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-verification/03-m4-post-v1-doctors-regenerate-mobile-otp): Regenerate Mobile OTP - [4. Resend verification email](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-verification/04-m4-post-v1-doctors-resent-verify-email): Resend Verification Email - [5. Verify email OTP](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-verification/05-m4-post-v1-doctors-verify-email-otp): Verify Email OTP - [6. Verify mobile OTP](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-verification/06-m4-post-v1-doctors-verify-mobile-otp): Verify Mobile OTP - [7. Send OTP if doctor verified](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-verification/07-m4-post-v1-sendotpifdoctorverified): Send OTP If Doctor Verified - [8. Verify doctor verification OTP](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/endpoints/m4-verification/08-m4-post-v1-verifydoctorverificationotp): Verify Doctor Verification OTP - [1. Get the PHR certificate](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p1/endpoints/p1-certificate-and-session/01-p1-get-v3-phr-app-login-public-certificate): PHR Certificate - [2. Generate access token](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p1/endpoints/p1-certificate-and-session/02-gateway-post-gateway-v3-sessions): Generate an access token. When invoked, it facilitates the authentication process by providing a secure token that can be used to access various services... - [1. Request enrolment OTP](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p1/endpoints/p1-create-abha-address-abha-number-aadhaar-otp/01-p1-post-v3-phr-app-enrollment-request-otp): Flows: - P1-Registration-login › P1 - Create ABHA Address Flow › Enrolment via Mobile › OTP Request - Mobile - P1-Registration-login › P1 - Create ABHA... - [2. Verify the enrolment OTP](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p1/endpoints/p1-create-abha-address-abha-number-aadhaar-otp/02-p1-post-v3-phr-app-enrollment-verify): Flows: - P1-Registration-login › P1 - Create ABHA Address Flow › Enrolment via Mobile › OTP Verify - Mobile - P1-Registration-login › P1 - Create ABHA... - [3. Suggest an ABHA address](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p1/endpoints/p1-create-abha-address-abha-number-aadhaar-otp/03-p1-post-v3-phr-app-enrollment-suggestion): Flows: - P1-Registration-login › P1 - Create ABHA Address Flow › Enrolment via Mobile › Suggestion API - P1-Registration-login › P1 - Create ABHA Address... - [4. Check whether the ABHA address exists](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p1/endpoints/p1-create-abha-address-abha-number-aadhaar-otp/04-p1-get-v3-phr-app-enrollment-isexists): Flows: - P1-Registration-login › P1 - Create ABHA Address Flow › Enrolment via Mobile › isExists API - P1-Registration-login › P1 - Create ABHA Address Flow... - [5. Enrol ABHA address](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p1/endpoints/p1-create-abha-address-abha-number-aadhaar-otp/05-p1-post-v3-phr-app-enrollment-enrol): Flows: - P1-Registration-login › P1 - Create ABHA Address Flow › Enrolment via Mobile › Enrol ABHA Address - P1-Registration-login › P1 - Create ABHA... - [1. Request enrolment OTP](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p1/endpoints/p1-create-abha-address-abha-number-abha-otp/01-p1-post-v3-phr-app-enrollment-request-otp): Flows: - P1-Registration-login › P1 - Create ABHA Address Flow › Enrolment via Mobile › OTP Request - Mobile - P1-Registration-login › P1 - Create ABHA... - [2. Verify the enrolment OTP](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p1/endpoints/p1-create-abha-address-abha-number-abha-otp/02-p1-post-v3-phr-app-enrollment-verify): Flows: - P1-Registration-login › P1 - Create ABHA Address Flow › Enrolment via Mobile › OTP Verify - Mobile - P1-Registration-login › P1 - Create ABHA... - [3. Suggest an ABHA address](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p1/endpoints/p1-create-abha-address-abha-number-abha-otp/03-p1-post-v3-phr-app-enrollment-suggestion): Flows: - P1-Registration-login › P1 - Create ABHA Address Flow › Enrolment via Mobile › Suggestion API - P1-Registration-login › P1 - Create ABHA Address... - [4. Check whether the ABHA address exists](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p1/endpoints/p1-create-abha-address-abha-number-abha-otp/04-p1-get-v3-phr-app-enrollment-isexists): Flows: - P1-Registration-login › P1 - Create ABHA Address Flow › Enrolment via Mobile › isExists API - P1-Registration-login › P1 - Create ABHA Address Flow... - [5. Enrol ABHA address](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p1/endpoints/p1-create-abha-address-abha-number-abha-otp/05-p1-post-v3-phr-app-enrollment-enrol): Flows: - P1-Registration-login › P1 - Create ABHA Address Flow › Enrolment via Mobile › Enrol ABHA Address - P1-Registration-login › P1 - Create ABHA... - [1. Request enrolment OTP](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p1/endpoints/p1-create-abha-address-mobile/01-p1-post-v3-phr-app-enrollment-request-otp): Flows: - P1-Registration-login › P1 - Create ABHA Address Flow › Enrolment via Mobile › OTP Request - Mobile - P1-Registration-login › P1 - Create ABHA... - [2. Verify the enrolment OTP](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p1/endpoints/p1-create-abha-address-mobile/02-p1-post-v3-phr-app-enrollment-verify): Flows: - P1-Registration-login › P1 - Create ABHA Address Flow › Enrolment via Mobile › OTP Verify - Mobile - P1-Registration-login › P1 - Create ABHA... - [3. Suggest an ABHA address](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p1/endpoints/p1-create-abha-address-mobile/03-p1-post-v3-phr-app-enrollment-suggestion): Flows: - P1-Registration-login › P1 - Create ABHA Address Flow › Enrolment via Mobile › Suggestion API - P1-Registration-login › P1 - Create ABHA Address... - [4. Check whether the ABHA address exists](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p1/endpoints/p1-create-abha-address-mobile/04-p1-get-v3-phr-app-enrollment-isexists): Flows: - P1-Registration-login › P1 - Create ABHA Address Flow › Enrolment via Mobile › isExists API - P1-Registration-login › P1 - Create ABHA Address Flow... - [5. Enrol ABHA address](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p1/endpoints/p1-create-abha-address-mobile/05-p1-post-v3-phr-app-enrollment-enrol): Flows: - P1-Registration-login › P1 - Create ABHA Address Flow › Enrolment via Mobile › Enrol ABHA Address - P1-Registration-login › P1 - Create ABHA... - [1. Send Aadhaar OTP for ABHA enrolment](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p1/endpoints/p1-create-abha-number-aadhaar-otp/01-m1-post-v3-enrollment-request-otp-aadhaar-otp): Starts ABHA creation with Aadhaar OTP. UIDAI sends an OTP to the mobile number linked with the Aadhaar number. Use the txnId from the response in *Create... - [2. Create ABHA - verify Aadhaar OTP](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p1/endpoints/p1-create-abha-number-aadhaar-otp/02-m1-post-v3-enrollment-enrol-byaadhaar-otp): Verifies the Aadhaar OTP and creates the ABHA number, or returns the existing ABHA if one is already linked to the Aadhaar. The response contains the ABHA... - [3. After ABHA creation - send OTP to verify mobile (optional)](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p1/endpoints/p1-create-abha-number-aadhaar-otp/03-m1-post-v3-enrollment-request-otp-mobile-verify-create-ab-1b66bb): Optional, called after the ABHA is created. Needed only when the mobile sent in the create-ABHA call is not the Aadhaar-linked mobile. ABDM sends an OTP to... - [4. After ABHA creation - verify mobile OTP (optional)](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p1/endpoints/p1-create-abha-number-aadhaar-otp/04-m1-post-v3-enrollment-auth-byabdm-mobile-verify-create-ab-091285): Verifies the OTP sent by *After ABHA creation - send OTP to verify mobile (optional)* and links the mobile number to the newly created ABHA. - [5. Submit the email verification link](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p1/endpoints/p1-create-abha-number-aadhaar-otp/05-p1-post-v3-profile-account-request-emailverificationlink): Email Verification Link - [6. After ABHA creation - get ABHA address suggestions](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p1/endpoints/p1-create-abha-number-aadhaar-otp/06-m1-get-v3-enrollment-enrol-suggestion-create-abha-aadhaar-otp): Endpoint: GET /abha/api/v3/enrollment/enrol/suggestion - [7. After ABHA creation - create ABHA address](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p1/endpoints/p1-create-abha-number-aadhaar-otp/07-m1-post-v3-enrollment-enrol-abha-address-create-abha-aadhaar-otp): Endpoint: POST /abha/api/v3/enrollment/enrol/abha-address - [8. Get ABHA profile](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p1/endpoints/p1-create-abha-number-aadhaar-otp/08-m1-get-v3-profile-account): Endpoint: GET /abha/api/v3/profile/account - [9. Retrieve ABHA card image](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p1/endpoints/p1-create-abha-number-aadhaar-otp/09-m1-get-v3-profile-account-abha-card): Endpoint: GET /abha/api/v3/profile/account/abha-card - [1. Login request OTP](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p1/endpoints/p1-login-aadhaar-otp/01-p1-post-v3-phr-app-login-request-otp): Flows: - P1-Registration-login › P1 - PHR Login › P1 - Login via Mobile Number › OTP Request - Mobile - P1-Registration-login › P1 - PHR Login › P1 - Login... - [2. Login PHR verify](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p1/endpoints/p1-login-aadhaar-otp/02-p1-post-v3-phr-app-login-verify): Flows: - P1-Registration-login › P1 - PHR Login › P1 - Login via Mobile Number › Login OTP Verify - Mobile - P1-Registration-login › P1 - PHR Login › P1 -... - [3. Verify User, verify user](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p1/endpoints/p1-login-aadhaar-otp/03-p1-post-v3-phr-app-login-verify-user): Flows: - P1-Registration-login › P1 - Create ABHA Address Flow › Enrolment via ABHA Number-ABHA OTP › Verify User - P1-Registration-login › P1 - PHR Login ›... - [1. Login request OTP](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p1/endpoints/p1-login-abha-address-mobile-otp/01-p1-post-v3-phr-app-login-request-otp): Flows: - P1-Registration-login › P1 - PHR Login › P1 - Login via Mobile Number › OTP Request - Mobile - P1-Registration-login › P1 - PHR Login › P1 - Login... - [2. Login PHR verify](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p1/endpoints/p1-login-abha-address-mobile-otp/02-p1-post-v3-phr-app-login-verify): Flows: - P1-Registration-login › P1 - PHR Login › P1 - Login via Mobile Number › Login OTP Verify - Mobile - P1-Registration-login › P1 - PHR Login › P1 -... - [1. Search auth methods ABHAAddress](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p1/endpoints/p1-login-abha-address-password/01-p1-post-v3-phr-app-login-search): Search Auth Methods - ABHAAddress - [2. Login PHR verify](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p1/endpoints/p1-login-abha-address-password/02-p1-post-v3-phr-app-login-verify): Flows: - P1-Registration-login › P1 - PHR Login › P1 - Login via Mobile Number › Login OTP Verify - Mobile - P1-Registration-login › P1 - PHR Login › P1 -... - [1. Login request OTP](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p1/endpoints/p1-login-abha-number-aadhaar-otp/01-p1-post-v3-phr-app-login-request-otp): Flows: - P1-Registration-login › P1 - PHR Login › P1 - Login via Mobile Number › OTP Request - Mobile - P1-Registration-login › P1 - PHR Login › P1 - Login... - [2. Login PHR verify](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p1/endpoints/p1-login-abha-number-aadhaar-otp/02-p1-post-v3-phr-app-login-verify): Flows: - P1-Registration-login › P1 - PHR Login › P1 - Login via Mobile Number › Login OTP Verify - Mobile - P1-Registration-login › P1 - PHR Login › P1 -... - [3. Verify User, verify user](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p1/endpoints/p1-login-abha-number-aadhaar-otp/03-p1-post-v3-phr-app-login-verify-user): Flows: - P1-Registration-login › P1 - Create ABHA Address Flow › Enrolment via ABHA Number-ABHA OTP › Verify User - P1-Registration-login › P1 - PHR Login ›... - [1. Login request OTP](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p1/endpoints/p1-login-abha-number-abha-otp/01-p1-post-v3-phr-app-login-request-otp): Flows: - P1-Registration-login › P1 - PHR Login › P1 - Login via Mobile Number › OTP Request - Mobile - P1-Registration-login › P1 - PHR Login › P1 - Login... - [2. Login PHR verify](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p1/endpoints/p1-login-abha-number-abha-otp/02-p1-post-v3-phr-app-login-verify): Flows: - P1-Registration-login › P1 - PHR Login › P1 - Login via Mobile Number › Login OTP Verify - Mobile - P1-Registration-login › P1 - PHR Login › P1 -... - [3. Verify User, verify user](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p1/endpoints/p1-login-abha-number-abha-otp/03-p1-post-v3-phr-app-login-verify-user): Flows: - P1-Registration-login › P1 - Create ABHA Address Flow › Enrolment via ABHA Number-ABHA OTP › Verify User - P1-Registration-login › P1 - PHR Login ›... - [1. Login request OTP](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p1/endpoints/p1-login-mobile/01-p1-post-v3-phr-app-login-request-otp): Flows: - P1-Registration-login › P1 - PHR Login › P1 - Login via Mobile Number › OTP Request - Mobile - P1-Registration-login › P1 - PHR Login › P1 - Login... - [2. Login PHR verify](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p1/endpoints/p1-login-mobile/02-p1-post-v3-phr-app-login-verify): Flows: - P1-Registration-login › P1 - PHR Login › P1 - Login via Mobile Number › Login OTP Verify - Mobile - P1-Registration-login › P1 - PHR Login › P1 -... - [3. Verify User, verify user](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p1/endpoints/p1-login-mobile/03-p1-post-v3-phr-app-login-verify-user): Flows: - P1-Registration-login › P1 - Create ABHA Address Flow › Enrolment via ABHA Number-ABHA OTP › Verify User - P1-Registration-login › P1 - PHR Login ›... - [P1 Registration and login errors](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p1/errors): What P1 Registration and login returns when a call fails, and what to do about it. - [1. OPD token generation](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p2/endpoints/p2-abdm-hiecm-patient-share-phr/01-p2-post-patient-share-v3-share): This is an API will be invoked from the PHR-HIU to share the user/patient profile with HMIS/LIMS. - [2. Receive the HIU patient on share](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p2/endpoints/p2-abdm-hiecm-patient-share-phr/02-p2-post-v3-hiu-patient-on-share): Hosted by the HIP/HIU, not by ABDM. ABDM calls this endpoint at the callback URL registered for your bridge, so the path below is relative to that URL. This... - [3. OPD Token History](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p2/endpoints/p2-abdm-hiecm-patient-share-phr/03-p2-get-patient-share-v3-profile-gettokendetails): This is an API will be invoked get the historical token numbers of the patient. - [1. Fetch the list of providers filtered by name](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p2/endpoints/p2-abdm-user-initiated-linking-phr/01-p2-get-gateway-v3-providers): Retrieve a list of providers, filtered by their names. When invoked, it queries the system to fetch providers that match the specified name criteria. This... - [2. Fetch the record for provider details for requested provider ID](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p2/endpoints/p2-abdm-user-initiated-linking-phr/02-p2-get-gateway-v3-providers-provider-id): Retrieve the details of a specific provider based on the provided provider ID. When invoked, it queries the system to fetch comprehensive information about... - [3. Discover his/her health records](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p2/endpoints/p2-abdm-user-initiated-linking-phr/03-p2-post-user-initiated-linking-v3-patient-care-context-discover): Be invoked by the patient or user through the Personal Health Record (PHR) application to discover their health records. By using this API, patients can... - [4. Receive the discovered care contexts of a patient](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p2/endpoints/p2-abdm-user-initiated-linking-phr/04-p2-post-v3-hiu-patient-care-context-on-discover): Hosted by the HIP/HIU, not by ABDM. ABDM calls this endpoint at the callback URL registered for your bridge, so the path below is relative to that URL. The... - [5. Link his/her health records](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p2/endpoints/p2-abdm-user-initiated-linking-phr/05-p2-post-user-initiated-linking-v3-link-care-context-init): Be invoked by the patient or user to link their health records. By using this API, patients can initiate the process of associating their health information... - [6. Receive the initial linking of care contexts for a patient](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p2/endpoints/p2-abdm-user-initiated-linking-phr/06-p2-post-v3-hiu-patient-care-context-on-init): Hosted by the HIP/HIU, not by ABDM. ABDM calls this endpoint at the callback URL registered for your bridge, so the path below is relative to that URL. The... - [7. Confirm his/her health records](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p2/endpoints/p2-abdm-user-initiated-linking-phr/07-p2-post-user-initiated-linking-v3-link-care-context-confirm): Be invoked by the patient or user to confirm their health records. By using this API, patients can validate and confirm the linkage of their health... - [8. Receive confirmation of the linked care contexts for a patient](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p2/endpoints/p2-abdm-user-initiated-linking-phr/08-p2-post-v3-hiu-patient-care-context-on-confirm): Hosted by the HIP/HIU, not by ABDM. ABDM calls this endpoint at the callback URL registered for your bridge, so the path below is relative to that URL. The... - [9. Fetch the list of govt programmes (optional)](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p2/endpoints/p2-abdm-user-initiated-linking-phr/09-p2-get-gateway-v3-govt-programs): Retrieve a list of government programmes. When invoked, it queries the system to fetch comprehensive information about various government programmes... - [1. Setup an auto-approval policy for given HIU](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p2/endpoints/p2-consent-management-data-flow-phr/01-p2-post-consent-v3-auto-approve): Set up an auto-approval policy for a specified Health Information User (HIU). By invoking this API, users can configure automatic approval of consent... - [2. Disable the auto-approval policy](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p2/endpoints/p2-consent-management-data-flow-phr/02-p2-post-consent-v3-auto-approve-auto-approval-id-disable): Disable an existing auto-approval policy. By invoking this API, users can deactivate the automatic approval of consent requests for the specified Health... - [3. Enable the auto-approval policy](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p2/endpoints/p2-consent-management-data-flow-phr/03-p2-post-consent-v3-auto-approve-auto-approval-id-enable): Enable an existing auto-approval policy. By invoking this API, users can activate the automatic approval of consent requests for the specified Health... - [4. Fetch all the consent request details of a patient](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p2/endpoints/p2-consent-management-data-flow-phr/04-p2-get-consent-v3-request): Fetch all consent request details for a patient. By invoking this API, users can retrieve a comprehensive list of all consent requests associated with a... - [5. Get the consent request details by REQUEST-ID](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p2/endpoints/p2-consent-management-data-flow-phr/05-p2-get-consent-v3-request-request-id): Retrieve the details of a consent request using the REQUEST-ID. By invoking this API, users can obtain comprehensive information about a specific consent... - [6. Approve the consent request raised by HIU from PHR/mobile application](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p2/endpoints/p2-consent-management-data-flow-phr/06-p2-post-consent-v3-request-request-id-approve): Approve a consent request, specifying their preferred data access parameters. By invoking this API, the user grants permission for the Health Information... - [7. Deny the consent request raised by HIU from PHR/mobile application](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p2/endpoints/p2-consent-management-data-flow-phr/07-p2-post-consent-v3-request-request-id-deny): Deny a consent request from the Personal Health Record (PHR) or mobile application. By invoking this API, users can reject a consent request, preventing the... - [8. Revoke the granted consent from PHR/mobile application](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p2/endpoints/p2-consent-management-data-flow-phr/08-p2-post-consent-v3-revoke): Revoke a previously approved consent from the Personal Health Record (PHR) or mobile application. By invoking this API, users can withdraw their consent,... - [9. Request artefact by consent REQUEST-ID](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p2/endpoints/p2-consent-management-data-flow-phr/09-p2-get-consent-v3-artefact-request-request-id): Fetch all consent artefact details associated with a specific consent REQUEST-ID. By invoking this API, users can retrieve comprehensive information about... - [10. Fetch the consent artefact details associated with the artefact-ID](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p2/endpoints/p2-consent-management-data-flow-phr/10-p2-get-consent-v3-artefact-artefact-id): Fetch the details of a consent artefact associated with a specific artefact ID. By invoking this API, users can retrieve comprehensive information about the... - [11. Fetch all the consent artefact details of a patient](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p2/endpoints/p2-consent-management-data-flow-phr/11-p2-get-consent-v3-artefact): Fetch all consent artefact details for a patient. By invoking this API, users can retrieve comprehensive information about all consent artefacts associated... - [1. Link patient links](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p2/endpoints/p2-consent-manager-hiu-hip/01-p2-get-hip-v3-link-patient-links): Retrieve all linked care contexts for a patient from various Health Information Providers (HIPs). By invoking this API, users can obtain a comprehensive... - [2. Initiate the consent request](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p2/endpoints/p2-consent-manager-hiu-hip/02-m3-post-consent-v3-request-init): Create a consent request by a Health Information User (HIU) to access a patient’s health data. By invoking this API, the HIU initiates the process of... - [3. Get consent request status](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p2/endpoints/p2-consent-manager-hiu-hip/03-m3-post-consent-v3-request-status): Retrieve the status of a previously initiated consent request. By invoking this API, users can check the current state of their consent request, whether it... - [4. Acknowledge the consent notification](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p2/endpoints/p2-consent-manager-hiu-hip/04-m2-post-consent-v3-request-hip-on-notify): Notification of consents, in cases of consent approval, revocation and expiration. Notified by CM earlier via Gateway API - /api/v3/consent/request/hip/notify - [5. Acknowledge the consent notification](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p2/endpoints/p2-consent-manager-hiu-hip/05-m3-post-consent-v3-request-hiu-on-notify): Consent notifications, specifically for cases when consent is APPROVED, DENIED, or REVOKED or EXPIRED. Notified by CM earlier via Gateway API -... - [6. Fetch the consent details](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p2/endpoints/p2-consent-manager-hiu-hip/06-m3-post-consent-v3-fetch): Fetch the details of a consent using the consent artefact ID. By invoking this API, HIUs can retrieve comprehensive information about a specific consent,... - [1. Request profile OTP](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p2/endpoints/p2-link-abha-number-aadhaar-otp/01-p2-post-v3-phr-app-login-profile-request-otp): Flows: - P2-Consents Management › P2 -PHR Profile › P2 - Update Mobile › Send OTP - Update Mobile - P2-Consents Management › P2 -PHR Profile › P2 - Link... - [2. Login profile verify](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p2/endpoints/p2-link-abha-number-aadhaar-otp/02-p2-post-v3-phr-app-login-profile-verify): Flows: - P2-Consents Management › P2 -PHR Profile › P2 - Update Mobile › Verify OTP - Update Mobile - P2-Consents Management › P2 -PHR Profile › P2 - Update... - [3. Link request](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p2/endpoints/p2-link-abha-number-aadhaar-otp/03-p2-post-v3-phr-app-login-profile-link): Flows: - P2-Consents Management › P2 -PHR Profile › P2 - Link ABHA Number › P2 - via ABHA OTP › Link Request - P2-Consents Management › P2 -PHR Profile › P2... - [1. Request profile OTP](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p2/endpoints/p2-link-abha-number-abha-otp/01-p2-post-v3-phr-app-login-profile-request-otp): Flows: - P2-Consents Management › P2 -PHR Profile › P2 - Update Mobile › Send OTP - Update Mobile - P2-Consents Management › P2 -PHR Profile › P2 - Link... - [2. Login profile verify](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p2/endpoints/p2-link-abha-number-abha-otp/02-p2-post-v3-phr-app-login-profile-verify): Flows: - P2-Consents Management › P2 -PHR Profile › P2 - Update Mobile › Verify OTP - Update Mobile - P2-Consents Management › P2 -PHR Profile › P2 - Update... - [3. Link request](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p2/endpoints/p2-link-abha-number-abha-otp/03-p2-post-v3-phr-app-login-profile-link): Flows: - P2-Consents Management › P2 -PHR Profile › P2 - Link ABHA Number › P2 - via ABHA OTP › Link Request - P2-Consents Management › P2 -PHR Profile › P2... - [1. Get profile](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p2/endpoints/p2-profile/01-p2-get-v3-phr-app-login-profile): Get Profile - [2. Get QR code](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p2/endpoints/p2-profile/02-p2-get-v3-phr-app-login-profile-qrcode): Get QR Code - [3. Get PHR card](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p2/endpoints/p2-profile/03-p2-get-v3-phr-app-login-profile-phrcard): Get PHR Card - [4. Update profile](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p2/endpoints/p2-profile/04-p2-post-v3-phr-app-login-profile-updateprofile): Update Profile - [5. Refresh token](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p2/endpoints/p2-profile/05-p2-get-v3-phr-app-login-profile-request-token): Refresh Token - [6. Logout](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p2/endpoints/p2-profile/06-p2-get-v3-phr-app-login-profile-request-logout): Logout - [1. Switch profile](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p2/endpoints/p2-switch-profile/01-p2-get-v3-phr-app-login-profile-switch-profile): Switch Profile - [2. Verify user switch profile](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p2/endpoints/p2-switch-profile/02-p2-post-v3-phr-app-login-profile-verify-switch-profile-user): Verify User Switch Profile - [1. Request profile OTP](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p2/endpoints/p2-update-mobile/01-p2-post-v3-phr-app-login-profile-request-otp): Flows: - P2-Consents Management › P2 -PHR Profile › P2 - Update Mobile › Send OTP - Update Mobile - P2-Consents Management › P2 -PHR Profile › P2 - Link... - [2. Login profile verify](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p2/endpoints/p2-update-mobile/02-p2-post-v3-phr-app-login-profile-verify): Flows: - P2-Consents Management › P2 -PHR Profile › P2 - Update Mobile › Verify OTP - Update Mobile - P2-Consents Management › P2 -PHR Profile › P2 - Update... - [1. Login profile verify](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p2/endpoints/p2-update-password/01-p2-post-v3-phr-app-login-profile-verify): Flows: - P2-Consents Management › P2 -PHR Profile › P2 - Update Mobile › Verify OTP - Update Mobile - P2-Consents Management › P2 -PHR Profile › P2 - Update... - [P2 Consents Management errors](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p2/errors): What P2 Consents Management returns when a call fails, and what to do about it. - [1. Initiate subscription request](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p3/endpoints/p3-subscription-hiu/01-p3-post-subscription-requests-v3-init): Be invoked by Health Information Users (HIUs), patients, or users through the Personal Health Record (PHR) application to initiate a subscription request.... - [2. Receive the HIU subscription requests on init](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p3/endpoints/p3-subscription-hiu/02-p3-post-v3-hiu-hiecm-subscription-requests-on-init): Hosted by the HIP/HIU, not by ABDM. ABDM calls this endpoint at the callback URL registered for your bridge, so the path below is relative to that URL. This... - [3. Notify subscription requests HIU](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p3/endpoints/p3-subscription-hiu/03-p3-post-v3-hiu-subscription-requests-hiu-notify): Hosted by the HIP/HIU, not by ABDM. ABDM calls this endpoint at the callback URL registered for your bridge, so the path below is relative to that URL. This... - [4. Answer the subscription request notification](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p3/endpoints/p3-subscription-hiu/04-p3-post-subscription-requests-v3-hiu-on-notify): Be invoked by the Health Information User (HIU) to respond to notifications received from the /subscription-requests/hiu/notify API. By using this API, the... - [5. Notify HIU subscription](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p3/endpoints/p3-subscription-hiu/05-p3-post-v3-hiu-subscription-notify): Hosted by the HIP/HIU, not by ABDM. ABDM calls this endpoint at the callback URL registered for your bridge, so the path below is relative to that URL. This... - [6. Answer the care context subscription notification](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p3/endpoints/p3-subscription-hiu/06-p3-post-subscription-requests-v3-hiu-care-context-on-notify): Be invoked by the Health Information User (HIU) to respond to notifications received from the /api/v3/hiu/subscription/notify API. By using this API, the... - [1. Approve subscription request](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p3/endpoints/p3-subscription-phr/01-p3-post-subscription-requests-v3-request-id-approve): Be invoked by the patient or user through the Personal Health Record (PHR) application to approve a subscription request. By using this API, individuals can... - [2. Deny subscription request](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p3/endpoints/p3-subscription-phr/02-p3-post-subscription-requests-v3-request-id-deny): Be invoked by the patient or user through the Personal Health Record (PHR) application to deny a subscription request. By using this API, individuals can... - [3. Fetch his/her subscription requests details](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p3/endpoints/p3-subscription-phr/03-p3-get-subscription-requests-v3-requests): Be invoked by the patient or user through the Personal Health Record (PHR) application to fetch details of their subscription requests. By using this API,... - [4. Edit the subscription details](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p3/endpoints/p3-subscription-phr/04-p3-put-subscription-requests-v3-patients-subscription-id): Edit the details of an existing subscription. By invoking this API, users can update the parameters and preferences associated with a specific subscription... - [5. Disable the subscription by subscription ID](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p3/endpoints/p3-subscription-phr/05-p3-post-subscription-requests-v3-disable-subscription-id): Disable an existing subscription identified by the subscription ID. By invoking this API, users can deactivate the subscription, ensuring that the... - [6. Enable the subscription by subscription ID](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p3/endpoints/p3-subscription-phr/06-p3-post-subscription-requests-v3-enable-subscription-id): Enable an existing subscription identified by the subscription ID. By invoking this API, users can activate the subscription, ensuring that the associated... - [7. Fetch his/her subscription details by subscription REQUEST-ID](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p3/endpoints/p3-subscription-phr/07-p3-get-subscription-requests-v3-request-request-id): Be invoked by the patient or user through the Personal Health Record (PHR) application to fetch their subscription details using the subscription... - [8. Fetch his/her subscription details by subscription ID](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p3/endpoints/p3-subscription-phr/08-p3-get-subscription-requests-v3-subscription-id): Be invoked by the patient or user through the Personal Health Record (PHR) application to fetch their subscription details using the subscription ID. By... - [P3 Subscription errors](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p3/errors): What P3 Subscription returns when a call fails, and what to do about it. - [1. Setup health locker for a patient](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p4/endpoints/p4-locker/01-p4-post-subscription-requests-v3-setup-locker): Set up a health locker for a patient. By invoking this API, users can configure a secure storage space for the patient’s health records, ensuring that all... - [2. Get the subscription requests patients lockers](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p4/endpoints/p4-locker/02-p4-get-subscription-requests-v3-patients-lockers): Retrieve a list of health lockers associated with a given ABHA address. It includes both active and inactive subscriptions based on the includeInactive... - [3. Get health locker settings of a patient by locker ID](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p4/endpoints/p4-locker/03-p4-get-subscription-requests-v3-patients-lockers-lockerid): Retrieve the health locker settings of a patient using the locker ID. By invoking this API, users can access detailed information about the configuration... - [4. Get all the consent and subscription requests with given filters](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p4/endpoints/p4-locker/04-p4-get-subscription-requests-v3-patients-requests): Retrieve all consent and subscription requests based on specified filters. By invoking this API, users can obtain a comprehensive list of requests that... - [5. Fetch the record with health locker enabled provider details](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p4/endpoints/p4-locker/05-p4-get-gateway-v3-health-lockers): Retrieve records of providers that have health locker functionality enabled. When invoked, it queries the system to fetch detailed information about these... - [Patient scan and record share](https://nhcx.sbxstage.in/docs/hiecm/v3/api/record-share): A patient scans a facility's QR code in a PHR app and shares chosen health records with that HIU. Base URLs, terminology and the calls on each side. - [1. Receive a patient's share request, as the HIU](https://nhcx.sbxstage.in/docs/hiecm/v3/api/record-share/endpoints/record-share-hiu/01-record-share-post-v3-patient-record-share): Hosted by the HIU, not by ABDM. The HIE-CM calls this endpoint at the callback URL registered for your bridge, so the path below is relative to that URL. - [2. Submit the reply to a share request with the data push URL and the encryption key](https://nhcx.sbxstage.in/docs/hiecm/v3/api/record-share/endpoints/record-share-hiu/02-record-share-post-patient-record-v3-on-share): Acts as the callback endpoint for the PHR application. After the initial request, the HIU responds to this callback with the data push URL and the... - [3. Receive the encrypted records at the data push URL, as the HIU](https://nhcx.sbxstage.in/docs/hiecm/v3/api/record-share/endpoints/record-share-hiu/03-record-share-post-health-information-transfer): Hosted by the HIU at the dataPushUrl it supplied in on-share, not by ABDM. The PHR application posts here directly; the path is whatever the data push URL... - [4. Receive the other side's transfer status](https://nhcx.sbxstage.in/docs/hiecm/v3/api/record-share/endpoints/record-share-hiu/04-record-share-post-v3-patient-record-on-notify): Hosted by the PHR application and by the HIU, not by ABDM. The HIE-CM calls this endpoint at the callback URL registered for your bridge, so the path below... - [5. Notify patient record](https://nhcx.sbxstage.in/docs/hiecm/v3/api/record-share/endpoints/record-share-hiu/05-record-share-post-patient-record-v3-notify): Update the status of the health record transfer process. It is invoked by the PHR application and HIU to notify the HIE-CM about the completion status of... - [1. Share a patient's records with the HIU whose QR code was scanned](https://nhcx.sbxstage.in/docs/hiecm/v3/api/record-share/endpoints/record-share-phr/01-record-share-post-patient-record-v3-share): Is the first step in initiating the health data sharing process. It is invoked by an integrator application (such as any PHR application like ABHA) after... - [2. Receive the HIU's data push URL and encryption key, as the PHR app](https://nhcx.sbxstage.in/docs/hiecm/v3/api/record-share/endpoints/record-share-phr/02-record-share-post-v3-patient-record-on-share): Hosted by the PHR application, not by ABDM. The HIE-CM calls this endpoint at the callback URL registered for your bridge, so the path below is relative to... - [3. Receive the encrypted records at the data push URL, as the HIU](https://nhcx.sbxstage.in/docs/hiecm/v3/api/record-share/endpoints/record-share-phr/03-record-share-post-health-information-transfer): Hosted by the HIU at the dataPushUrl it supplied in on-share, not by ABDM. The PHR application posts here directly; the path is whatever the data push URL... - [4. Notify patient record](https://nhcx.sbxstage.in/docs/hiecm/v3/api/record-share/endpoints/record-share-phr/04-record-share-post-patient-record-v3-notify): Update the status of the health record transfer process. It is invoked by the PHR application and HIU to notify the HIE-CM about the completion status of... - [5. Receive the other side's transfer status](https://nhcx.sbxstage.in/docs/hiecm/v3/api/record-share/endpoints/record-share-phr/05-record-share-post-v3-patient-record-on-notify): Hosted by the PHR application and by the HIU, not by ABDM. The HIE-CM calls this endpoint at the callback URL registered for your bridge, so the path below... - [6. List the record sharing history of the signed in user](https://nhcx.sbxstage.in/docs/hiecm/v3/api/record-share/endpoints/record-share-phr/06-record-share-get-patient-record-v3-audit-history): Retrieve the complete history of record-sharing transactions for a specific user. It provides details of all past and ongoing transactions, including... - [Patient scan and record share errors](https://nhcx.sbxstage.in/docs/hiecm/v3/api/record-share/errors): What Patient scan and record share returns when a call fails, and what to do about it. - [1. Share patient open order](https://nhcx.sbxstage.in/docs/hiecm/v3/api/scan-and-pay/endpoints/scan-and-pay-abdm-hiecm-scan-pay-phr/01-scan-and-pay-post-scan-gateway-v3-patient-share-open-order): This is an API will be invoked from the integrator application to share the user/patient profile with HMIS/LIMS. - [2. Receive the patient on-share](https://nhcx.sbxstage.in/docs/hiecm/v3/api/scan-and-pay/endpoints/scan-and-pay-abdm-hiecm-scan-pay-phr/02-scan-and-pay-post-v3-patient-on-share-open-order): Hosted by the HIP/HIU, not by ABDM. ABDM calls this endpoint at the callback URL registered for your bridge, so the path below is relative to that URL. This... - [3. Select the all open-order and send to HIP for a payment request detail](https://nhcx.sbxstage.in/docs/hiecm/v3/api/scan-and-pay/endpoints/scan-and-pay-abdm-hiecm-scan-pay-phr/03-scan-and-pay-post-scan-gateway-v3-patient-selection): Select the all open-order and send to HIP for a payment request detail. In this user can select the multiple procedures. - [4. Receive the patient on selection](https://nhcx.sbxstage.in/docs/hiecm/v3/api/scan-and-pay/endpoints/scan-and-pay-abdm-hiecm-scan-pay-phr/04-scan-and-pay-post-v3-patient-on-selection): Hosted by the HIP/HIU, not by ABDM. ABDM calls this endpoint at the callback URL registered for your bridge, so the path below is relative to that URL. This... - [5. Notify patient scan pay](https://nhcx.sbxstage.in/docs/hiecm/v3/api/scan-and-pay/endpoints/scan-and-pay-abdm-hiecm-scan-pay-phr/05-scan-and-pay-post-v3-patient-scan-pay-notify): Hosted by the HIP/HIU, not by ABDM. ABDM calls this endpoint at the callback URL registered for your bridge, so the path below is relative to that URL. This... - [6. Notify to HIP so that confirm that the HIU received the payment status](https://nhcx.sbxstage.in/docs/hiecm/v3/api/scan-and-pay/endpoints/scan-and-pay-abdm-hiecm-scan-pay-phr/06-scan-and-pay-post-scan-gateway-v3-patient-scan-pay-on-notify): Notify to HIP so that confirm that the HIU received the payment status. This HIU will confirm the we will received the payment... - [7. Check the status of reports](https://nhcx.sbxstage.in/docs/hiecm/v3/api/scan-and-pay/endpoints/scan-and-pay-abdm-hiecm-scan-pay-phr/07-scan-and-pay-post-scan-gateway-v3-patient-scan-pay-order-status): Check the status of reports. If the notification is not get from HIP then this API will help to check the status on HIU side. - [8. Receive the patient scan pay on order status](https://nhcx.sbxstage.in/docs/hiecm/v3/api/scan-and-pay/endpoints/scan-and-pay-abdm-hiecm-scan-pay-phr/08-scan-and-pay-post-v3-patient-scan-pay-on-order-status): Hosted by the HIP/HIU, not by ABDM. ABDM calls this endpoint at the callback URL registered for your bridge, so the path below is relative to that URL. This... - [1. Check the status of reports](https://nhcx.sbxstage.in/docs/hiecm/v3/api/scan-and-pay/endpoints/scan-and-pay-abdm-scan-pay-hip/01-scan-and-pay-post-v3-patient-share-open-order): Hosted by the HIP/HIU, not by ABDM. ABDM calls this endpoint at the callback URL registered for your bridge, so the path below is relative to that URL. This... - [2. Submit the HIE-CM to send all the open order for patient](https://nhcx.sbxstage.in/docs/hiecm/v3/api/scan-and-pay/endpoints/scan-and-pay-abdm-scan-pay-hip/02-scan-and-pay-post-scan-gateway-v3-patient-on-share-open-order): Share the response of HIECM's /hiecm/api/v3/scan-gateway/patient/on-share/open API. - [3. Receive the patient selection](https://nhcx.sbxstage.in/docs/hiecm/v3/api/scan-and-pay/endpoints/scan-and-pay-abdm-scan-pay-hip/03-scan-and-pay-post-v3-patient-selection): Hosted by the HIP/HIU, not by ABDM. ABDM calls this endpoint at the callback URL registered for your bridge, so the path below is relative to that URL. This... - [4. Share payment bundle alone with procedures of the patient](https://nhcx.sbxstage.in/docs/hiecm/v3/api/scan-and-pay/endpoints/scan-and-pay-abdm-scan-pay-hip/04-scan-and-pay-post-scan-gateway-v3-patient-on-selection): Share payment bundle alone with procedures of the patient. The HIP will sent the payment bundle to HIU. - [5. Send the payment status to HIU](https://nhcx.sbxstage.in/docs/hiecm/v3/api/scan-and-pay/endpoints/scan-and-pay-abdm-scan-pay-hip/05-scan-and-pay-post-scan-gateway-v3-patient-scan-pay-notify): Send the payment status to HIU. - [6. Receive the patient scan pay on notify](https://nhcx.sbxstage.in/docs/hiecm/v3/api/scan-and-pay/endpoints/scan-and-pay-abdm-scan-pay-hip/06-scan-and-pay-post-v3-patient-scan-pay-on-notify): Hosted by the HIP/HIU, not by ABDM. ABDM calls this endpoint at the callback URL registered for your bridge, so the path below is relative to that URL. This... - [7. Receive the patient scan pay order status](https://nhcx.sbxstage.in/docs/hiecm/v3/api/scan-and-pay/endpoints/scan-and-pay-abdm-scan-pay-hip/07-scan-and-pay-post-v3-patient-scan-pay-order-status): Hosted by the HIP/HIU, not by ABDM. ABDM calls this endpoint at the callback URL registered for your bridge, so the path below is relative to that URL. This... - [8. Check the status of reports](https://nhcx.sbxstage.in/docs/hiecm/v3/api/scan-and-pay/endpoints/scan-and-pay-abdm-scan-pay-hip/08-scan-and-pay-post-scan-gateway-v3-patient-scan-pay-on-ord-21f376): Check the status of reports. - [1. Get the patient scan pay details](https://nhcx.sbxstage.in/docs/hiecm/v3/api/scan-and-pay/endpoints/scan-and-pay-utility/01-scan-and-pay-get-scan-gateway-v3-patient-scan-pay-details): Retrieve the all the details of the user/patient based on the date ranges. - [2. Update version to the serviceId](https://nhcx.sbxstage.in/docs/hiecm/v3/api/scan-and-pay/endpoints/scan-and-pay-utility/02-scan-and-pay-patch-gateway-v3-scanpay-updateversion): This is used by the integrators to update the version for the particular service-ID. - [Scan and Pay errors](https://nhcx.sbxstage.in/docs/hiecm/v3/api/scan-and-pay/errors): What Scan and Pay returns when a call fails, and what to do about it. - [1. Share HIP patient](https://nhcx.sbxstage.in/docs/hiecm/v3/api/scan-and-register/endpoints/scan-and-register-abdm-patient-share-hip/01-scan-and-register-post-v3-hip-patient-share): Hosted by the HIP/HIU, not by ABDM. ABDM calls this endpoint at the callback URL registered for your bridge, so the path below is relative to that URL. This... - [2. Answer the patient share request](https://nhcx.sbxstage.in/docs/hiecm/v3/api/scan-and-register/endpoints/scan-and-register-abdm-patient-share-hip/02-scan-and-register-post-patient-share-v3-on-share): Share the response of HIECM's /api/hiecm/patient-share/v3/on-share API. - [Scan and Register errors](https://nhcx.sbxstage.in/docs/hiecm/v3/api/scan-and-register/errors): What Scan and Register returns when a call fails, and what to do about it. - [Proving a callback came from ABDM](https://nhcx.sbxstage.in/docs/hiecm/v3/concepts/callback-authenticity): Your callback URL is a public address, so anything can post to it. How ABDM authenticates what it sends, and how to check that before your handler acts. - [Care contexts](https://nhcx.sbxstage.in/docs/hiecm/v3/concepts/care-context): A care context is a logical grouping of a patient's health records, and the unit that is associated with a patient's ABHA address. - [Consent](https://nhcx.sbxstage.in/docs/hiecm/v3/concepts/consent): What a consent request is, what a consent artefact is, who holds it, and the states it moves through. - [How a record travels](https://nhcx.sbxstage.in/docs/hiecm/v3/concepts/data-flow): The path a health record takes from the system that asks for it to the system that holds it, and the encryption in between. - [Encryption](https://nhcx.sbxstage.in/docs/hiecm/v3/concepts/encryption): Which values must be encrypted before they go in a request body, why it is required, and why you encrypt inside your own system rather than through a helper. - [FHIR and health record formats](https://nhcx.sbxstage.in/docs/hiecm/v3/concepts/fhir): The R4 profiles ABDM uses, the document bundle every record travels in, and how to validate one before you ship it. - [The ABDM gateway](https://nhcx.sbxstage.in/docs/hiecm/v3/concepts/gateway): The routing layer every ABDM call goes through, and the session endpoint that issues your token. - [Hospital, lab and pharmacy systems](https://nhcx.sbxstage.in/docs/hiecm/v3/concepts/hip-hiu): What a facility does as a health information provider in ABDM, and how care context linking fits into a clinical workflow. - [How the pieces fit](https://nhcx.sbxstage.in/docs/hiecm/v3/concepts/how-it-fits): The registries, the HIE-CM gateway, the two roles a record moves between, and where a health record actually lives. - [Care contexts and linking](https://nhcx.sbxstage.in/docs/hiecm/v3/concepts/linking): Why a record has to be linked before anyone can find it, the three routes onto the map, and how the link token works. - [Ecosystem participants](https://nhcx.sbxstage.in/docs/hiecm/v3/concepts/participants): The eight participants on India's health data network, the identifier each one holds, and what each can do. - [Citizen](https://nhcx.sbxstage.in/docs/hiecm/v3/concepts/participants/citizen): What an ABHA gives a person, what consent means in practice, and what a citizen controls on the network. - [Doctor](https://nhcx.sbxstage.in/docs/hiecm/v3/concepts/participants/doctor): The HPR ID a healthcare professional holds, how it is issued, and what it unlocks for the facility they work in. - [Hospital](https://nhcx.sbxstage.in/docs/hiecm/v3/concepts/participants/hospital): The facility ID a hospital holds, the HIP and HIU roles it takes, and what registering on ABDM gets it. - [Insurer](https://nhcx.sbxstage.in/docs/hiecm/v3/concepts/participants/insurer): An insurer reads records as an HIU under consent, and settles claims on NHCX, a separate gateway with its own onboarding. - [Diagnostics](https://nhcx.sbxstage.in/docs/hiecm/v3/concepts/participants/lab): A laboratory or imaging centre takes the same roles as a hospital, with a narrower record surface. What differs and what does not. - [NHA](https://nhcx.sbxstage.in/docs/hiecm/v3/concepts/participants/nha): The National Health Authority runs ABDM. What it operates, what it issues, and what that gives the systems on the network. - [Pharmacy](https://nhcx.sbxstage.in/docs/hiecm/v3/concepts/participants/pharmacy): A pharmacy takes the same roles as a hospital, with a narrower record surface. What differs, and what runs on another gateway. - [Personal Health Record (PHR) Application](https://nhcx.sbxstage.in/docs/hiecm/v3/concepts/participants/phr): The citizen facing application: its role in ABDM, the capabilities each phase adds, and why it is where consent is managed. - [Build it well](https://nhcx.sbxstage.in/docs/hiecm/v3/getting-started/build-it-well): What to validate before you call, what to do with each error, what is safe to retry, and what the person at the counter sees while it happens. - [Build with AI](https://nhcx.sbxstage.in/docs/hiecm/v3/getting-started/build-with-ai): Set a coding agent up to build your ABDM integration, from a one-file skill to live retrieval over MCP. - [Quickstart](https://nhcx.sbxstage.in/docs/hiecm/v3/getting-started/first-fifteen-minutes): Create a gateway session and then create your first ABHA, live from this page, with your own sandbox credentials. - [Glossary](https://nhcx.sbxstage.in/docs/hiecm/v3/getting-started/glossary): The ABDM terms used across this documentation, and the HIE-CM ones, defined once. - [Go live](https://nhcx.sbxstage.in/docs/hiecm/v3/getting-started/going-live): Stages 4 to 6 of sandbox integration. Functional testing and the security audit, the Health Tech Committee demonstration, then go live. - [Get your sandbox credentials](https://nhcx.sbxstage.in/docs/hiecm/v3/getting-started/sandbox): The six stages of sandbox integration, then how to request sandbox access, receive credentials, register a callback URL and note the base URLs. - [Security audit](https://nhcx.sbxstage.in/docs/hiecm/v3/getting-started/security-audit): Pass the WASA security audit and hold a Safe to Host certificate, which every application needs before it runs in production. - [Milestones](https://nhcx.sbxstage.in/docs/hiecm/v3/milestones): The four milestones, Create, Attach, Retrieve and Enrol, in build order, plus the three PHR milestones and which ones you need. - [M1 Identity: Create and verify ABHA](https://nhcx.sbxstage.in/docs/hiecm/v3/milestones/m1): Milestone 1 focuses on the creation and management of ABHA, the unique health identifier under ABDM, through ABDM-compliant workflows. - [M2 Health Information Provider: Create and link records](https://nhcx.sbxstage.in/docs/hiecm/v3/milestones/m2): Milestone 2 enables a HIP to create digital health records, link them with an ABHA Address, support discovery through a PHR app and share encrypted records. - [M3 Health Information User: Fetch data with consent](https://nhcx.sbxstage.in/docs/hiecm/v3/milestones/m3): Milestone 3 enables an HIU to request, receive and view a patient's health records from HIPs in a secure and consent-based manner. - [Milestone 4 (M4): Register Healthcare Professionals and Facilities](https://nhcx.sbxstage.in/docs/hiecm/v3/milestones/m4): Milestone 4 establishes the identity of healthcare professionals on the HPR and the details of healthcare facilities on the HFR. - [P1 Identity and login](https://nhcx.sbxstage.in/docs/hiecm/v3/milestones/p1): The patient side of M1: how a person registers in your PHR app, logs in, and which login routes are mandatory. - [P2 Linking and records](https://nhcx.sbxstage.in/docs/hiecm/v3/milestones/p2): The patient side of M2: how a PHR app finds records held elsewhere, links them to an ABHA address, and shares a profile at a facility. - [P3 Consent and notifications](https://nhcx.sbxstage.in/docs/hiecm/v3/milestones/p3): The patient side of M3: subscriptions, auto approval, granting and revoking consent, and fetching the records a grant covers. - [Authentication](https://nhcx.sbxstage.in/docs/hiecm/v3/reference/authentication): The credentials every ABDM call carries, and the headers that go with them. - [Error codes](https://nhcx.sbxstage.in/docs/hiecm/v3/reference/error-codes): Every error code the specifications carry, with its message and what to do. - [Registries](https://nhcx.sbxstage.in/docs/hiecm/v3/registries): What an ABDM registry is, why there are two, and where ABHA, HPR and HFR sit. - [ABHA Registry](https://nhcx.sbxstage.in/docs/hiecm/v3/registries/abha): The registry that identifies patients, the 14 digit ABHA number, the ABHA address, and what every milestone assumes about both. - [NHPR, the provider registries](https://nhcx.sbxstage.in/docs/hiecm/v3/registries/nhpr): The National Health Professional Registry, why professionals and facilities are registered separately, and which one you need first. - [HFR, the facility registry](https://nhcx.sbxstage.in/docs/hiecm/v3/registries/nhpr/hfr): The Health Facility Registry, what a facility record holds, the five call onboarding sequence, and how a bridge is linked to it. - [HPR, the professional registry](https://nhcx.sbxstage.in/docs/hiecm/v3/registries/nhpr/hpr): The Healthcare Professionals Registry, the HPID, what identifies a doctor, and the registration journey. - [Developer resources](https://nhcx.sbxstage.in/docs/hiecm/v3/resources): Test scenarios for ABDM integration and certification, and the documentation, AI-assisted tools and reference projects that support it. - [When something breaks](https://nhcx.sbxstage.in/docs/hiecm/v3/troubleshooting): Find the symptom you are seeing, not the error code, and work through the checks in order. - [Accepted, then nothing](https://nhcx.sbxstage.in/docs/hiecm/v3/troubleshooting/accepted-then-nothing): Discovery or care context linking started, the first call was accepted, and the flow stalled somewhere in the middle. - [The callback never arrives](https://nhcx.sbxstage.in/docs/hiecm/v3/troubleshooting/callback-never-arrives): A call returned 202, and nothing followed on your registered callback URL. The checks in order. - [Consent stuck in Requested](https://nhcx.sbxstage.in/docs/hiecm/v3/troubleshooting/consent-stuck-requested): A consent request was created and never moved to Granted or Denied. The checks in order. - [Everything returns 401](https://nhcx.sbxstage.in/docs/hiecm/v3/troubleshooting/everything-returns-401): Every call fails the same way, not just one endpoint. The checks in order, before you assume the gateway is down. - [The OTP never arrives](https://nhcx.sbxstage.in/docs/hiecm/v3/troubleshooting/otp-never-arrives): You requested an OTP and nothing reached the phone. The checks in order. - [Use cases](https://nhcx.sbxstage.in/docs/hiecm/v3/use-cases): End-to-end workflows that sit on top of a milestone. Each one names the milestone it belongs to and the calls it uses. - [Patient record share](https://nhcx.sbxstage.in/docs/hiecm/v3/use-cases/patient-record-share): A patient scans the QR code at your counter and pushes chosen records from their PHR app to your system, with no consent request raised by you. - [Scan and Pay](https://nhcx.sbxstage.in/docs/hiecm/v3/use-cases/scan-and-pay): A patient scans the QR code at your counter, sees their open orders in their PHR app, pays there, and your system learns the payment status. - [Scan and Register](https://nhcx.sbxstage.in/docs/hiecm/v3/use-cases/scan-and-register): A patient scans the QR code at your counter and shares their ABHA profile, so registration needs no typing and every record links to the right ABHA address. ## docs/nhcx - [Claim Settlement](https://nhcx.sbxstage.in/docs/nhcx/v1): End-to-end claim journey in plain language - [API references](https://nhcx.sbxstage.in/docs/nhcx/v1/api): Every operation published for this gateway, module by module. - [PMJAY adjudicator](https://nhcx.sbxstage.in/docs/nhcx/v1/api/adjudicator): The PMJAY adjudicator calls on NHCX: what each one does, the hosts they go to, and the guides that use them. - [ABHA biometric authentication](https://nhcx.sbxstage.in/docs/nhcx/v1/api/biometric): The ABHA biometric authentication calls on NHCX: what each one does, the hosts they go to, and the guides that use them. - [Claim](https://nhcx.sbxstage.in/docs/nhcx/v1/api/claim): The Claim calls on NHCX: what each one does, the hosts they go to, and the guides that use them. - [Claim errors](https://nhcx.sbxstage.in/docs/nhcx/v1/api/claim/errors): What Claim returns when a call fails, and what to do about it. - [Communication](https://nhcx.sbxstage.in/docs/nhcx/v1/api/communication): The Communication calls on NHCX: what each one does, the hosts they go to, and the guides that use them. - [Communication errors](https://nhcx.sbxstage.in/docs/nhcx/v1/api/communication/errors): What Communication returns when a call fails, and what to do about it. - [Coverage eligibility](https://nhcx.sbxstage.in/docs/nhcx/v1/api/eligibility): The Coverage eligibility calls on NHCX: what each one does, the hosts they go to, and the guides that use them. - [Coverage eligibility errors](https://nhcx.sbxstage.in/docs/nhcx/v1/api/eligibility/errors): What Coverage eligibility returns when a call fails, and what to do about it. - [Insurance plan](https://nhcx.sbxstage.in/docs/nhcx/v1/api/insurance-plan): The Insurance plan calls on NHCX: what each one does, the hosts they go to, and the guides that use them. - [Insurance plan errors](https://nhcx.sbxstage.in/docs/nhcx/v1/api/insurance-plan/errors): What Insurance plan returns when a call fails, and what to do about it. - [Onboarding](https://nhcx.sbxstage.in/docs/nhcx/v1/api/onboarding): The Onboarding calls on NHCX: what each one does, the hosts they go to, and the guides that use them. - [Other](https://nhcx.sbxstage.in/docs/nhcx/v1/api/other): The Other calls on NHCX: what each one does, the hosts they go to, and the guides that use them. - [Other errors](https://nhcx.sbxstage.in/docs/nhcx/v1/api/other/errors): What Other returns when a call fails, and what to do about it. - [Payment notice](https://nhcx.sbxstage.in/docs/nhcx/v1/api/payment-notice): The Payment notice calls on NHCX: what each one does, the hosts they go to, and the guides that use them. - [Payment notice errors](https://nhcx.sbxstage.in/docs/nhcx/v1/api/payment-notice/errors): What Payment notice returns when a call fails, and what to do about it. - [Pre-authorisation](https://nhcx.sbxstage.in/docs/nhcx/v1/api/preauth): The Pre-authorisation calls on NHCX: what each one does, the hosts they go to, and the guides that use them. - [Pre-authorisation errors](https://nhcx.sbxstage.in/docs/nhcx/v1/api/preauth/errors): What Pre-authorisation returns when a call fails, and what to do about it. - [Participant registry](https://nhcx.sbxstage.in/docs/nhcx/v1/api/registry): The Participant registry calls on NHCX: what each one does, the hosts they go to, and the guides that use them. - [Session](https://nhcx.sbxstage.in/docs/nhcx/v1/api/session): The Session calls on NHCX: what each one does, the hosts they go to, and the guides that use them. - [Status and search](https://nhcx.sbxstage.in/docs/nhcx/v1/api/status): The Status and search calls on NHCX: what each one does, the hosts they go to, and the guides that use them. - [Status and search errors](https://nhcx.sbxstage.in/docs/nhcx/v1/api/status/errors): What Status and search returns when a call fails, and what to do about it. - [Reprocess, cancel and shortfall](https://nhcx.sbxstage.in/docs/nhcx/v1/api/task): The reprocess, cancel and shortfall calls on NHCX: what each one does, the hosts they go to, and the guides that use them. - [Reprocess, cancel and shortfall errors](https://nhcx.sbxstage.in/docs/nhcx/v1/api/task/errors): What Reprocess, cancel and shortfall returns when a call fails, and what to do about it. - [Introduction](https://nhcx.sbxstage.in/docs/nhcx/v1/concepts): What NHCX is, objectives, participants, machine-readable specifications - [JWE Secure Messaging](https://nhcx.sbxstage.in/docs/nhcx/v1/concepts/jwe-status-and-errors): How an NHCX message is sealed for one recipient, carried unread by the exchange, opened at the other end, and refused when something is wrong. - [NHCX Use Cases](https://nhcx.sbxstage.in/docs/nhcx/v1/concepts/nhcx-use-cases): Catalog of all 38 NHA use cases across A, B, C, D, E series - [PMJAY on NHCX](https://nhcx.sbxstage.in/docs/nhcx/v1/concepts/pmjay-on-nhcx): What the Ayushman Bharat scheme changes on the network, and the scheme rules a hospital system must follow. - [PMJAY use cases](https://nhcx.sbxstage.in/docs/nhcx/v1/concepts/pmjay-use-cases): PMJAY-specific use cases D1 to D13 - [Workflow Codes](https://nhcx.sbxstage.in/docs/nhcx/v1/concepts/workflow-codes): The 74 workflow IDs and their message directions - [Base URLs](https://nhcx.sbxstage.in/docs/nhcx/v1/getting-started/base-urls): Every service's base in the sandbox and in production, from `baseurl.yaml` - [Build it well](https://nhcx.sbxstage.in/docs/nhcx/v1/getting-started/build-it-well): Who refused your message, which sends are safe to repeat, how to match an answer to its request, and what to do when no answer comes. - [Build with AI](https://nhcx.sbxstage.in/docs/nhcx/v1/getting-started/build-with-ai): Set a coding agent up to build your NHCX integration, from one use case skill to live retrieval over MCP. - [Building and sending a JWE](https://nhcx.sbxstage.in/docs/nhcx/v1/getting-started/building-and-sending-a-jwe): RSA-OAEP-256 + A256GCM compact serialisation - [Creating and updating a participant](https://nhcx.sbxstage.in/docs/nhcx/v1/getting-started/creating-and-updating-a-participant): Registry onboarding and participant updates - [Fetching a recipient certificate](https://nhcx.sbxstage.in/docs/nhcx/v1/getting-started/fetching-a-recipient-certificate): Certificate discovery and caching discipline - [Finding participants and policies](https://nhcx.sbxstage.in/docs/nhcx/v1/getting-started/finding-participants-and-policies): Search endpoints and policy resolution - [Get your sandbox credentials](https://nhcx.sbxstage.in/docs/nhcx/v1/getting-started/get-your-sandbox-credentials): Register the organisation, get an ABDM client ID and secret, take NHCX sandbox roles, and meet the dummy payer - [Glossary](https://nhcx.sbxstage.in/docs/nhcx/v1/getting-started/glossary): Definitive glossary of protocol, healthcare, and scheme terms - [The JWE message format](https://nhcx.sbxstage.in/docs/nhcx/v1/getting-started/jwe-message-format): The five parts of an NHCX JWE, the algorithms, every protected header field, status values, the receipt, error responses and correlation rules. - [NHCX adapter (Optional)](https://nhcx.sbxstage.in/docs/nhcx/v1/getting-started/nhcx-adapter): Turnkey protocol adapter implementation, optional - [Quickstart](https://nhcx.sbxstage.in/docs/nhcx/v1/getting-started/quickstart): Three calls with only your credentials: a session token, the dummy payer's registry record, and its certificate - [Receiving a callback](https://nhcx.sbxstage.in/docs/nhcx/v1/getting-started/receiving-a-callback): Asynchronous callback listener and 202 receipt handling - [Session token](https://nhcx.sbxstage.in/docs/nhcx/v1/getting-started/session-token): Minting and refreshing ABDM gateway session JWTs - [Status and search](https://nhcx.sbxstage.in/docs/nhcx/v1/getting-started/status-and-search): Status checking (`/v1/status`) and search queries (`/v1/search/submit`) - [The base framework](https://nhcx.sbxstage.in/docs/nhcx/v1/getting-started/the-base-framework): Six-step base client architecture - [Your certificate](https://nhcx.sbxstage.in/docs/nhcx/v1/getting-started/your-certificate): RSA-2048 key pair generation and self-signed certificate assembly - [Going live](https://nhcx.sbxstage.in/docs/nhcx/v1/go-live): Sandbox exit, production credentials, registering in production, switching addresses, the network path, the PMJAY cutover and the pilot - [Security audit](https://nhcx.sbxstage.in/docs/nhcx/v1/go-live/security-audit): The security tests for your role, the WASA audit, STQC or CERT-In review, and the certificates production asks for - [Access control and roles](https://nhcx.sbxstage.in/docs/nhcx/v1/reference/access-control-and-roles): Role permissions, search rights, consent headers, and registry attributes (`payment_details`) - [Authentication](https://nhcx.sbxstage.in/docs/nhcx/v1/reference/authentication): The credentials every ABDM call carries, and the headers that go with them. - [Envelope fields](https://nhcx.sbxstage.in/docs/nhcx/v1/reference/envelope-fields): Full JWE header table, obligations, and correlation rules - [Environments and addresses](https://nhcx.sbxstage.in/docs/nhcx/v1/reference/environments-and-addresses): Sandbox/production URLs, firewall IPs, token headers, and 12 sandbox Swagger specifications - [Reading error codes](https://nhcx.sbxstage.in/docs/nhcx/v1/reference/error-code-guide): Start here for errors. The four code spaces, the 18 PAYR codes that mean two things, and all 309 codes. - [Error codes](https://nhcx.sbxstage.in/docs/nhcx/v1/reference/error-codes): Every error code the specifications carry, with its message and what to do. - [Bundles and conventions](https://nhcx.sbxstage.in/docs/nhcx/v1/reference/fhir): Universal bundle rules, profiles, IDs, base64 encoding, and size limits - [Cancel, reprocess and shortfall](https://nhcx.sbxstage.in/docs/nhcx/v1/reference/fhir/cancel-reprocess-and-shortfall): Task-based cancel (`cancel`), reprocess (`reprocess`), balance release (`release`) and `nullify` - [Claim query and answer](https://nhcx.sbxstage.in/docs/nhcx/v1/reference/fhir/claim-query-and-answer): Claim query updates (wf 27 / 151) - [Claim request](https://nhcx.sbxstage.in/docs/nhcx/v1/reference/fhir/claim-request): Final claim bundle, `billablePeriod`, discharge evidence, and invoice attachments - [Claim response](https://nhcx.sbxstage.in/docs/nhcx/v1/reference/fhir/claim-response): Claim decisions, item adjudications, and verified rejection bundles (wf 291) - [Codes and value sets](https://nhcx.sbxstage.in/docs/nhcx/v1/reference/fhir/codes-and-value-sets): All code systems, bindings, and known NHA discrepancies - [Communication](https://nhcx.sbxstage.in/docs/nhcx/v1/reference/fhir/communication): Out-of-band communication payloads and reason codes - [Coverage eligibility request](https://nhcx.sbxstage.in/docs/nhcx/v1/reference/fhir/coverage-eligibility-request): Resource breakdown and fields - [Coverage eligibility response](https://nhcx.sbxstage.in/docs/nhcx/v1/reference/fhir/coverage-eligibility-response): Response bundle, wallet breakdown, and inforce flags - [Insurance plan request](https://nhcx.sbxstage.in/docs/nhcx/v1/reference/fhir/insurance-plan-request): Task-based plan polling request - [Insurance plan response, coverage-based](https://nhcx.sbxstage.in/docs/nhcx/v1/reference/fhir/insurance-plan-response-coverage-based): Commercial insurance plan layout - [Insurance plan response](https://nhcx.sbxstage.in/docs/nhcx/v1/reference/fhir/insurance-plan-response-overview): Collection bundle overview and questionnaires - [Insurance plan response, package-based](https://nhcx.sbxstage.in/docs/nhcx/v1/reference/fhir/insurance-plan-response-package-based): PMJAY package structure and claim condition extensions - [Payment notice and acknowledgement](https://nhcx.sbxstage.in/docs/nhcx/v1/reference/fhir/payment-notice-and-acknowledgement): Payment notices, reconciliations, and payment receipts - [Preauthorisation enhancement](https://nhcx.sbxstage.in/docs/nhcx/v1/reference/fhir/preauthorisation-enhancement): Enhancement payload, header `x-hcx-use_case: Enhancement`, and increment totals - [Preauthorisation query and answer](https://nhcx.sbxstage.in/docs/nhcx/v1/reference/fhir/preauthorisation-query-and-answer): Query resolution on preauth thread (wf 24 / 19) - [Preauthorisation request](https://nhcx.sbxstage.in/docs/nhcx/v1/reference/fhir/preauthorisation-request): Preauth Claim bundle, items, and ABDM clinical attachments - [Preauthorisation response](https://nhcx.sbxstage.in/docs/nhcx/v1/reference/fhir/preauthorisation-response): ClaimResponse, approvals, queries, and verified rejection bundles (wf 23) - [Status and search](https://nhcx.sbxstage.in/docs/nhcx/v1/reference/fhir/status-and-search): Specification and schemas for status and search - [Governance and audit](https://nhcx.sbxstage.in/docs/nhcx/v1/reference/governance-and-audit): Security layers, dual JWTs, log retention, grievance redressal, and onboarding checklist - [Notifications and patient apps](https://nhcx.sbxstage.in/docs/nhcx/v1/reference/notifications-and-patient-apps): Beneficiary service provider integration, subscription model, and push events - [PMJAY error codes](https://nhcx.sbxstage.in/docs/nhcx/v1/reference/pmjay-error-codes): Every NHCX and PMJAY error code in one searchable table, with the message as sent, what it means and the path it arrives on. - [Troubleshooting by layer and code](https://nhcx.sbxstage.in/docs/nhcx/v1/reference/troubleshooting): Five-layer fault isolation model and symptom-first diagnostic playbook - [Registries](https://nhcx.sbxstage.in/docs/nhcx/v1/registries): The two registries every NHCX call depends on: participants, and the policies linked to a beneficiary. - [Participant registry](https://nhcx.sbxstage.in/docs/nhcx/v1/registries/participant): How a participant joins NHCX, registers its key and callback address, authenticates, and finds other participants. - [Policy registry](https://nhcx.sbxstage.in/docs/nhcx/v1/registries/policy): How a beneficiary's policy is found by ABHA, member ID or mobile, which code to address, and how a payer links a policy to ABHA. - [Payer overview](https://nhcx.sbxstage.in/docs/nhcx/v1/roles/payer): Insurer and TPA ingestion architecture - [Adjudicating claims](https://nhcx.sbxstage.in/docs/nhcx/v1/roles/payer/adjudicating-claims): Adjudicating claims, deductions, dispute handling, and rejection bundles - [Adjudicating preauthorisation](https://nhcx.sbxstage.in/docs/nhcx/v1/roles/payer/adjudicating-preauthorisation): Evaluating medical necessity, raising queries, approval, and rejection - [Eligibility response](https://nhcx.sbxstage.in/docs/nhcx/v1/roles/payer/eligibility-response): Constructing coverage eligibility answers across all 4 purposes - [Payer checklist](https://nhcx.sbxstage.in/docs/nhcx/v1/roles/payer/payer-checklist): Payer sandbox exit list, the four validations, 26 test cases by family (T-ELG, T-PLN, T-PRE, T-CLM, T-TSK, T-PAY, T-COM, T-ENV) - [Payment notice and communication](https://nhcx.sbxstage.in/docs/nhcx/v1/roles/payer/payment-notice-and-communication): Dispatching payment notices and operational intimations - [Policies and plans](https://nhcx.sbxstage.in/docs/nhcx/v1/roles/payer/policies-and-plans): Publishing policy master and 21 MB plan bundles - [Payer UI guide](https://nhcx.sbxstage.in/docs/nhcx/v1/roles/payer/ui-guide): Payer adjudication desk screens and workflow - [Provider overview](https://nhcx.sbxstage.in/docs/nhcx/v1/roles/provider): Hospital integration architecture and queue flow - [Biometric authentication](https://nhcx.sbxstage.in/docs/nhcx/v1/roles/provider/biometric-authentication): ABDM biometric pipeline: Fingerprint, Iris, FaceAuth, and exemption consent - [Discharge and claim](https://nhcx.sbxstage.in/docs/nhcx/v1/roles/provider/discharge-and-claim): Cashless claim submission, discharge types, and billing evidence - [Insurance plan](https://nhcx.sbxstage.in/docs/nhcx/v1/roles/provider/insurance-plan): Dynamic package master retrieval and caching - [Payment and communication](https://nhcx.sbxstage.in/docs/nhcx/v1/roles/provider/payment-and-communication): Payment reconciliations (wf 30, 31, 33) and out-of-band communication - [PMJAY adjudication APIs](https://nhcx.sbxstage.in/docs/nhcx/v1/roles/provider/pmjay-adjudication-apis): The two payer service calls that read and drive a PMJAY case, the role walk, and what the desk refuses - [PMJAY provider](https://nhcx.sbxstage.in/docs/nhcx/v1/roles/provider/pmjay-provider): PMJAY-specific HMIS rules, STG questionnaires, GST, incentives, and size limits - [PMJAY sandbox run](https://nhcx.sbxstage.in/docs/nhcx/v1/roles/provider/pmjay-sandbox-run): A full PMJAY case on the sandbox in order, the refusals met and what each means, with placeholders for your own values - [Preauthorisation](https://nhcx.sbxstage.in/docs/nhcx/v1/roles/provider/preauthorisation): Preauth request submission, clinical attachments, and query handling - [Provider checklist](https://nhcx.sbxstage.in/docs/nhcx/v1/roles/provider/provider-checklist): Sandbox exit list, 29 test cases by family (T-ML1, T-PLN, T-ELG, T-PRE, T-CLM, T-PAY, T-COM, T-CBK, T-SES), first-week failures - [Registration and eligibility](https://nhcx.sbxstage.in/docs/nhcx/v1/roles/provider/registration-and-eligibility): Patient intake, Aadhaar eKYC and biometrics, and the coverage check - [Provider UI guide](https://nhcx.sbxstage.in/docs/nhcx/v1/roles/provider/ui-guide): Provider desk wireframes and UX recommendations - [NHCX support](https://nhcx.sbxstage.in/docs/nhcx/v1/support): Who to write to about NHCX integration, certification, FHIR bundles and credentials, and what to include so the call can be traced. - [When something breaks](https://nhcx.sbxstage.in/docs/nhcx/v1/troubleshooting): Find the symptom you see, not the error code, and open the chapter that walks its checks - [Accepted with 202, and no callback arrives](https://nhcx.sbxstage.in/docs/nhcx/v1/troubleshooting/accepted-then-no-callback): The exchange answered 202 and no callback followed: the six checks in order - [Every NHCX call returns 401](https://nhcx.sbxstage.in/docs/nhcx/v1/troubleshooting/every-call-returns-401): Every endpoint fails the same way: the token, its prefix, its header or its environment - [Responses arrive against the wrong request](https://nhcx.sbxstage.in/docs/nhcx/v1/troubleshooting/responses-arrive-against-the-wrong-request): Answers on the wrong case, duplicates refused, callbacks unmatched: correlation and API call IDs - [The payer rejects your FHIR bundle](https://nhcx.sbxstage.in/docs/nhcx/v1/troubleshooting/the-payer-rejects-your-bundle): `PAYR-1004`, `PAYR-1008` and the missing identifier codes: validate, then check shape, identifiers and attachments - [The recipient cannot decrypt your message](https://nhcx.sbxstage.in/docs/nhcx/v1/troubleshooting/the-recipient-cannot-decrypt): A `PAYR-1001` protocol response: the certificate, its cache, the algorithms and the compact form - [Your callback URL is rejected or never called](https://nhcx.sbxstage.in/docs/nhcx/v1/troubleshooting/your-callback-url-is-rejected): The endpoint update is refused, or nothing ever reaches your server - [What's new in NHCX](https://nhcx.sbxstage.in/docs/nhcx/v1/whats-new): Dated changes to what you can build against on NHCX, newest first. - [21 September 2026](https://nhcx.sbxstage.in/docs/nhcx/v1/whats-new/2026-09-21): What changed in the NHCX documentation on 21 September 2026. - [23 September 2026](https://nhcx.sbxstage.in/docs/nhcx/v1/whats-new/2026-09-23): What changed in the NHCX documentation on 23 September 2026. ## docs/support - [Support](https://nhcx.sbxstage.in/docs/support): Where to raise integration queries, API errors, onboarding and certification questions for the ABDM sandbox. ## docs/uhi - [Introduction](https://nhcx.sbxstage.in/docs/uhi/v1): What UHI is, the two roles you can build, and how far each service goes today. - [UHI API reference](https://nhcx.sbxstage.in/docs/uhi/v1/api): What is published for the UHI gateway today, and where the message shapes come from. - [UHI gateway](https://nhcx.sbxstage.in/docs/uhi/v1/concepts/network-and-protocol): The open network for discovering and booking health services, its two roles, and its signing scheme. - [Ambulance booking](https://nhcx.sbxstage.in/docs/uhi/v1/concepts/services/ambulance-booking): Find an ambulance nearby and get a quote from the provider, using the two call pairs live in this service today. - [AMRIT Pharmacy discovery](https://nhcx.sbxstage.in/docs/uhi/v1/concepts/services/amrit-pharmacy): Find AMRIT Pharmacy stores over UHI by store code, state and district, pincode or GPS radius. - [Blood bank discovery](https://nhcx.sbxstage.in/docs/uhi/v1/concepts/services/blood-bank): Search live blood stock by group and component across registered blood banks, using one call pair. - [Jan Aushadhi Kendra discovery](https://nhcx.sbxstage.in/docs/uhi/v1/concepts/services/jan-aushadhi-kendra): Find Jan Aushadhi Kendras over UHI by Kendra code, state and district, pincode or GPS radius. - [Jan Aushadhi medicine search](https://nhcx.sbxstage.in/docs/uhi/v1/concepts/services/jan-aushadhi-medicine-search): Search the Jan Aushadhi medicine catalogue, then find the Kendras that stock a chosen medicine. - [Physical consultation](https://nhcx.sbxstage.in/docs/uhi/v1/concepts/services/physical-consultation): Doctor discovery, appointment booking, PIN check-in and the full appointment lifecycle on UHI. - [PM-JAY HEM hospital discovery](https://nhcx.sbxstage.in/docs/uhi/v1/concepts/services/pmjay-hem): Find PM-JAY empanelled hospitals over UHI by state, district, speciality, facility name, pincode or GPS. - [Glossary](https://nhcx.sbxstage.in/docs/uhi/v1/getting-started/glossary): The ABDM terms UHI shares, and the two roles that belong to UHI alone. - [Onboarding to UHI](https://nhcx.sbxstage.in/docs/uhi/v1/getting-started/onboarding): How an application joins the UHI network, from the M2 gate to sandbox sign-off and production go-live. - [Registries](https://nhcx.sbxstage.in/docs/uhi/v1/registries): The registry UHI runs itself, the three ABDM identifiers that ride inside UHI messages, and which of them onboarding actually asks for. - [ABHA on UHI](https://nhcx.sbxstage.in/docs/uhi/v1/registries/abha): Where a patient's ABHA address appears in UHI messages, in which services it is mandatory, and what UHI does not do with it. - [HFR on UHI](https://nhcx.sbxstage.in/docs/uhi/v1/registries/hfr): The one UHI service that carries an HFR ID, the tag it travels in, and what is issued at onboarding. - [HPR on UHI](https://nhcx.sbxstage.in/docs/uhi/v1/registries/hpr): Where a practitioner's HPR ID appears in a UHI catalogue and a UHI order, and the two forms it takes. ## docs/whats-new - [What's new](https://nhcx.sbxstage.in/docs/whats-new): Dated changes to what you can build against, newest first. - [15 September 2026](https://nhcx.sbxstage.in/docs/whats-new/2026-09-15): What changed in these pages on 15 September 2026. - [16 September 2026](https://nhcx.sbxstage.in/docs/whats-new/2026-09-16): What changed in these pages on 16 September 2026. - [21 September 2026](https://nhcx.sbxstage.in/docs/whats-new/2026-09-21): What changed in these pages on 21 September 2026. - [22 September 2026](https://nhcx.sbxstage.in/docs/whats-new/2026-09-22): What changed in these pages on 22 September 2026. - [23 September 2026](https://nhcx.sbxstage.in/docs/whats-new/2026-09-23): What changed in these pages on 23 September 2026. ## Optional - [Agent skills](https://nhcx.sbxstage.in/skills): one markdown file per module, carrying its endpoints, error codes and test cases. - [GATEWAY module index](https://nhcx.sbxstage.in/docs/hiecm/v3/api/gateway/llms.txt): per-page links for the GATEWAY module. - [M1 module index](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m1/llms.txt): per-page links for the M1 module. - [M2 module index](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m2/llms.txt): per-page links for the M2 module. - [M3 module index](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m3/llms.txt): per-page links for the M3 module. - [M4 module index](https://nhcx.sbxstage.in/docs/hiecm/v3/api/m4/llms.txt): per-page links for the M4 module. - [P1 module index](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p1/llms.txt): per-page links for the P1 module. - [P2 module index](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p2/llms.txt): per-page links for the P2 module. - [P3 module index](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p3/llms.txt): per-page links for the P3 module. - [P4 module index](https://nhcx.sbxstage.in/docs/hiecm/v3/api/p4/llms.txt): per-page links for the P4 module. - [RECORD-SHARE module index](https://nhcx.sbxstage.in/docs/hiecm/v3/api/record-share/llms.txt): per-page links for the RECORD-SHARE module. - [SCAN-AND-PAY module index](https://nhcx.sbxstage.in/docs/hiecm/v3/api/scan-and-pay/llms.txt): per-page links for the SCAN-AND-PAY module. - [SCAN-AND-REGISTER module index](https://nhcx.sbxstage.in/docs/hiecm/v3/api/scan-and-register/llms.txt): per-page links for the SCAN-AND-REGISTER module. - [NHCX PMJAY adjudicator module index](https://nhcx.sbxstage.in/docs/nhcx/v1/api/adjudicator/llms.txt): per-page links for the NHCX PMJAY adjudicator module. - [NHCX ABHA biometric authentication module index](https://nhcx.sbxstage.in/docs/nhcx/v1/api/biometric/llms.txt): per-page links for the NHCX ABHA biometric authentication module. - [NHCX Claim module index](https://nhcx.sbxstage.in/docs/nhcx/v1/api/claim/llms.txt): per-page links for the NHCX Claim module. - [NHCX Communication module index](https://nhcx.sbxstage.in/docs/nhcx/v1/api/communication/llms.txt): per-page links for the NHCX Communication module. - [NHCX Coverage eligibility module index](https://nhcx.sbxstage.in/docs/nhcx/v1/api/eligibility/llms.txt): per-page links for the NHCX Coverage eligibility module. - [NHCX Insurance plan module index](https://nhcx.sbxstage.in/docs/nhcx/v1/api/insurance-plan/llms.txt): per-page links for the NHCX Insurance plan module. - [NHCX Onboarding module index](https://nhcx.sbxstage.in/docs/nhcx/v1/api/onboarding/llms.txt): per-page links for the NHCX Onboarding module. - [NHCX Other module index](https://nhcx.sbxstage.in/docs/nhcx/v1/api/other/llms.txt): per-page links for the NHCX Other module. - [NHCX Payment notice module index](https://nhcx.sbxstage.in/docs/nhcx/v1/api/payment-notice/llms.txt): per-page links for the NHCX Payment notice module. - [NHCX Pre-authorisation module index](https://nhcx.sbxstage.in/docs/nhcx/v1/api/preauth/llms.txt): per-page links for the NHCX Pre-authorisation module. - [NHCX Participant registry module index](https://nhcx.sbxstage.in/docs/nhcx/v1/api/registry/llms.txt): per-page links for the NHCX Participant registry module. - [NHCX Session module index](https://nhcx.sbxstage.in/docs/nhcx/v1/api/session/llms.txt): per-page links for the NHCX Session module. - [NHCX Status and search module index](https://nhcx.sbxstage.in/docs/nhcx/v1/api/status/llms.txt): per-page links for the NHCX Status and search module. - [NHCX Reprocess, cancel and shortfall module index](https://nhcx.sbxstage.in/docs/nhcx/v1/api/task/llms.txt): per-page links for the NHCX Reprocess, cancel and shortfall module.