consent_management

Get Subscription Details by Request ID

Returns one subscription request with its status and details, by the request id.

GET/api/consent-management/subscription-requests/request/{subscriptionRequestId}

Authorizations

Authorizationbearer tokenRequired

The access token from POST /api/hiecm/gateway/v3/sessions.

Path parameters

subscriptionRequestIdstringRequired

Passed as a path segment.

Responses

200

Example values, scrubbed.

400

Example values, scrubbed.

Error codes for this module

401

Example values, scrubbed.

Everything returns 401

500

Example values, scrubbed.

Error codes for this module

Get Subscription Details by Request ID

curl --request GET \
  --url https://phrsbx.abdm.gov.in/api/consent-management/subscription-requests/request/{subscriptionRequestId} \
  --header 'Authorization: Bearer <ACCESS_TOKEN_FROM_SESSIONS_CALL>'

{
  "requestId": "<TXN_ID>",
  "patientId": "<PATIENT_ID>",
  "requesterType": "HEALTH_LOCKER",
  "status": "UNSUBSCRIBED",
  "details": {
    "subscriptionRequestId": "<TXN_ID>",
    "purpose": {
      "text": "Self Requested",
      "code": "PATRQT",
      "refUri": "www.abdm.gov.in"
    },
    "patient": {
      "id": "nithishjanithi@sbx"
    },
    "hiu": {
      "id": "Priyanka_Health_Locker",
      "name": "<NAME>",
      "type": "HEALTH LOCKER"
    },
    "hips": [],
    "categories": [
      "DATA",
      "LINK"
    ],
    "period": {
      "from": "2026-05-29T09:19:26.699Z",
      "to": "2126-05-29T09:18:26.699Z"
    }
  },
  "dateCreated": "2026-05-29T09:18:26.944Z",
  "dateModified": "2026-05-29T09:20:41.769Z",
  "healthIdNumber": "<ABHA_NUMBER>"
}

Generated from the schema. The values are placeholders, not a captured response.