consent_management

Get Consent Request List

Lists the consent requests raised against the signed-in ABHA address, with paging.

GET/api/consent-management/consent-requests

Authorizations

Authorizationbearer tokenRequired

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

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 Consent Request List

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

{
  "size": 10,
  "limit": 10,
  "offset": 0,
  "requests": [
    {
      "requestId": "<TXN_ID>",
      "createdAt": "2026-04-28T05:54:26.374Z",
      "lastUpdated": "2026-04-28T05:54:26.449Z",
      "status": "GRANTED",
      "purpose": {
        "text": "Care Management",
        "code": "CAREMGT",
        "refUri": "www.abdm.gov.in"
      },
      "patient": {
        "id": "nithishjanithi@sbx"
      },
      "hip": {
        "id": "DigiLocker_NEGD"
      },
      "hiu": {
        "id": "DigiLocker_NEGD"
      },
      "requester": {
        "name": "<NAME>",
        "identifier": {
          "value": "SELF",
          "type": "SELF",
          "system": "nithishjanithi@sbx"
        }
      },
      "hiTypes": [
        "DiagnosticReport"
      ],
      "careContexts": [
        {
          "patientReference": "nithishjanithi@sbx",
          "careContextReference": "25ac532f-178d-5885-9bcb-b82052f345eb_20260428112424637418"
        }
      ],
      "permission": {
        "accessMode": "VIEW",
        "dateRange": {
          "from": "2026-04-27T09:54:25.533Z",
          "to": "2026-04-28T05:54:25.533Z"
        },
        "dataEraseAt": "2036-04-28T11:24:25.533Z",
        "frequency": {
          "unit": "YEAR",
          "value": 1,
          "repeats": 1
        }
      }
    },
    {
      "requestId": "<TXN_ID>",
      "createdAt": "2026-04-28T05:51:02.270Z",
      "lastUpdated": "2026-04-28T05:51:02.335Z",
      "status": "GRANTED",
      "purpose": {
        "text": "Care Management",
        "code": "CAREMGT",
        "refUri": "www.abdm.gov.in"
      },
      "patient": {
        "id": "nithishjanithi@sbx"
      },
      "hip": {
        "id": "DigiLocker_NEGD"
      },
      "hiu": {
        "id": "DigiLocker_NEGD"
      },
      "requester": {
        "name": "<NAME>",
        "identifier": {
          "value": "SELF",
          "type": "SELF",
          "system": "nithishjanithi@sbx"
        }
      },
      "hiTypes": [
        "DiagnosticReport"
      ],
      "careContexts": [
        {
          "patientReference": "nithishjanithi@sbx",
          "careContextReference": "25ac532f-178d-5885-9bcb-b82052f345eb_20260428112100337536"
        }
      ],
      "permission": {
        "accessMode": "VIEW",
        "dateRange": {
          "from": "2026-04-27T09:51:01.358Z",
          "to": "2026-04-28T05:51:01.358Z"
        },
        "dataEraseAt": "2036-04-28T11:21:01.358Z",
        "frequency": {
          "unit": "YEAR",
          "value": 1,
          "repeats": 1
        }
      }
    },
    {
      "requestId": "<TXN_ID>",
      "createdAt": "2026-04-28T05:51:02.265Z",
      "lastUpdated": "2026-04-28T05:51:02.328Z",
      "status": "GRANTED",
      "purpose": {
        "text": "Care Management",
        "code": "CAREMGT",
        "refUri": "www.abdm.gov.in"
      },
      "patient": {
        "id": "nithishjanithi@sbx"
      },
      "hip": {
        "id": "DigiLocker_NEGD"
      },
      "hiu": {
        "id": "DigiLocker_NEGD"
      },
      "requester": {
        "name": "<NAME>",
        "identifier": {
          "value": "SELF",
          "type": "SELF",
          "system": "nithishjanithi@sbx"
        }
      },
      "hiTypes": [
        "DiagnosticReport"
      ],
      "careContexts": [
        {
          "patientReference": "nithishjanithi@sbx",
          "careContextReference": "25ac532f-178d-5885-9bcb-b82052f345eb_20260428112100337536"
        }
      ],
      "permission": {
        "accessMode": "VIEW",
        "dateRange": {
          "from": "2026-04-27T09:51:01.340Z",
          "to": "2026-04-28T05:51:01.340Z"
        },
        "dataEraseAt": "2036-04-28T11:21:01.340Z",
        "frequency": {
          "unit": "YEAR",
          "value": 1,
          "repeats": 1
        }
      }
    },
    {
      "requestId": "<TXN_ID>",
      "createdAt": "2026-04-28T05:50:25.748Z",
      "lastUpdated": "2026-04-28T05:50:25.811Z",
      "status": "GRANTED",
      "purpose": {
        "text": "Care Management",
        "code": "CAREMGT",
        "refUri": "www.abdm.gov.in"
      },
      "patient": {
        "id": "nithishjanithi@sbx"
      },
      "hip": {
        "id": "DigiLocker_NEGD"
      },
      "hiu": {
        "id": "DigiLocker_NEGD"
      },
      "requester": {
        "name": "<NAME>",
        "identifier": {
          "value": "SELF",
          "type": "SELF",
          "system": "nithishjanithi@sbx"
        }
      },
      "hiTypes": [
        "DiagnosticReport"
      ],
      "careContexts": [
        {
          "patientReference": "nithishjanithi@sbx",
          "careContextReference": "25ac532f-178d-5885-9bcb-b82052f345eb_20260428112024090716"
        }
      ],
      "permission": {
        "accessMode": "VIEW",
        "dateRange": {
          "from": "2026-04-27T09:50:24.837Z",
          "to": "2026-04-28T05:50:24.837Z"
        },
        "dataEraseAt": "2036-04-28T11:20:24.837Z",
        "frequency": {
          "unit": "YEAR",
          "value": 1,
          "repeats": 1
        }
      }
    },
    {
      "requestId": "<TXN_ID>",
      "createdAt": "2026-04-28T05:48:55.599Z",
      "lastUpdated": "2026-04-28T05:48:55.689Z",
      "status": "GRANTED",
      "purpose": {
        "text": "Care Management",
        "code": "CAREMGT",
        "refUri": "www.abdm.gov.in"
      },
      "patient": {
        "id": "nithishjanithi@sbx"
      },
      "hip": {
        "id": "DigiLocker_NEGD"
      },
      "hiu": {
        "id": "DigiLocker_NEGD"
      },
      "requester": {
        "name": "<NAME>",
        "identifier": {
          "value": "SELF",
          "type": "SELF",
          "system": "nithishjanithi@sbx"
        }
      },
      "hiTypes": [
        "OPConsultation"
      ],
      "careContexts": [
        {
          "patientReference": "nithishjanithi@sbx",
          "careContextReference": "25ac532f-178d-5885-9bcb-b82052f345eb_20260428111853846718"
        }
      ],
      "permission": {
        "accessMode": "VIEW",
        "dateRange": {
          "from": "2026-04-27T09:48:54.773Z",
          "to": "2026-04-28T05:48:54.773Z"
        },
        "dataEraseAt": "2036-04-28T11:18:54.773Z",
        "frequency": {
          "unit": "YEAR",
          "value": 1,
          "repeats": 1
        }
      }
    },
    {
      "requestId": "<TXN_ID>",
      "createdAt": "2026-04-28T05:48:55.600Z",
      "lastUpdated": "2026-04-28T05:48:55.670Z",
      "status": "GRANTED",
      "purpose": {
        "text": "Care Management",
        "code": "CAREMGT",
        "refUri": "www.abdm.gov.in"
      },
      "patient": {
        "id": "nithishjanithi@sbx"
      },
      "hip": {
        "id": "DigiLocker_NEGD"
      },
      "hiu": {
        "id": "DigiLocker_NEGD"
      },
      "requester": {
        "name": "<NAME>",
        "identifier": {
          "value": "SELF",
          "type": "SELF",
          "system": "nithishjanithi@sbx"
        }
      },
      "hiTypes": [
        "OPConsultation"
      ],
      "careContexts": [
        {
          "patientReference": "nithishjanithi@sbx",
          "careContextReference": "25ac532f-178d-5885-9bcb-b82052f345eb_20260428111853846718"
        }
      ],
      "permission": {
        "accessMode": "VIEW",
        "dateRange": {
          "from": "2026-04-27T09:48:54.774Z",
          "to": "2026-04-28T05:48:54.774Z"
        },
        "dataEraseAt": "2036-04-28T11:18:54.774Z",
        "frequency": {
          "unit": "YEAR",
          "value": 1,
          "repeats": 1
        }
      }
    },
    {
      "requestId": "<TXN_ID>",
      "createdAt": "2026-04-28T05:46:20.556Z",
      "lastUpdated": "2026-04-28T05:46:20.622Z",
      "status": "GRANTED",
      "purpose": {
        "text": "Care Management",
        "code": "CAREMGT",
        "refUri": "www.abdm.gov.in"
      },
      "patient": {
        "id": "nithishjanithi@sbx"
      },
      "hip": {
        "id": "DigiLocker_NEGD"
      },
      "hiu": {
        "id": "DigiLocker_NEGD"
      },
      "requester": {
        "name": "<NAME>",
        "identifier": {
          "value": "SELF",
          "type": "SELF",
          "system": "nithishjanithi@sbx"
        }
      },
      "hiTypes": [
        "Prescription"
      ],
      "careContexts": [
        {
          "patientReference": "nithishjanithi@sbx",
          "careContextReference": "25ac532f-178d-5885-9bcb-b82052f345eb_20260428111618826852"
        }
      ],
      "permission": {
        "accessMode": "VIEW",
        "dateRange": {
          "from": "2026-04-27T09:46:19.739Z",
          "to": "2026-04-28T05:46:19.739Z"
        },
        "dataEraseAt": "2036-04-28T11:16:19.739Z",
        "frequency": {
          "unit": "YEAR",
          "value": 1,
          "repeats": 1
        }
      }
    },
    {
      "requestId": "<TXN_ID>",
      "createdAt": "2026-04-28T05:46:20.508Z",
      "lastUpdated": "2026-04-28T05:46:20.580Z",
      "status": "GRANTED",
      "purpose": {
        "text": "Care Management",
        "code": "CAREMGT",
        "refUri": "www.abdm.gov.in"
      },
      "patient": {
        "id": "nithishjanithi@sbx"
      },
      "hip": {
        "id": "DigiLocker_NEGD"
      },
      "hiu": {
        "id": "DigiLocker_NEGD"
      },
      "requester": {
        "name": "<NAME>",
        "identifier": {
          "value": "SELF",
          "type": "SELF",
          "system": "nithishjanithi@sbx"
        }
      },
      "hiTypes": [
        "Prescription"
      ],
      "careContexts": [
        {
          "patientReference": "nithishjanithi@sbx",
          "careContextReference": "25ac532f-178d-5885-9bcb-b82052f345eb_20260428111618826852"
        }
      ],
      "permission": {
        "accessMode": "VIEW",
        "dateRange": {
          "from": "2026-04-27T09:46:19.677Z",
          "to": "2026-04-28T05:46:19.677Z"
        },
        "dataEraseAt": "2036-04-28T11:16:19.677Z",
        "frequency": {
          "unit": "YEAR",
          "value": 1,
          "repeats": 1
        }
      }
    },
    {
      "requestId": "<TXN_ID>",
      "createdAt": "2026-04-28T05:46:03.154Z",
      "lastUpdated": "2026-04-28T05:46:03.227Z",
      "status": "GRANTED",
      "purpose": {
        "text": "Care Management",
        "code": "CAREMGT",
        "refUri": "www.abdm.gov.in"
      },
      "patient": {
        "id": "nithishjanithi@sbx"
      },
      "hip": {
        "id": "DigiLocker_NEGD"
      },
      "hiu": {
        "id": "DigiLocker_NEGD"
      },
      "requester": {
        "name": "<NAME>",
        "identifier": {
          "value": "SELF",
          "type": "SELF",
          "system": "nithishjanithi@sbx"
        }
      },
      "hiTypes": [
        "HealthDocumentRecord"
      ],
      "careContexts": [
        {
          "patientReference": "nithishjanithi@sbx",
          "careContextReference": "25ac532f-178d-5885-9bcb-b82052f345eb_20260428111601543423"
        }
      ],
      "permission": {
        "accessMode": "VIEW",
        "dateRange": {
          "from": "2026-04-27T09:46:02.533Z",
          "to": "2026-04-28T05:46:02.533Z"
        },
        "dataEraseAt": "2036-04-28T11:16:02.533Z",
        "frequency": {
          "unit": "YEAR",
          "value": 1,
          "repeats": 1
        }
      }
    },
    {
      "requestId": "<TXN_ID>",
      "createdAt": "2026-04-27T10:59:13.124Z",
      "lastUpdated": "2026-04-27T10:59:13.186Z",
      "status": "GRANTED",
      "purpose": {
        "text": "Care Management",
        "code": "CAREMGT",
        "refUri": "www.abdm.gov.in"
      },
      "patient": {
        "id": "nithishjanithi@sbx"
      },
      "hip": {
        "id": "DigiLocker_NEGD"
      },
      "hiu": {
        "id": "DigiLocker_NEGD"
      },
      "requester": {
        "name": "<NAME>",
        "identifier": {
          "value": "SELF",
          "type": "SELF",
          "system": "nithishjanithi@sbx"
        }
      },
      "hiTypes": [
        "DischargeSummary"
      ],
      "careContexts": [
        {
          "patientReference": "nithishjanithi@sbx",
          "careContextReference": "25ac532f-178d-5885-9bcb-b82052f345eb_20260427162911261772"
        }
      ],
      "permission": {
        "accessMode": "VIEW",
        "dateRange": {
          "from": "2026-04-26T14:59:12.408Z",
          "to": "2026-04-27T10:59:12.408Z"
        },
        "dataEraseAt": "2036-04-27T16:29:12.408Z",
        "frequency": {
          "unit": "YEAR",
          "value": 1,
          "repeats": 1
        }
      }
    }
  ]
}

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