Onboarding APIs (Production)

Create, update, and validate NHCX participants in the production participant service.

Use these production APIs after NHCX grants production access.

Replace each sample ID, URL, and contact value before use.

Production access

Use only approved production credentials and production participant data.

POST /v2/participant/update

POSThttps://apisprod.nha.gov.in/pmjay/hcx/participanthcxservice/v2/participant/update

Update a production participant record.

Headers

Header	Value	Notes
`Accept`	`application/json`	The source sets this header.
`bearer_auth`	`$TOKEN`	The source uses Postman bearer auth.

Request body

POST /v2/participant/update request

{
  "participantcode": "12345678934@hcx",
  "encryptioncert": "BASE64_CERTIFICATE",
  "endpointurl": "https://example.com"
}

cURL

Update a production participant

curl -X POST "https://apisprod.nha.gov.in/pmjay/hcx/participanthcxservice/v2/participant/update" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '
{
  "participantcode": "12345678934@hcx",
  "encryptioncert": "BASE64_CERTIFICATE",
  "endpointurl": "https://example.com"
}
  '

GET /update/validate

GET

https://apisprod.nha.gov.in/pmjay/hcx/participanthcxservice/update/validate?transactionId=$TRANSACTION_ID&passcode=$PASSCODE

Validate a participant update transaction.

Headers

Header	Value	Notes
`Accept`	`application/json`	The source sets this header.

cURL

Validate a production participant update

curl -X GET "https://apisprod.nha.gov.in/pmjay/hcx/participanthcxservice/update/validate?transactionId=$TRANSACTION_ID&passcode=$PASSCODE" \
  -H "Accept: application/json"

GET /validate

GEThttps://apisprod.nha.gov.in/pmjay/hcx/participanthcxservice/validate?transactionId=$TRANSACTION_ID&passcode=$PASSCODE

Validate a participant create transaction.

Headers

Header	Value	Notes
`Accept`	`application/json`	The source sets this header.

cURL

Validate a production participant create request

curl -X GET "https://apisprod.nha.gov.in/pmjay/hcx/participanthcxservice/validate?transactionId=$TRANSACTION_ID&passcode=$PASSCODE" \
  -H "Accept: application/json"

POST /v2/participant/create

POSThttps://apisprod.nha.gov.in/pmjay/hcx/participanthcxservice/v2/participant/create

Create a production participant record.

Headers

Header	Value	Notes
`Accept`	`application/json`	The source sets this header.
`bearer_auth`	`$TOKEN`	The source uses Postman bearer auth.

Request body

POST /v2/participant/create request

{
  "registrytype": "1000X",
  "registryid": "12345678934",
  "role": [
    "1000X"
  ],
  "endpoint_url": "https://example.com",
  "mobilenumber": "1234567890",
  "email": "test01@example.com"
}

cURL

Create a production participant

curl -X POST "https://apisprod.nha.gov.in/pmjay/hcx/participanthcxservice/v2/participant/create" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '
{
  "registrytype": "1000X",
  "registryid": "12345678934",
  "role": [
    "1000X"
  ],
  "endpoint_url": "https://example.com",
  "mobilenumber": "1234567890",
  "email": "test01@example.com"
}
  '

Reference values

Field	Allowed values from the source
Role	`10001` provider, `10002` payer, `10003` TPA, `10004` regulator, `10005` research, `10006` ISNP member, `10007` sponsor, `10008` HIE or HIO HCX
Registry	`10001` HFR, `10002` NIN, `10003` ROHINI, `10004` payer

Sources

onboarding-apis-production-postman.md (NHCX sandbox portal)

PreviousOnboarding APIs (Sandbox)Next Participant Service APIs