Onboarding APIs (Sandbox)

Create and update NHCX participants in the sandbox participant service.

Use these sandbox APIs to create a participant record and update it later.

Replace sample values before you send a request.

Source placeholders

The source redacts bearer tokens. Use the issued sandbox token in each request.

POST Participant Create

POSThttps://apisbx.abdm.gov.in/pmjay/sbxhcx/participanthcxservice/participant/create

Create a participant record in the sandbox participant service.

The source disables the source header for this request.

Headers

Header	Value	Notes
`Accept`	`application/json`	The source sets this header.
`Content-Type`	`application/json`	Send a JSON body.
`bearer_auth`	`$TOKEN`	The source uses Postman bearer auth.

Request body

POST Participant Create request

{
  "linked_registry_codes": [
    "10001"
  ],
  "registryid": "CLIENT_ID",
  "participant_name": "Test Payer",
  "scheme_code": "PMJAY",
  "state": "Haryana",
  "district": "Panchkula",
  "roles": [
    "10002"
  ],
  "primaryEmail": "test@example.com",
  "phone": [
    "1234567891"
  ],
  "primaryMobile": "1234567890",
  "signing_cert_path": "https://example.com/encryption.cert",
  "encryption_cert": "BASE64_CERTIFICATE",
  "endpoint_url": "https://example.com/healthbridge"
}

cURL

Create a sandbox participant

curl -X POST "https://apisbx.abdm.gov.in/pmjay/sbxhcx/participanthcxservice/participant/create" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '
{
  "linked_registry_codes": [
    "10001"
  ],
  "registryid": "CLIENT_ID",
  "participant_name": "Test Payer",
  "scheme_code": "PMJAY",
  "state": "Haryana",
  "district": "Panchkula",
  "roles": [
    "10002"
  ],
  "primaryEmail": "test@example.com",
  "phone": [
    "1234567891"
  ],
  "primaryMobile": "1234567890",
  "signing_cert_path": "https://example.com/encryption.cert",
  "encryption_cert": "BASE64_CERTIFICATE",
  "endpoint_url": "https://example.com/healthbridge"
}
  '

POST Participant Update

POSThttps://apisbx.abdm.gov.in/pmjay/sbxhcx/participanthcxservice/participant/update

Update a participant record in the sandbox participant service.

Headers

Header	Value	Notes
`Accept`	`application/json`	The source sets this header.
`Content-Type`	`application/json`	Send a JSON body.
`bearer_auth`	`$TOKEN`	The source uses Postman bearer auth.

Request body

POST Participant Update request

{
  "participant_code": "12345678952@hcx",
  "participant_name": "Test Name Changed",
  "scheme_code": "PMJAY",
  "roles": [
    "10002"
  ],
  "primaryEmail": "test@example.com",
  "phone": [
    "08040004000"
  ],
  "primaryMobile": "1234567890",
  "signing_cert_path": "https://example.com/encryption.cert",
  "encryption_cert": "BASE64_CERTIFICATE",
  "endpoint_url": "https://sbxhcx.abdm.gov.in/bridgepayer"
}

cURL

Update a sandbox participant

curl -X POST "https://apisbx.abdm.gov.in/pmjay/sbxhcx/participanthcxservice/participant/update" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '
{
  "participant_code": "12345678952@hcx",
  "participant_name": "Test Name Changed",
  "scheme_code": "PMJAY",
  "roles": [
    "10002"
  ],
  "primaryEmail": "test@example.com",
  "phone": [
    "08040004000"
  ],
  "primaryMobile": "1234567890",
  "signing_cert_path": "https://example.com/encryption.cert",
  "encryption_cert": "BASE64_CERTIFICATE",
  "endpoint_url": "https://sbxhcx.abdm.gov.in/bridgepayer"
}
  '

Sources

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

PreviousFAQs Next Onboarding APIs (Production)