consent_management

Approve Subscription Request

Approves a subscription request for the sources included and not the ones excluded, or for every HIP.

POST/api/consent-management/subscription-requests/{subscriptionRequestId}/approve

Authorizations

Authorizationbearer tokenRequired

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

Path parameters

subscriptionRequestIdstringRequired

Passed as a path segment.

Body

isApplicableForAllHIPsbooleanRequired

includedSourcesobject[]Required

includedSources.hiTypesstring[]Required

includedSources.purposeobjectRequired

includedSources.purpose.textstringRequired

includedSources.purpose.codestringRequired

includedSources.purpose.refUristringRequired

includedSources.categoriesstring[]Required

includedSources.periodobjectRequired

includedSources.period.fromstringRequired

includedSources.period.tostringRequired

excludedSourcesobject[]Required

Responses

400

Example values, scrubbed.

Error codes for this module

Approve Subscription Request

curl --request POST \
  --url https://phrsbx.abdm.gov.in/api/consent-management/subscription-requests/{subscriptionRequestId}/approve \
  --header 'Authorization: Bearer <ACCESS_TOKEN_FROM_SESSIONS_CALL>' \
  --header 'Content-Type: application/json' \
  --data '{
  "isApplicableForAllHIPs": true,
  "includedSources": [
    {
      "hiTypes": [
        "Invoice",
        "HealthDocumentRecord"
      ],
      "purpose": {
        "text": "Care Management",
        "code": "CAREMGT",
        "refUri": "www.abdm.gov.in"
      },
      "categories": [
        "LINK",
        "DATA"
      ],
      "period": {
        "from": "2025-05-22T13:12:55.297Z",
        "to": "2125-05-22T13:11:55.300Z"
      }
    }
  ],
  "excludedSources": []
}'

{
  "code": "<CODE>",
  "message": "<MESSAGE>"
}

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