consent

Fetch the full consent artefact

Also known as: Consent Fetch. Fetches the full consent artefact for a given consent artefact ID. Should be called after receiving the on-notify callback with status GRANTED.

MandatoryAny one of them is mandatory

Certification cases HIU_FLOW_101, HIU_FLOW_102, HIU_FLOW_103, HIU_FLOW_104, HIU_FLOW_105, HIU_FLOW_106, HIU_FLOW_107, HIU_FLOW_108, HIU_FLOW_109, HIU_FLOW_110, HIU_FLOW_111, HIU_FLOW_112, HIU_FLOW_113

POST/hiecm/consent/v3/fetch

The artefact contains: - Exact care contexts approved - HI types permitted - Date range for data access - Data erase date - Digital signature for validation - HIP and HIU identifiers

Store the artefact securely, it is required for the health information request.

Authorizations

Authorizationbearer tokenRequired

Bearer token obtained from POST /hiecm/gateway/v3/sessions

Headers

REQUEST-IDstringRequired

A fresh UUID that you generate for this request. The callback that answers it carries the same value. In M3 a single consent can produce several callbacks, so keep the mapping from request id to consent request id rather than relying on ordering.

TIMESTAMPstringRequired

The current time in ISO 8601 UTC, with milliseconds and the Z suffix. The gateway rejects a request whose timestamp has drifted too far from its own clock, so take this from a synchronised clock rather than from a local one.

X-CM-IDstringRequired

Which consent manager you are talking to. sbx on the sandbox and abdm in production.

X-HIU-IDstringRequired

Identifier of the health information user the request or callback is intended for. This is per facility, and it is what a callback arriving at your one bridge URL is routed on. The bridge URL and your credentials belong to the integration, not to the facility.

Body

consentIdstringRequired

Consent artefact ID (from consentArtefacts array in on-notify or status)

Responses

200

Consent artefact details.

400

Bad request, invalid parameters or missing fields

Error codes for this module

401

Unauthorized, missing or invalid Bearer token

Everything returns 401

404

Resource not found

Error codes for this module

Fetch the full consent artefact

curl --request POST \
  --url https://dev.abdm.gov.in/api/hiecm/consent/v3/fetch \
  --header 'Authorization: Bearer <ACCESS_TOKEN_FROM_SESSIONS_CALL>' \
  --header 'REQUEST-ID: 5f7a4a1e-59ba-4c0c-9e0c-8e6b3b6e2f11' \
  --header 'TIMESTAMP: 2026-08-25T15:51:15.339Z' \
  --header 'X-CM-ID: <X_CM_ID>' \
  --header 'X-HIU-ID: IN2810014366' \
  --header 'Content-Type: application/json' \
  --data '{
  "consentId": "consent-art-uuid-001"
}'

{
  "consent": {
    "status": "GRANTED",
    "consentDetail": {
      "consentId": "<CONSENT_ID>",
      "createdAt": "2026-08-24T10:15:30.000Z",
      "purpose": {
        "text": "<TEXT>",
        "code": "<CODE>"
      },
      "patient": {
        "id": "<ID>"
      },
      "careContexts": [
        {
          "patientReference": "<PATIENT_REFERENCE>",
          "careContextReference": "<CARE_CONTEXT_REFERENCE>"
        }
      ],
      "hiTypes": [
        "<HI_TYPES>"
      ],
      "permission": "<PERMISSION>",
      "hiu": {
        "id": "<ID>"
      },
      "hip": {
        "id": "<ID>"
      }
    },
    "signature": "<SIGNATURE>"
  }
}

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

Callbacks

After this call, ABDM posts The consent artefact detail, fetched by artefact id to /api/v3/hiu/consent/on-fetch. Open the callback.

Fetch the full consent artefact

Authorizations

Headers

Body

Responses

Callbacks​

Callbacks