Skip to main content
GET
/
abdm
/
v1
/
request
cURL
curl --request GET \
  --url https://api.eka.care/abdm/v1/request \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.eka.care/abdm/v1/request"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.eka.care/abdm/v1/request', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.eka.care/abdm/v1/request",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.eka.care/abdm/v1/request"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.eka.care/abdm/v1/request")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.eka.care/abdm/v1/request")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "access_mode": "view",
  "created_at": "2023-11-07T05:31:56Z",
  "duration": {
    "from": "2023-11-07T05:31:56Z",
    "to": "2023-11-07T05:31:56Z"
  },
  "erase_at": "2023-11-07T05:31:56Z",
  "hi_types": [
    {
      "display": "<string>",
      "enabled": true
    }
  ],
  "hiu": {
    "id": "<string>",
    "name": "<string>"
  },
  "id": "<string>",
  "providers": [
    {
      "care_contexts": [
        {
          "display": "<string>",
          "id": "<string>"
        }
      ],
      "consent_artefact_id": "<string>",
      "hip": {
        "id": "<string>",
        "name": "<string>"
      }
    }
  ],
  "purpose": {
    "code": "<string>",
    "text": "<string>"
  },
  "requester": {
    "name": "<string>"
  },
  "updated_at": "2023-11-07T05:31:56Z"
}
{
"code": 123,
"error": "<string>",
"source_error": {
"code": "<string>",
"message": "<string>"
}
}
{
"code": 123,
"error": "<string>",
"source_error": {
"code": "<string>",
"message": "<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

id
string
required

Consent/Subscription ID

type
enum<string>

Request type

Available options:
consent,
subscription
status
enum<string>

Status of the request

Available options:
requested,
granted,
expired,
denied,
revoked
oid
string

OID is used to Identify the user.

Response

OK

access_mode
enum<string>
Available options:
view
created_at
string<date-time>
duration
object
erase_at
string<date-time>
hi_types
object[] | null

List of HI Types

hiu
object

HIU details

id
string
providers
object[] | null

List of Providers/Failities details

purpose
object

Purpose of the request

requester
object

Requester details

status
enum<string>
Available options:
requested,
granted,
expired,
denied,
revoked
updated_at
string<date-time>