List requests

cURL

curl --request GET \
  --url https://api.eka.care/abdm/v1/requests \
  --header 'Authorization: Bearer <token>'

{
  "authorizations": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "duration": {
        "from": "2023-11-07T05:31:56Z",
        "to": "2023-11-07T05:31:56Z"
      },
      "hiu": {
        "id": "<string>",
        "name": "<string>"
      },
      "id": "<string>",
      "purpose": {
        "code": "<string>",
        "text": "<string>"
      },
      "requester": {
        "name": "<string>"
      }
    }
  ],
  "consents": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "duration": {
        "from": "2023-11-07T05:31:56Z",
        "to": "2023-11-07T05:31:56Z"
      },
      "hiu": {
        "id": "<string>",
        "name": "<string>"
      },
      "id": "<string>",
      "purpose": {
        "code": "<string>",
        "text": "<string>"
      },
      "requester": {
        "name": "<string>"
      }
    }
  ],
  "subscriptions": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "duration": {
        "from": "2023-11-07T05:31:56Z",
        "to": "2023-11-07T05:31:56Z"
      },
      "hiu": {
        "id": "<string>",
        "name": "<string>"
      },
      "id": "<string>",
      "purpose": {
        "code": "<string>",
        "text": "<string>"
      },
      "requester": {
        "name": "<string>"
      }
    }
  ]
}

GET

abdm

requests

cURL

curl --request GET \
  --url https://api.eka.care/abdm/v1/requests \
  --header 'Authorization: Bearer <token>'

{
  "authorizations": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "duration": {
        "from": "2023-11-07T05:31:56Z",
        "to": "2023-11-07T05:31:56Z"
      },
      "hiu": {
        "id": "<string>",
        "name": "<string>"
      },
      "id": "<string>",
      "purpose": {
        "code": "<string>",
        "text": "<string>"
      },
      "requester": {
        "name": "<string>"
      }
    }
  ],
  "consents": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "duration": {
        "from": "2023-11-07T05:31:56Z",
        "to": "2023-11-07T05:31:56Z"
      },
      "hiu": {
        "id": "<string>",
        "name": "<string>"
      },
      "id": "<string>",
      "purpose": {
        "code": "<string>",
        "text": "<string>"
      },
      "requester": {
        "name": "<string>"
      }
    }
  ],
  "subscriptions": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "duration": {
        "from": "2023-11-07T05:31:56Z",
        "to": "2023-11-07T05:31:56Z"
      },
      "hiu": {
        "id": "<string>",
        "name": "<string>"
      },
      "id": "<string>",
      "purpose": {
        "code": "<string>",
        "text": "<string>"
      },
      "requester": {
        "name": "<string>"
      }
    }
  ]
}

Authorizations

Authorization

string

header

required

The API requires a Bearer token (JWT) for authentication.

Headers

X-Pt-Id

string

Eka User ID (OID)

X-Partner-Pt-Id

string

Partner User ID

X-Hip-Id

string

Partner HIP ID

Query Parameters

status

enum<string>

required

status of the request

Available options:

requested,

granted,

expired,

denied,

revoked

type

enum<string>

required

Specifies the type of request being queried.

Available options:

consent,

subscription,

authorization,

all

oid

string

OID is used to Identify the user.

Response

authorizations

object[] | null

List of authorizations

Show child attributes

authorizations.created_at

string<date-time>

Time when the consent was created

authorizations.duration

object

Show child attributes

authorizations.duration.from

string<date-time>

Start time of the consent

authorizations.duration.to

string<date-time>

End time of the consent

authorizations.hiu

object

Health Information User,the requesting entity Clinic hospital

Show child attributes

authorizations.hiu.id

string

Health Information User ID

authorizations.hiu.name

string

Name of the Health Information User

authorizations.id

string

Unique identifier for the consent/authorization/subscription

authorizations.purpose

object

Show child attributes

authorizations.purpose.code

string

authorizations.purpose.text

string

authorizations.requester

object

Show child attributes

authorizations.requester.name

string

Name of the requester.

consents

object[] | null

List of consents

Show child attributes

consents.created_at

string<date-time>

Time when the consent was created

consents.duration

object

Show child attributes

consents.duration.from

string<date-time>

Start time of the consent

consents.duration.to

string<date-time>

End time of the consent

consents.hiu

object

Health Information User,the requesting entity Clinic hospital

Show child attributes

consents.hiu.id

string

Health Information User ID

consents.hiu.name

string

Name of the Health Information User

consents.id

string

Unique identifier for the consent/authorization/subscription

consents.purpose

object

Show child attributes

consents.purpose.code

string

consents.purpose.text

string

consents.requester

object

Show child attributes

consents.requester.name

string

Name of the requester.

subscriptions

object[] | null

List of subscriptions

Show child attributes

subscriptions.created_at

string<date-time>

Time when the consent was created

subscriptions.duration

object

Show child attributes

subscriptions.duration.from

string<date-time>

Start time of the consent

subscriptions.duration.to

string<date-time>

End time of the consent

subscriptions.hiu

object

Health Information User,the requesting entity Clinic hospital

Show child attributes

subscriptions.hiu.id

string

Health Information User ID

subscriptions.hiu.name

string

Name of the Health Information User

subscriptions.id

string

Unique identifier for the consent/authorization/subscription

subscriptions.purpose

object

Show child attributes

subscriptions.purpose.code

string

subscriptions.purpose.text

string

subscriptions.requester

object

Show child attributes

subscriptions.requester.name

string

Name of the requester.

Overview Requests get details

⌘I

Authorization

End-to-End Encryption

Connect

HealthAI

Medical Database

General Tools

Doctor Tool

ABDM Connect

Medical Knowledge-bases

Medical Records

User App

Authorizations

Headers

Query Parameters

Response