consent_management

Get All Consent Artefacts by ABHA Address

Lists the consent artefacts granted by the signed-in ABHA address, with paging.

GET/api/consent-management/consent-artefacts

Authorizations

Authorizationbearer tokenRequired

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

Responses

200

Example values, scrubbed.

401

Example values, scrubbed.

Everything returns 401

500

Example values, scrubbed.

Error codes for this module

Get All Consent Artefacts by ABHA Address

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

{
  "size": 10,
  "limit": 10,
  "offset": 0,
  "consentArtefacts": [
    {
      "status": "REVOKED",
      "consentDetail": {
        "schemaVersion": "v3",
        "consentId": "<TXN_ID>",
        "createdAt": "2026-06-05T05:49:30.893Z",
        "lastUpdated": "2026-06-05T05:59:33.037Z",
        "patient": {
          "id": "nithishjanithi@sbx"
        },
        "careContexts": [
          {
            "patientReference": "nithishjanithi@sbx",
            "careContextReference": "25ac532f-178d-5885-9bcb-b82052f345eb_20260428112424637418"
          }
        ],
        "purpose": {
          "text": "Care management",
          "code": "CAREMGT",
          "refUri": "www.abdm.gov.in"
        },
        "hip": {
          "id": "wdwsd"
        },
        "hiu": {
          "id": "IN0002222"
        },
        "consentManager": {
          "id": "sbx"
        },
        "requester": {
          "name": "<NAME>",
          "identifier": {
            "value": "MH1001",
            "type": "REGNO1",
            "system": "https://www.mciindia.9985"
          }
        },
        "hiTypes": [
          "OPConsultation"
        ],
        "permission": {
          "accessMode": "VIEW",
          "dateRange": {
            "from": "2023-05-09T08:58:09.738Z",
            "to": "2025-04-12T09:00:00.738Z"
          },
          "dataEraseAt": "2026-09-12T13:26:00.738Z",
          "frequency": {
            "unit": "HOUR",
            "value": 0,
            "repeats": 0
          }
        }
      },
      "signature": "tY9rOuZomDEo3ihjgjiOl92dgQ1wjzBQa4ogJYlLl7BZFAO3IiR6k8p9qcd30eYgBc1xyPEPied6nDrdPwT6oD2mAso/ny6Ykcto3uU/1nViYH7K/H9/XVEoo4hyOPKb62aGUqMn69QpWNhPM9HTnhtj3CXOjB6TA2eFkHYYbaniX02W/6ALtuPb0OsUchlImVbjj1EBlCK4Xs8GrtAnneU2esnMWR7N0ra9bnyR6zF5Bi2ng/pDLTIeKC3wfVKg4AGUC6obC7FCRrykAUlpgWMM4wBbiV7Y1oLPcJ4VFL7DSUdtilGbW53ez0Av4cKlVizRxZ9gWvw2kWQBa2iL/w=="
    },
    {
      "status": "GRANTED",
      "consentDetail": {
        "schemaVersion": "v3",
        "consentId": "<TXN_ID>",
        "createdAt": "2026-06-05T05:39:45.177Z",
        "lastUpdated": "2026-06-05T05:39:45.177Z",
        "patient": {
          "id": "nithishjanithi@sbx"
        },
        "careContexts": [
          {
            "patientReference": "nithishjanithi@sbx",
            "careContextReference": "25ac532f-178d-5885-9bcb-b82052f345eb_20260428112424637418"
          }
        ],
        "purpose": {
          "text": "Care management",
          "code": "CAREMGT",
          "refUri": "www.abdm.gov.in"
        },
        "hip": {
          "id": "wdwsd"
        },
        "hiu": {
          "id": "IN0002222"
        },
        "consentManager": {
          "id": "sbx"
        },
        "requester": {
          "name": "<NAME>",
          "identifier": {
            "value": "MH1001",
            "type": "REGNO1",
            "system": "https://www.mciindia.9985"
          }
        },
        "hiTypes": [
          "OPConsultation"
        ],
        "permission": {
          "accessMode": "VIEW",
          "dateRange": {
            "from": "2023-05-09T08:58:09.738Z",
            "to": "2025-04-12T09:00:00.738Z"
          },
          "dataEraseAt": "2026-09-10T13:26:00.738Z",
          "frequency": {
            "unit": "HOUR",
            "value": 0,
            "repeats": 0
          }
        }
      },
      "signature": "Rk4JZGhdRdrmNldhcM7tmsZOhKwNyN4FEER8O8WAl2GkqRqNQz79pOeBmBZAFi61HY3X3scKoBEC+o2fl4/F33n3QHoXKuP/5cDhamUMPq0FO8YrbUwzwoeMn46trIB8qEHE+aTdtH/09T8fIY+I1bMTlRaOeebAbhff8JC1v+w51l5Mw+MFnchxY8ulO1U/gGKsYUl+JCC/2+nVpw2OS/7nEv8Dv7Xl4Ttgdcel7cbVkAoy2h+eYNeOLLrCC7UbMvXds2e0Ng64mgNO6Iw8UJ/0FG4W+a9bk2TfOhvYIbJ6XOG+qiIeZDhqT3IddSntjMRsNeGubdsQZmHqKsh0ww=="
    },
    {
      "status": "GRANTED",
      "consentDetail": {
        "schemaVersion": "v3",
        "consentId": "<TXN_ID>",
        "createdAt": "2026-06-04T14:55:00.459Z",
        "lastUpdated": "2026-06-04T14:55:00.459Z",
        "patient": {
          "id": "nithishjanithi@sbx"
        },
        "careContexts": [
          {
            "patientReference": "nithishjanithi@sbx",
            "careContextReference": "25ac532f-178d-5885-9bcb-b82052f345eb_20260604184449081782"
          }
        ],
        "purpose": {
          "text": "Care Management",
          "code": "CAREMGT",
          "refUri": "www.abdm.gov.in"
        },
        "hip": {
          "id": "DigiLocker_NEGD"
        },
        "hiu": {
          "id": "DigiLocker_NEGD"
        },
        "consentManager": {
          "id": "sbx"
        },
        "requester": {
          "name": "<NAME>",
          "identifier": {
            "value": "SELF",
            "type": "SELF",
            "system": "nithishjanithi@sbx"
          }
        },
        "hiTypes": [
          "OPConsultation"
        ],
        "permission": {
          "accessMode": "VIEW",
          "dateRange": {
            "from": "2026-06-03T18:54:59.605Z",
            "to": "2026-06-04T14:54:59.605Z"
          },
          "dataEraseAt": "2036-06-04T20:24:59.605Z",
          "frequency": {
            "unit": "YEAR",
            "value": 1,
            "repeats": 1
          }
        }
      },
      "signature": "iVgPM1kwOd7QeR1NWDKYvuWwfmq/2cGxO746Q6eiC9Cc+FZmRPP6ADUCOM/efJF3TpU916qRDmtCdNJINjip83FyrACZbQoULTwRLLKacxh9cM05G65gn7vBZciHhEAX8CWl/mIHZ4r/cbOvtDOBslH0o2xf6kA2vQjT7y+I8V66iQ7N86nrmXpIz+bemJpi8PbF1H5LPtBR5ZULPrgavmbDvdjo9937U963CPvRU+m4HfUuLw9VtpBMakrDEhM/IJ8ASbEpibXEpWewA7s3/SrcQ+Avnmnw8rpCZI3/K/sFvIMJB23hI3WzC9P8VkaGnt9MZ74w8UbkK1Y59/DzkA=="
    },
    {
      "status": "GRANTED",
      "consentDetail": {
        "schemaVersion": "v3",
        "consentId": "<TXN_ID>",
        "createdAt": "2026-06-04T14:50:00.511Z",
        "lastUpdated": "2026-06-04T14:50:00.511Z",
        "patient": {
          "id": "nithishjanithi@sbx"
        },
        "careContexts": [
          {
            "patientReference": "nithishjanithi@sbx",
            "careContextReference": "25ac532f-178d-5885-9bcb-b82052f345eb_20260604184449081782"
          }
        ],
        "purpose": {
          "text": "Care Management",
          "code": "CAREMGT",
          "refUri": "www.abdm.gov.in"
        },
        "hip": {
          "id": "DigiLocker_NEGD"
        },
        "hiu": {
          "id": "DigiLocker_NEGD"
        },
        "consentManager": {
          "id": "sbx"
        },
        "requester": {
          "name": "<NAME>",
          "identifier": {
            "value": "SELF",
            "type": "SELF",
            "system": "nithishjanithi@sbx"
          }
        },
        "hiTypes": [
          "OPConsultation"
        ],
        "permission": {
          "accessMode": "VIEW",
          "dateRange": {
            "from": "2026-06-03T18:49:59.655Z",
            "to": "2026-06-04T14:49:59.655Z"
          },
          "dataEraseAt": "2036-06-04T20:19:59.655Z",
          "frequency": {
            "unit": "YEAR",
            "value": 1,
            "repeats": 1
          }
        }
      },
      "signature": "O+qjztRyZPvrBdEmK2FssBTtsSsDQKmNiKo2x2r7/443qDQPLqa/espMGGLHJ4XsnQVOP2ucWv9qWcASRIvFQjcmaED9r8ewL+yh00ofPBP6HDjaRYL1UA5AQLCVlRA8PWZha9LavYFa/kAairDIr4xZ7S3Gx9Fs+zXFOyrApvOqgT4F+FkekSTgtRMhQ8FjAf5wmQ2UC3X0slV/DoZ0Zf9qf82dESyEcE5W2LUXZbfflDXjiC1y34NK7pG/huL84rGhs+a5+JvMGzFweFDkzTI3fqkYAVNi7/KeNgJPXpak6dNrMMtT7Q2ppZHKGySIQjuckhbDS9FRaKyne7DgAA=="
    }
  ]
}

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