Onboarding
Nothing moves through NHCX until both the sender and the recipient exist in the participant registry, which the platform treats as the source of truth for who may exchange claims data.
Calls
| Call | Method and path | What it does |
|---|---|---|
| Participant create (v1) | POST /participant/create | Creates a participant record in the NHCX registry from a full v1 profile and returns the generated participant_code. |
| Participant create (v2) | POST /v2/participant/create | Registry-linked creation: registry type and ID, role codes, endpoint URL and contacts; returns participantid and a transactionid for /validate. |
| HEM-entity participant create | POST /v2/participant/hementity/create | Creates a hospital (HEM-entity) participant from the full empanelment payload (bank, tax, beds, specialities, doctors); returns status and hospitalid. |
| Validate participant creation | GET /validate | Confirms a participant creation by presenting the SMS passcode and the transactionId returned by /v2/participant/create. |
| Validate participant update | GET /update/validate | Confirms a participant update by presenting the SMS passcode and the transactionId returned by /v2/participant/update. |
Base URLs
| Environment | Base URL |
|---|---|
| Sandbox, Participant service. | https://apisbx.abdm.gov.in/pmjay/sbxhcx/participanthcxservice |
| Production. | https://apisprod.nha.gov.in/pmjay/hcx/participanthcxservice |
Guides that use these calls
The whole specification, with a request you can send from the page, is the Onboarding API reference.