Production Onboarding

Create, confirm, and update NHCX production participants with the required role and registry ENUM values.

Production onboarding creates a participant in the NHCX production registry. NHCX validates each request before it issues a participant ID.

Use registered contact details

NHCX sends each passcode to the registered mobile number. Use the number in the trusted registry.

Onboarding flow

Create the participant

Call the participant create API with a valid registry type, registry ID, role, endpoint URL, mobile number, and email.

NHCX sends a passcode to the registered mobile number.

Store the transaction ID from the response.

Confirm participant creation

Call the participant creation validate API with the transaction ID and passcode.

Use the passcode only with the correct transaction ID.

Update the participant

Call the participant update API after confirmation.

Send the participant code, the endpoint URL, and the base64 public certificate.

Confirm participant update

Call the update validate API with the transaction ID and passcode.

Use the transaction ID and passcode within 24 hours.

Lost transaction ID

Create a new create request or update request if you lose the transaction ID.

Production API sequence

Step	API	Purpose	Implemented by
1	`POST https://apisprod.nha.gov.in/pmjay/hcx/participanthcxservice/v2/participant/create`	Create the NHCX participant.	NHCX
2	`https://apisprod.nha.gov.in/pmjay/hcx/participanthcxservice/validate?transactionId={transactionId}&passcode={passcode}`	Confirm participant creation.	NHCX
3	`POST https://apisprod.nha.gov.in/pmjay/hcx/participanthcxservice/v2/participant/update`	Update participant details.	NHCX
4	`https://apisprod.nha.gov.in/pmjay/hcx/participanthcxservice/update/validate?transactionId={transactionId}&passcode={passcode}`	Confirm participant update.	NHCX
5	`POST https://apisprod.nha.gov.in/pmjay/hcx/participanthcxservice/v2/update/cert`	Update only the participant certificate.	NHCX

Validation rules

Area	Validation
Registry type	The registry type must match a valid registry ENUM.
Role	The role must match a valid role ENUM.
Mobile number	The mobile number must already exist in the NHCX system.
Provider mobile number	The provider mobile number must match the number in HFR.
Payer mobile number	The payer mobile number must match the number in NHCX payer details.
Creation passcode	Each create request creates a new transaction ID and passcode.
Update participant code	The participant code must exist in NHCX.
Update confirmation	Participant creation confirmation must be complete before participant update.
Public certificate	The public certificate must use base64 format.
Update passcode	Each update request creates a new transaction ID and passcode.
Passcode validity	The transaction ID and passcode remain valid for 24 hours.
Certificate update	Participant ID and certificate are mandatory.

Valid role ENUMs

Role	Code
`PROVIDER`	`10001`
`PAYER`	`10002`
`AGENCY_TPA`	`10003`
`AGENCY_REGULATOR`	`10004`
`RESEARCH`	`10005`
`MEMBER_ISNP`	`10006`
`AGENCY_SPONSOR`	`10007`
`HIE_HIO_HCX`	`10008`
`EUA`	`10009`

Valid registry ENUMs

Registry	Code
`HFR`	`10001`
`NIN`	`10002`
`ROHINI`	`10003`
`PAYER`	`10004`

Request and response examples

Participant create request

{
  "registrytype": "10001",
  "registryid": "XXXXX74586",
  "role": ["10001"],
  "endpoint_url": "",
  "mobilenumber": "XXXX748348",
  "email": "sample@gmail.com"
}

Participant create response

{
  "participantid": "XXXXX7583@hcx",
  "facilityname": "TEST Hospitals",
  "facilitycontact": "XXXXXXX452",
  "facilityemail": "sample@gmail.com",
  "transactionid": "1vouv8tlz2tnl-1fpspjhwj07c6",
  "error": {
    "code": null,
    "message": null,
    "trace": null
  }
}

Participant update request

{
  "participantcode": "XXXXXXX934@hcx",
  "encryptioncert": "certificate in base64",
  "endpointurl": "base url"
}

Participant update response

{
  "participant_code": "XXXXX78934@hcx",
  "status": "",
  "transactionid": "1fdesnz05o61g-1dl43hc511j1g"
}

Certificate update request

{
  "participantId": "XXXX@hcx",
  "certificate": "base64"
}

Read Encryption Certificate before you create the certificate value.

Sources

onboarding-production.md (NHCX production portal)

PreviousSandbox Onboarding Next Token Generation