Use Case APIs

Send sandbox NHCX use case requests and callbacks with encrypted JWE payloads.

Use these APIs to send NHCX use case messages in the sandbox.

Each request uses a bearer token and a JSON body.

Encrypted payloads

The source payloads are encrypted JWE values. Replace JWE_PAYLOAD with a valid encrypted payload.

Source URL typo

The source URL for paymentnotice on_request misses a slash before hcx. This page uses the standard sandbox host path.

POST /v1/insuranceplan/on_request

POSThttps://apisbx.abdm.gov.in/hcx/v1/insuranceplan/on_request

Send an insurance plan response callback.

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 /v1/insuranceplan/on_request request

{
  "type": "JWEPayload",
  "payload": "<JWE_PAYLOAD>"
}

cURL

POST v1 insuranceplan on_request

curl -X POST "https://apisbx.abdm.gov.in/hcx/v1/insuranceplan/on_request" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '
{
  "type": "JWEPayload",
  "payload": "<JWE_PAYLOAD>"
}
  '

POST /v1/insuranceplan/request

POSThttps://apisbx.abdm.gov.in/hcx/v1/insuranceplan/request

Send an insurance plan 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 /v1/insuranceplan/request request

{
  "payload": "<JWE_PAYLOAD>"
}

cURL

POST v1 insuranceplan request

curl -X POST "https://apisbx.abdm.gov.in/hcx/v1/insuranceplan/request" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '
{
  "payload": "<JWE_PAYLOAD>"
}
  '

POST /v1/coverageeligibility/check

POSThttps://apisbx.abdm.gov.in/hcx/v1/coverageeligibility/check

Send a coverage eligibility check 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 /v1/coverageeligibility/check request

{
  "payload": "<JWE_PAYLOAD>"
}

cURL

POST v1 coverageeligibility check

curl -X POST "https://apisbx.abdm.gov.in/hcx/v1/coverageeligibility/check" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '
{
  "payload": "<JWE_PAYLOAD>"
}
  '

POST /v1/coverageeligibility/on_check

POSThttps://apisbx.abdm.gov.in/hcx/v1/coverageeligibility/on_check

Send a coverage eligibility callback.

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 /v1/coverageeligibility/on_check request

{
  "type": "JWEPayload",
  "payload": "<JWE_PAYLOAD>"
}

cURL

POST v1 coverageeligibility on_check

curl -X POST "https://apisbx.abdm.gov.in/hcx/v1/coverageeligibility/on_check" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '
{
  "type": "JWEPayload",
  "payload": "<JWE_PAYLOAD>"
}
  '

POST /v1/preauth/submit

POSThttps://apisbx.abdm.gov.in/hcx/v1/preauth/submit

Send a preauth submit 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 /v1/preauth/submit request

{
  "payload": "<JWE_PAYLOAD>"
}

cURL

POST v1 preauth submit

curl -X POST "https://apisbx.abdm.gov.in/hcx/v1/preauth/submit" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '
{
  "payload": "<JWE_PAYLOAD>"
}
  '

POST /v1/preauth/on_submit

POSThttps://apisbx.abdm.gov.in/hcx/v1/preauth/on_submit

Send a preauth submit callback.

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 /v1/preauth/on_submit request

{
  "type": "JWEPayload",
  "payload": "<JWE_PAYLOAD>"
}

cURL

POST v1 preauth on_submit

curl -X POST "https://apisbx.abdm.gov.in/hcx/v1/preauth/on_submit" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '
{
  "type": "JWEPayload",
  "payload": "<JWE_PAYLOAD>"
}
  '

POST /v1/claim/submit

POSThttps://apisbx.abdm.gov.in/hcx/v1/claim/submit

Send a claim submit 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 /v1/claim/submit request

{
  "payload": "<JWE_PAYLOAD>"
}

cURL

POST v1 claim submit

curl -X POST "https://apisbx.abdm.gov.in/hcx/v1/claim/submit" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '
{
  "payload": "<JWE_PAYLOAD>"
}
  '

POST /v1/claim/on_submit

POSThttps://apisbx.abdm.gov.in/hcx/v1/claim/on_submit

Send a claim submit callback.

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 /v1/claim/on_submit request

{
  "type": "JWEPayload",
  "payload": "<JWE_PAYLOAD>"
}

cURL

POST v1 claim on_submit

curl -X POST "https://apisbx.abdm.gov.in/hcx/v1/claim/on_submit" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '
{
  "type": "JWEPayload",
  "payload": "<JWE_PAYLOAD>"
}
  '

POST /v1/paymentnotice/request

POSThttps://apisbx.abdm.gov.in/hcx/v1/paymentnotice/request

Send a payment notice 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 /v1/paymentnotice/request request

{
  "payload": "<JWE_PAYLOAD>"
}

cURL

POST v1 paymentnotice request

curl -X POST "https://apisbx.abdm.gov.in/hcx/v1/paymentnotice/request" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '
{
  "payload": "<JWE_PAYLOAD>"
}
  '

POST /v1/paymentnotice/on_request

POSThttps://apisbx.abdm.gov.in/hcx/v1/paymentnotice/on_request

Send a payment notice callback.

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 /v1/paymentnotice/on_request request

{
  "type": "JWEPayload",
  "payload": "<JWE_PAYLOAD>"
}

cURL

POST v1 paymentnotice on_request

curl -X POST "https://apisbx.abdm.gov.in/hcx/v1/paymentnotice/on_request" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '
{
  "type": "JWEPayload",
  "payload": "<JWE_PAYLOAD>"
}
  '

POST /v1/task/submit (Reprocess)

POSThttps://apisbx.abdm.gov.in/hcx/v1/task/submit

Send a task reprocess 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 /v1/task/submit (Reprocess) request

{
  "payload": "<JWE_PAYLOAD>"
}

cURL

POST v1 task submit (Reprocess)

curl -X POST "https://apisbx.abdm.gov.in/hcx/v1/task/submit" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '
{
  "payload": "<JWE_PAYLOAD>"
}
  '

POST /v1/task/on_submit (Reprocess)

POSThttps://apisbx.abdm.gov.in/hcx/v1/task/on_submit

Send a task reprocess callback.

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 /v1/task/on_submit (Reprocess) request

{
  "type": "JWEPayload",
  "payload": "<JWE_PAYLOAD>"
}

cURL

POST v1 task on_submit (Reprocess)

curl -X POST "https://apisbx.abdm.gov.in/hcx/v1/task/on_submit" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '
{
  "type": "JWEPayload",
  "payload": "<JWE_PAYLOAD>"
}
  '

POST /v1/communication/request

POSThttps://apisbx.abdm.gov.in/hcx/v1/communication/request

Send a communication 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 /v1/communication/request request

{
  "payload": "<JWE_PAYLOAD>"
}

cURL

POST v1 communication request

curl -X POST "https://apisbx.abdm.gov.in/hcx/v1/communication/request" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '
{
  "payload": "<JWE_PAYLOAD>"
}
  '

POST /communication/on_request

POSThttps://apisbx.abdm.gov.in/hcx/v1/communication/on_request

Send a communication callback.

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 /communication/on_request request

{
  "type": "JWEPayload",
  "payload": "<JWE_PAYLOAD>"
}

cURL

POST communication on_request

curl -X POST "https://apisbx.abdm.gov.in/hcx/v1/communication/on_request" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '
{
  "type": "JWEPayload",
  "payload": "<JWE_PAYLOAD>"
}
  '

POST /v1/search/submit

POSThttps://apisbx.abdm.gov.in/hcx/v1/search/submit

Send a search submit 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 /v1/search/submit request

{
  "payload": "<JWE_PAYLOAD>"
}

cURL

POST v1 search submit

curl -X POST "https://apisbx.abdm.gov.in/hcx/v1/search/submit" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '
{
  "payload": "<JWE_PAYLOAD>"
}
  '

POST /v1/search/on_submit

POSThttps://apisbx.abdm.gov.in/hcx/v1/search/on_submit

Send a search submit callback.

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 /v1/search/on_submit request

{
  "type": "JWEPayload",
  "payload": "<JWE_PAYLOAD>"
}

cURL

POST v1 search on_submit

curl -X POST "https://apisbx.abdm.gov.in/hcx/v1/search/on_submit" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '
{
  "type": "JWEPayload",
  "payload": "<JWE_PAYLOAD>"
}
  '

POST /v1/predetermination/submit

POSThttps://apisbx.abdm.gov.in/hcx/v1/predetermination/submit

Send a predetermination submit 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 /v1/predetermination/submit request

{
  "payload": "<JWE_PAYLOAD>"
}

cURL

POST v1 predetermination submit

curl -X POST "https://apisbx.abdm.gov.in/hcx/v1/predetermination/submit" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '
{
  "payload": "<JWE_PAYLOAD>"
}
  '

POST /v1/predetermination/on_submit

POSThttps://apisbx.abdm.gov.in/hcx/v1/predetermination/on_submit

Send a predetermination callback.

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 /v1/predetermination/on_submit request

{
  "type": "JWEPayload",
  "payload": "<JWE_PAYLOAD>"
}

cURL

POST v1 predetermination on_submit

curl -X POST "https://apisbx.abdm.gov.in/hcx/v1/predetermination/on_submit" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '
{
  "type": "JWEPayload",
  "payload": "<JWE_PAYLOAD>"
}
  '

POST /v1/status

POSThttps://apisbx.abdm.gov.in/hcx/v1/status

Send a status 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 /v1/status request

{
  "payload": "<JWE_PAYLOAD>"
}

cURL

POST v1 status

curl -X POST "https://apisbx.abdm.gov.in/hcx/v1/status" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '
{
  "payload": "<JWE_PAYLOAD>"
}
  '

POST /v1/on_status

POSThttps://apisbx.abdm.gov.in/hcx/v1/on_status

Send a status callback.

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 /v1/on_status request

{
  "type": "JWEPayload",
  "payload": "<JWE_PAYLOAD>"
}

cURL

POST v1 on_status

curl -X POST "https://apisbx.abdm.gov.in/hcx/v1/on_status" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '
{
  "type": "JWEPayload",
  "payload": "<JWE_PAYLOAD>"
}
  '

Sources

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

PreviousParticipant Service APIs Next Biometric Authentication APIs