Participant Service APIs

Use sandbox participant APIs to fetch policies, manage ABHA policy links, and fetch certificates.

Use these APIs to query participant data in the sandbox.

Use a sandbox bearer token for every request.

POST Get Policies

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

Fetch policies for a mobile number, an ABHA number, or a member ID.

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 Get Policies request

{
  "identifiertype": "MobileNo",
  "identifiervalue": "1234567890"
}

cURL

Fetch policies

curl -X POST "https://apisbx.abdm.gov.in/pmjay/sbxhcx/participanthcxservice/participant/get/policies" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '
{
  "identifiertype": "MobileNo",
  "identifiervalue": "1234567890"
}
  '

POST Delink ABHA

POSThttps://apisbx.abdm.gov.in/pmjay/sbxhcx/participanthcxservice/participant/delink/abha/policy

Remove an ABHA link from one or more policies.

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 Delink ABHA request

{
  "requestid": "5f314cf3-b24f-4cde-98e3-585b5d7d0bc0",
  "payerid": "PAYER_ID@hcx",
  "memberid": "CustXXXXX085",
  "processingid": "TPA_ID@hcx",
  "policies": [
    {
      "productid": "Prod01",
      "productname": "Active Asure"
    }
  ]
}

cURL

Delink ABHA from a policy

curl -X POST "https://apisbx.abdm.gov.in/pmjay/sbxhcx/participanthcxservice/participant/delink/abha/policy" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '
{
  "requestid": "5f314cf3-b24f-4cde-98e3-585b5d7d0bc0",
  "payerid": "PAYER_ID@hcx",
  "memberid": "CustXXXXX085",
  "processingid": "TPA_ID@hcx",
  "policies": [
    {
      "productid": "Prod01",
      "productname": "Active Asure"
    }
  ]
}
  '

POST Fetch Certs

POSThttps://apisbx.abdm.gov.in/pmjay/sbxhcx/participanthcxservice/fetch/certs

Fetch certificates for a participant ID.

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 Fetch Certs request

{
  "participantid": "12345678912@hcx"
}

cURL

Fetch participant certificates

curl -X POST "https://apisbx.abdm.gov.in/pmjay/sbxhcx/participanthcxservice/fetch/certs" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '
{
  "participantid": "12345678912@hcx"
}
  '

POST Participant List

POSThttps://apisbx.abdm.gov.in/pmjay/sbxhcx/participanthcxservice/fetch/participants/list

Fetch a participant list by role and date range.

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 List request

{
  "role": "PAYER",
  "fromdate": "10/05/2023",
  "todate": "11/05/2024"
}

cURL

Fetch the participant list

curl -X POST "https://apisbx.abdm.gov.in/pmjay/sbxhcx/participanthcxservice/fetch/participants/list" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '
{
  "role": "PAYER",
  "fromdate": "10/05/2023",
  "todate": "11/05/2024"
}
  '

POST Link ABHA

POSThttps://apisbx.abdm.gov.in/pmjay/sbxhcx/participanthcxservice/participant/link/abha/policy

Link an ABHA number to one or more policies.

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 Link ABHA request

{
  "requestid": "e011c4a2-1111-2222-3333-50d06af51555",
  "abhanumber": "11223344556612",
  "mobilenumber": "1234567890",
  "payerid": "PAYER_ID@hcx",
  "memberid": "Cust0XXXXX085",
  "processingid": "TPA_ID@hcx",
  "policies": [
    {
      "productid": "ProdXX01",
      "productname": "Active Asure"
    },
    {
      "productid": "ProdXX02",
      "productname": "Life Insurance Policy"
    }
  ]
}

cURL

Link ABHA to policies

curl -X POST "https://apisbx.abdm.gov.in/pmjay/sbxhcx/participanthcxservice/participant/link/abha/policy" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '
{
  "requestid": "e011c4a2-1111-2222-3333-50d06af51555",
  "abhanumber": "11223344556612",
  "mobilenumber": "1234567890",
  "payerid": "PAYER_ID@hcx",
  "memberid": "Cust0XXXXX085",
  "processingid": "TPA_ID@hcx",
  "policies": [
    {
      "productid": "ProdXX01",
      "productname": "Active Asure"
    },
    {
      "productid": "ProdXX02",
      "productname": "Life Insurance Policy"
    }
  ]
}
  '

Sources

participant-service-apis-sandbox-postman.md (NHCX sandbox portal)

PreviousOnboarding APIs (Production)Next Use Case APIs