Contact Us

Eka Developer Platform APIs

User Guides

API Reference

Blog

Dashboard

Support

This endpoint is used to initiate the registration process for a mobile number.

authApiKey

Welcome to the documentation of Eka developer platform APIs

Overview

ABDM Connect

Getting Started

Authorization APIs to get access and refresh token

Get new Authorization token using the refresh token

Refresh Token

Webhook Signature

Registers a new webhook triggered by specific events. Each webhook is linked to a `business_id`, `client_id`, `url`, and a `scope` defining the events that trigger it. The service sends POST requests to the specified URL for these events. The URL must be reachable and preferably secure (HTTPS). Optionally, a signing key can be provided to verify webhook payload authenticity.


Register Webhook

Retrieves all registered webhooks. This endpoint allows clients to fetch a list of all webhooks that have been registered. Each webhook in the list includes details such as the unique identifier, the scope of events that trigger the webhook, the endpoint URL, the signing key (if provided), the client ID, the protocol used, and timestamps for when the webhook was created and last updated. This information helps clients manage and audit their webhook configurations.


Get Webhooks

Updates an existing webhook's signing key or scope based on its ID. This endpoint allows clients to modify the scope of events for whom the webhook sends data or update the signing key used for verifying the authenticity of webhook payloads. The `id` parameter in the path specifies the webhook to be updated. The request body should include the new scope or signing key. This operation helps clients maintain the accuracy and security of their webhook configurations.


Update a Webhook

Deletes an existing webhook based on its ID. This endpoint allows clients to remove a previously registered webhook by specifying its unique identifier in the path parameter. The `id` parameter is required and must match the ID of the webhook to be deleted. Upon successful deletion, the service will no longer send POST requests to the webhook's URL. This operation helps clients manage and clean up their webhook configurations.


Delete a Webhook

Assessment Workflows

❗️Error Codes

This API is used to list all the components and the details about request and response format of each component. It includes the json schema of the request and response format of each component.

List all the components

This functionality enables the addition of new patient records to a business' directory. Users can provide necessary details such as personal information, contact details, and medical history to create a new patient profile.

> _In case the patient is already registered with Eka care, then passing the patient eka id will be enough_

Add Patient to Directory

This API provides functionality to get all profiles of patient by their mobile number in business' directory. 

<Note> This API only works on 10 digit mobile number and cannot be used for searching partial phone numbers. The patient with given mobile number should already be registered with business account for results to show up. </Note>


### Request Parameter

| Parameter | Type | Expected Values | Description | Required/Optional/Not Required |
| --- | --- | --- | --- | --- |
| mobile | string | 10 digit phone number | Patient's mobile number | Required |

### **Response parameter**

| Parameter                           | Type      | Expected Values                           | Description                                               |
| ----------------------------------- | --------- | ----------------------------------------- | --------------------------------------------------------- |
| data                                | object    |                                           | Response data object                                      |
| data.profiles                       | array     |                                           | List of patient profiles                                  |
| data.profiles[].name                | string    | "Amit Kumar"                              | Patient's full name                                       |
| data.profiles[].patient_id          | string  | "123456789012345"                        | Unique identifier for the patient (can be null)           |
| data.profiles[].patient_profile     | object    |                                           | Detailed patient profile information                      |
| data.profiles[].patient_profile.created_at | string    | "2024-08-13T07:31:53.750Z"               | Timestamp of profile creation                             |
| data.profiles[].patient_profile.dob | string    | "1990-05-15"                              | Patient's date of birth                                   |
| data.profiles[].patient_profile.first_name | string    | "Amit"                                  | Patient's first name                                      |
| data.profiles[].patient_profile.middle_name | string    | ""                                       | Patient's middle name (can be empty)                      |
| data.profiles[].patient_profile.last_name | string    | "Kumar"                                 | Patient's last name                                       |
| data.profiles[].patient_profile.gender | string    | "M" / "F" / "O"                                  | Patient's gender                                          |
| data.profiles[].patient_profile.mobile | string    | "+919876543210"                           | Patient's mobile number                                   |
| data.profiles[].patient_profile.patient_id | string \| null | "123456789012345"                     | Unique identifier for the patient (can be null)           |
| status_code                         | integer   | 200                                       | HTTP status code of the response                          |
| success                             | boolean   | true                                      | Indicates if the request was successful                   |

**Status Codes**

• 200: Success

• 403: Patient/Business data missing

• 500: Wrong API URL/Wrong JSON request/ Something went wrong

Search Patient profiles by mobile number

This API provides functionality to get details of a patient by their Eka profile id, from a business' directory. 
The patient should have been previously added to the business directory for this API to return the patient's details.

### Request Parameter

| Parameter | Type | Expected Values | Description | Required/Optional/Not Required |
| --- | --- | --- | --- | --- |
| patient_id | string | Patient's Eka profile id | Patient's eka profile id | Required |

### **Response parameter**

| Parameter | Type | Expected Values | Description |
| --- |  --- |  --- |  --- |
| data                                | object    |                                           | Response data object                                      |
| data.name                           | string    | "Amit Kumar"                                | Patient's full name                                       |
| data.patient_id                     | string    | "987654321012345"                         | Unique identifier for the patient                         |
| data.patient_profile                | object    |                                           | Detailed patient profile information                      |
| data.patient_profile.address        | object    |                                           | Patient's address information                             |
| data.patient_profile.address.city   | string    | "Bengaluru"                               | City of residence                                         |
| data.patient_profile.address.line1  | string    | "ABC, B Grade Metropolis"              | Address line 1                                            |
| data.patient_profile.address.pincode| string    | "560048"                                  | Pincode                                                   |
| data.patient_profile.created_at     | datetime  | "2024-06-20T10:17:33.242Z"                | Timestamp of profile creation                             |
| data.patient_profile.dob            | date      | "1990-05-17"                              | Patient's date of birth                                   |
| data.patient_profile.email          | string    | "amit.kumar@example.com"                    | Patient's email address                                   |
| data.patient_profile.first_name     | string    | "Amit"                                    | Patient's first name                                      |
| data.patient_profile.middle_name    | string    | ""                                        | Patient's middle name (can be empty)                      |
| data.patient_profile.last_name      | string    | "Kumar"                                     | Patient's last name                                       |
| data.patient_profile.gender         | string    | "M"/"F"/"O"                                    | Patient's gender                                          |
| data.patient_profile.metadata       | object    |                                           | Metadata related to the patient                           |
| data.patient_profile.metadata.blood_group | string | "AB+"                                    | Patient's blood group                                     |
| data.patient_profile.metadata.uhid  | string    | "DESK-177"                                | Unique Health Identifier (UHID)                           |
| data.patient_profile.mobile         | string    | "+919876543210"                           | Patient's mobile number                                   |
| data.patient_profile.patient_id     | string | "987654321012345"                               | Unique identifier for the patient        |
| status_code                         | integer   | 200                                       | HTTP status code of the response                          |
| success                             | boolean   | true                                      | Indicates if the request was successful                   |


**Status Codes**

• 200: Success

• 403: Patient/Business data missing

• 500: Wrong API URL/Wrong JSON request/ Something went wrong

Get patient details by profile id

Thi API provides functionality to update patient details for the registered patients.

WIP: This API is currently under development and will be available soon.

Update Patient Details  [WIP]


### Overview
The Get Clinic and Doctor Details API provides a comprehensive list of clinics and doctors associated with those clinics for a business. This API is designed to retrieve detailed information about clinics, the doctors working at each clinic, and the overarching business entity.
### Endpoint
**URL:** `{{HOST}}/dr/v1/business/entities`

**Method:** GET
### Request Parameters
This endpoint does not require any parameters. The auth header contains business-id information which will be used to fetch the details.
### Response Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| status | integer | HTTP status code of the response |
| data | object | Response data object |
| data.clinics | array | List of clinic objects |
| data.clinics[].clinic_id | string | Unique identifier of the clinic |
| data.clinics[].name | string | Name of the clinic |
| data.clinics[].doctors | array | List of doctor IDs associated with the clinic |
| data.doctors | array | List of doctor objects |
| data.doctors[].name | string | Name of the doctor |
| data.doctors[].doctor_id | string | Unique identifier of the doctor |
| data.business | object | Details of the business entity |
| data.business.business_id | string | Unique identifier of the business |
| data.business.name | string | Name of the business |

Get Clinic and Doctor details


### Overview
This API endpoint is used to retrieve detailed information about a specific doctor using their unique identifier. The response includes comprehensive information about the doctor, such as personal details, specializations, and associated clinics.
### Endpoint
**URL:** `{{HOST}}/dr/v1/business/doctor/{{doctor_id}}`

**Method:** GET
### Request Parameters

| Parameter | Type | Description | Required |
| --- | --- | --- | --- |
| doctor_id | string | Unique identifier for the doctor | Yes |

### Response Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| id | string | Unique identifier for the doctor in Eka |
| created_at | datetime | Timestamp when the doctor profile was created |
| profile | object | Doctor's profile details |
| profile.personal | object | Personal details of the doctor |
| profile.personal.designation | string | Designation (e.g., Dr.) |
| profile.personal.first_name | string | First name of the doctor |
| profile.personal.middle_name | string | Middle name of the doctor |
| profile.personal.last_name | string | Last name of the doctor |
| profile.personal.email | string | Email address of the doctor |
| profile.personal.gender | string | Gender of the doctor |
| profile.personal.dob | date | Date of birth of the doctor |
| profile.professional | object | Professional details of the doctor |
| profile.professional.active | boolean | Flag indicating if the profile is active |
| profile.professional.about | string | About section describing the doctor |
| profile.professional.language | array | Languages spoken by the doctor |
| profile.professional.language\[\].language | string | Language name (e.g., English) |
| profile.professional.clinics | array | Clinics associated with the doctor |
| profile.professional.clinics\[\] | object | Clinic details |
| profile.professional.clinics\[\]..id | string | Unique identifier for the clinic |
| profile.professional.clinics\[\].city_name | string | City name where the clinic is located |
| profile.professional.clinics\[\].name | string | Name of the clinic |
| profile.professional.clinics\[\].email | string | Email address of the clinic |
| profile.professional.clinics\[\].about | string | About section of the clinic |
| profile.professional.clinics\[\].speciality | array | Specialities offered at the clinic |
| profile.professional.clinics\[\].number | array | Contact numbers for the clinic |
| profile.professional.clinics\[\].number\[\].name | string | Type of contact number (e.g., Phone, Mobile) |
| profile.professional.clinics\[\].number\[\].n | string | Contact number |
| profile.professional.clinics\[\].address | object | Address details of the clinic |
| profile.professional.clinics\[\].address.line1 | string | Address line 1 |
| profile.professional.clinics\[\].address.line2 | string | Address line 2 |
| profile.professional.clinics\[\].address.city | string | City of the clinic |
| profile.professional.clinics\[\].address.state | string | State of the clinic |
| profile.professional.clinics\[\].address.country | string | Country of the clinic |
| profile.professional.clinics\[\].address.pincode | string | Pincode of the clinic |
| profile.professional.clinics\[\].location | array | Location coordinates of the clinic |
| profile.professional.default_clinic | string | Default clinic ID |
| profile.professional.all_registrations | array | Registrations of the doctor |
| profile.professional.all_registrations\[\].id | number | Registration ID |
| profile.professional.all_registrations\[\].council | string | Medical council name |
| profile.professional.all_registrations\[\].medical_id | string | Medical ID number |
| profile.professional.all_registrations\[\].year | string | Year of registration |
| profile.professional.all_registrations\[\].default | boolean | Flag indicating if it is the default registration |
| profile.professional.degree | array | Degrees earned by the doctor |
| profile.professional.degree\[\].id | number | Degree ID |
| profile.professional.degree\[\].name | string | Name of the degree |
| profile.professional.degree\[\].branch_name | string | Branch name |
| profile.professional.degree\[\].college_name | string | College name |
| profile.professional.degree\[\].display_status | string | Display status of the degree |
| profile.professional.degree\[\].start_year | string | Start year of the degree |
| profile.professional.degree\[\].end_year | string | End year of the degree |
| profile.professional.major_speciality | object | Major speciality of the doctor |
| profile.professional.major_speciality.name | string | Name of the major speciality |
| profile.professional.speciality | array | Specialities of the doctor |
| profile.professional.speciality\[\].name | string | Name of the speciality |
| **Status Codes** |  |  |

• 200: Success

• 403: Doctor data missing

• 500: Wrong API URL/Token mismatched/Wrong JSON request.

Get Doctor profile

This API provides functionality to search a patient by their mobile number in doctor's directory

### Request Parameter

| Parameter | Type | Expected Values | Description | Required/Optional/Not Required |
| --- | --- | --- | --- | --- |
| doctor_id | string |  | Unique identifier for the doctor | Required |

### **Response parameter**

**Status Codes**

• 200: Success

• 403: Patient/Organization data missing

• 500: Wrong API URL/Token mismatched/Wrong JSON request.

Get Clinics for doctor [WIP]

### Overview
This API endpoint retrieves detailed information about a specific clinic using its unique identifier.
### Endpoint
**URL:** `{{HOST}}/dr/v1/business/clinic/{{clinic_id}}`
**Method:** GET
### Request Parameters
| Parameter | Type | Description | Required |
| --- | --- | --- | --- |
| clinic_id | string | Unique identifier for the clinic | Yes |
### Response Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| success | boolean | Indicates if the request was successful |
| data | object | Response data object |
| data.clinic | object | Clinic details |
| data.clinic.clinic_id | string | Unique identifier of the clinic |
| data.clinic.name | string | Name of the clinic |
| data.clinic.address | object | Address details of the clinic |
| data.clinic.address.city | string | City of the clinic |
| data.clinic.address.country | string | Country of the clinic |
| data.clinic.address.lat | string | Latitude of the clinic |
| data.clinic.address.line1 | string | Address line 1 |
| data.clinic.address.lon | string | Longitude of the clinic |
| data.clinic.address.pincode | string | Pincode of the clinic |
| data.clinic.address.state | string | State of the clinic |

Get Clinic details

This API is the first step in booking appointment slot for a patient at a doctor's clinic

Get Appointment Slots

This API is used to book an appointment slot for a patient based on the available slots retrieved from the `get appointment slots` API.

Book Appointment Slot



### Overview
This API endpoint is used to retrieve the details of an appointment using its unique identifier. The response includes comprehensive information about the appointment, including patient and doctor details, appointment status, and related services.

Appointment_statuses:
  - BK    : Booked
  - OG    : Ongoing
  - CM	  : Completed with Prescription
  - CMNP  : Completed without a Prescription
  - CN    : Cancelled

Get Appointment Details


### Overview

This API endpoint is used to update an existing appointment.

Update Appointment


### Overview

This API endpoint is used to complete an existing appointment.

Complete Appointment


### Overview

This API endpoint is used to cancel an existing appointment.

Cancel Appointment

Get Transaction Status

This API retrieves comprehensive details of a prescription created by a doctor. It provides a rich set of data encompassing patient history, diagnosis, medications, lab tests, and various other clinical elements. The response includes:

Get Prescription details

Generate mobile OTP for user session token

Verify mobile OTP and get user session token

API to list all the Subscriptions / Authorization and Consent requests

Get Provider Details

Search Providers

Fetch the data for ABHA qr code display. <Note>Please cache these results locally. We do not recommend calling this API on every page load. Evict the cache when there is profile update.</Note><Warning>There is no fixed structure for this JSON; it can vary depending on the creation of ABHA. Generate the QR code based on the content of the response body.</Warning>

ABHA QR Code

Fetch the ABHA card.<Note>Please cache these results locally. We do not recommend calling this API on every page load. Evict the cache when there is profile update.</Note>

ABHA card

Fetches the ABHA profile of the User. <Note>Please cache these results locally. We do not recommend calling this API on every page load. Evict the cache when there is profile update.</Note>

Profile Details

<Warning>Name, gender and date of birth cannot be edited for a KYC verified ABHA</Warning>

Update Profile

This endpoint removes the specified ABHA profile along with all associated documents, vital records, and any other related data from the system.<Warning>Please note that the ABHA metadata will remain in the ABDM system, as ABDM does not provide a delete option</Warning>

Delete Profile

Fetch the token from a hospital. <Note> Get the hip_id and counter_id by reading the QR code of the Hospital/Clinic.</Note> <Note>Use the device location for the location data</Note>

Get Scan & Share Token

Error Code Mapping

Generate a presigned URL that allows you to securely upload a document to the server. This URL can be used to upload the document directly without needing additional authentication or authorization steps.

Step 1: Upload Record

Step 2: Upload Record

Once you get the list of all the documents with coresponding id's, you can this to know more details about the document.

Describes a document

To get the list of all the records for a given authenticated user.

List Documents

Retrieve a health record based on the given identifier, hip_id, and health_id in nrces FHIR json format.

Retrieve health records

Update Document

This API is used to delete a document using a document ID.

Delete a document

When the records get uploaded, a webhook event is sent to register to get the smart report of the record upload. If there are multiple records upload in upload docs API we need to register web hook for all the document id recevied in the reponse. Use the below request payload to register to webhook. You can find [here](https://ekacare.notion.site/726b13df13ea4409b0cd30c6f3a80315?v=dcd10c722d3149d880ae889b06f4820a) list of parsing capablities we have as of now.

Smart Report

Call to add or register a device for notifications. This endpoint allows clients to register a device by providing its details such as device ID, FCM ID, app version, and other relevant information. The registered device will be used to send notifications. The request body must contain the device payload information.


Add Device

To be called when the device is logged out or uninstalled. This endpoint allows clients to remove a registered device by specifying its device ID in the header. Upon successful deletion, the device will no longer receive notifications. The `device-id` parameter in the header is required.


Delete Device

Store FCM credentials. This endpoint allows clients to store Firebase Cloud Messaging (FCM) credentials by providing the service account key details. The stored credentials will be used for sending notifications to the registered devices. The request body must contain the FCM payload information.


Add FCM Credentials

Update the vitals data for a specific patient using the transaction ID.

Authorization

Connect

General Tools

Doctor Tool

ABDM Connect

Medical Records

User App

Release Notes

Init

Authorizations

Body

Response