Skip to main content
GET
/
abdm
/
v1
/
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
Example:

"granted"

​
type
enum<string>
required

Specifies the type of request being queried.

Available options:
consent,
subscription,
authorization,
all
Example:

"consent"

​
oid
string

OID is used to Identify the user.

Response

OK

​
authorizations
object[] | null

List of authorizations

​
consents
object[] | null

List of consents

​
subscriptions
object[] | null

List of subscriptions