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.
APIs
Onboarding differs between the two environments. The sandbox registers a participant in one call. Production registers it in steps, each confirmed with a passcode sent to the registered mobile number.
Sandbox
Base URL: https://apisbx.abdm.gov.in/pmjay/sbxhcx/participanthcxservice. Credentials: the client ID and secret you received when you registered on the ABDM sandbox.
| Call | Called by | Method and path | What it does |
|---|---|---|---|
| Participant create (v1) | Provider or payer | POST /participant/create | Creates a participant record in the NHCX registry from a full v1 profile and returns the generated participant_code. |
To change the record later in the sandbox, use Submit the participant update (v1) in the participant registry.
Production
Base URL: https://apisprod.nha.gov.in/pmjay/hcx/participanthcxservice. Credentials: the production credentials issued after sandbox certification. The rows run in the order the steps happen.
| Call | Called by | Method and path | What it does |
|---|---|---|---|
| Participant create (v2) | Provider or payer | POST /v2/participant/create | Registry-linked creation: registry type and ID, role codes, endpoint URL and contacts; returns participantid and a transactionid for /validate. |
| Validate participant creation | Provider or payer | GET /validate | Confirms a participant creation by presenting the SMS passcode and the transactionId returned by /v2/participant/create. |
| Submit the participant certificate and bridge update (v2) | Provider or payer | POST /v2/participant/update | Stages the certificate and callback URL; the call sits in the participant registry. |
| Validate participant update | Provider or payer | GET /update/validate | Confirms a participant update by presenting the SMS passcode and the transactionId returned by /v2/participant/update. |
Scheme hospital onboarding
No environment limit is published for this call. Use it when the scheme operator, for example PMJAY, asks for this form.
| Call | Called by | Method and path | What it does |
|---|---|---|---|
| HEM-entity participant create | Provider (a hospital) | 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. |
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.