Connect
- Webhooks
General Tools
- Self Assessments
- Medical Document Parsing
- Medical Speech Understanding
Doctor Tool
- Actors
- Instructions
- Patient Registration API
- Doctor and clinic API
- Appointment API
- Payments API
- Prescription API
- Notify
- Webhooks
ABDM Connect
- Create and Login
- User Session
- Patient Requests
- Consents
- Care Contexts
- Providers
- Profile
- Scan & Share
- Errors
Medical Records
- Create
- Read
- Update
- Delete
- Webhooks
User App
- Notifications
- Vital
- Webhooks
- Privacy
Release Notes
- ABDM Connect
Patient Requests
List requests
API to list all the Subscriptions / Authorization and Consent requests
GET
/
abdm
/
v1
/
requests
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": "INXXXXX",
"name": "Apollo Hospital"
},
"id": "<string>",
"purpose": {
"code": "<string>",
"text": "<string>"
},
"requester": {
"name": "Dr John"
}
}
],
"consents": [
{
"created_at": "2023-11-07T05:31:56Z",
"duration": {
"from": "2023-11-07T05:31:56Z",
"to": "2023-11-07T05:31:56Z"
},
"hiu": {
"id": "INXXXXX",
"name": "Apollo Hospital"
},
"id": "<string>",
"purpose": {
"code": "<string>",
"text": "<string>"
},
"requester": {
"name": "Dr John"
}
}
],
"subscriptions": [
{
"created_at": "2023-11-07T05:31:56Z",
"duration": {
"from": "2023-11-07T05:31:56Z",
"to": "2023-11-07T05:31:56Z"
},
"hiu": {
"id": "INXXXXX",
"name": "Apollo Hospital"
},
"id": "<string>",
"purpose": {
"code": "<string>",
"text": "<string>"
},
"requester": {
"name": "Dr John"
}
}
]
}
Authorizations
The API requires a Bearer token (JWT) for authentication.
Query Parameters
status of the request
Available options:
requested
, granted
, expired
, denied
, revoked
Specifies the type of request being queried.
Available options:
consent
, subscription
, authorization
, all
Response
200
application/json
OK
List of authorizations
Time when the consent was created
Unique identifier for the consent/authorization/subscription
List of consents
Time when the consent was created
Unique identifier for the consent/authorization/subscription
List of subscriptions
Time when the consent was created
Unique identifier for the consent/authorization/subscription
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": "INXXXXX",
"name": "Apollo Hospital"
},
"id": "<string>",
"purpose": {
"code": "<string>",
"text": "<string>"
},
"requester": {
"name": "Dr John"
}
}
],
"consents": [
{
"created_at": "2023-11-07T05:31:56Z",
"duration": {
"from": "2023-11-07T05:31:56Z",
"to": "2023-11-07T05:31:56Z"
},
"hiu": {
"id": "INXXXXX",
"name": "Apollo Hospital"
},
"id": "<string>",
"purpose": {
"code": "<string>",
"text": "<string>"
},
"requester": {
"name": "Dr John"
}
}
],
"subscriptions": [
{
"created_at": "2023-11-07T05:31:56Z",
"duration": {
"from": "2023-11-07T05:31:56Z",
"to": "2023-11-07T05:31:56Z"
},
"hiu": {
"id": "INXXXXX",
"name": "Apollo Hospital"
},
"id": "<string>",
"purpose": {
"code": "<string>",
"text": "<string>"
},
"requester": {
"name": "Dr John"
}
}
]
}