Create Doctor Profile

curl --request POST \
  --url https://api.eka.care/cdr/v1/doctor/ \
  --header 'Content-Type: application/json' \
  --header 'auth: <auth>' \
  --data '
{
  "firstname": "Rajesh",
  "lastname": "Sharma",
  "mobile": "0000011111",
  "dob": "1999-01-01",
  "email": "dr.rajesh@example.com",
  "gender": "M",
  "specialisations": [
    "Cardiology",
    "Internal Medicine"
  ],
  "qualifications": [
    "MBBS",
    "MD",
    "DM"
  ],
  "about": "Dr. Rajesh Sharma is a renowned cardiologist with over 15 years of experience in interventional cardiology.",
  "profile_image_url": "https://example.com/images/dr-rajesh.jpg",
  "clinic_ids": [
    "c-ab2c-34f2d-2gwd-2g2g"
  ],
  "partner_clinic_ids": [
    "Part_clinic_1"
  ],
  "partner_id": "Part_doc"
}
'

import requests

url = "https://api.eka.care/cdr/v1/doctor/"

payload = {
    "firstname": "Rajesh",
    "lastname": "Sharma",
    "mobile": "0000011111",
    "dob": "1999-01-01",
    "email": "dr.rajesh@example.com",
    "gender": "M",
    "specialisations": ["Cardiology", "Internal Medicine"],
    "qualifications": ["MBBS", "MD", "DM"],
    "about": "Dr. Rajesh Sharma is a renowned cardiologist with over 15 years of experience in interventional cardiology.",
    "profile_image_url": "https://example.com/images/dr-rajesh.jpg",
    "clinic_ids": ["c-ab2c-34f2d-2gwd-2g2g"],
    "partner_clinic_ids": ["Part_clinic_1"],
    "partner_id": "Part_doc"
}
headers = {
    "auth": "<auth>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {auth: '<auth>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    firstname: 'Rajesh',
    lastname: 'Sharma',
    mobile: '0000011111',
    dob: '1999-01-01',
    email: 'dr.rajesh@example.com',
    gender: 'M',
    specialisations: ['Cardiology', 'Internal Medicine'],
    qualifications: ['MBBS', 'MD', 'DM'],
    about: 'Dr. Rajesh Sharma is a renowned cardiologist with over 15 years of experience in interventional cardiology.',
    profile_image_url: 'https://example.com/images/dr-rajesh.jpg',
    clinic_ids: ['c-ab2c-34f2d-2gwd-2g2g'],
    partner_clinic_ids: ['Part_clinic_1'],
    partner_id: 'Part_doc'
  })
};

fetch('https://api.eka.care/cdr/v1/doctor/', 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/cdr/v1/doctor/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'firstname' => 'Rajesh',
    'lastname' => 'Sharma',
    'mobile' => '0000011111',
    'dob' => '1999-01-01',
    'email' => 'dr.rajesh@example.com',
    'gender' => 'M',
    'specialisations' => [
        'Cardiology',
        'Internal Medicine'
    ],
    'qualifications' => [
        'MBBS',
        'MD',
        'DM'
    ],
    'about' => 'Dr. Rajesh Sharma is a renowned cardiologist with over 15 years of experience in interventional cardiology.',
    'profile_image_url' => 'https://example.com/images/dr-rajesh.jpg',
    'clinic_ids' => [
        'c-ab2c-34f2d-2gwd-2g2g'
    ],
    'partner_clinic_ids' => [
        'Part_clinic_1'
    ],
    'partner_id' => 'Part_doc'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "auth: <auth>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.eka.care/cdr/v1/doctor/"

	payload := strings.NewReader("{\n  \"firstname\": \"Rajesh\",\n  \"lastname\": \"Sharma\",\n  \"mobile\": \"0000011111\",\n  \"dob\": \"1999-01-01\",\n  \"email\": \"dr.rajesh@example.com\",\n  \"gender\": \"M\",\n  \"specialisations\": [\n    \"Cardiology\",\n    \"Internal Medicine\"\n  ],\n  \"qualifications\": [\n    \"MBBS\",\n    \"MD\",\n    \"DM\"\n  ],\n  \"about\": \"Dr. Rajesh Sharma is a renowned cardiologist with over 15 years of experience in interventional cardiology.\",\n  \"profile_image_url\": \"https://example.com/images/dr-rajesh.jpg\",\n  \"clinic_ids\": [\n    \"c-ab2c-34f2d-2gwd-2g2g\"\n  ],\n  \"partner_clinic_ids\": [\n    \"Part_clinic_1\"\n  ],\n  \"partner_id\": \"Part_doc\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("auth", "<auth>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.eka.care/cdr/v1/doctor/")
  .header("auth", "<auth>")
  .header("Content-Type", "application/json")
  .body("{\n  \"firstname\": \"Rajesh\",\n  \"lastname\": \"Sharma\",\n  \"mobile\": \"0000011111\",\n  \"dob\": \"1999-01-01\",\n  \"email\": \"dr.rajesh@example.com\",\n  \"gender\": \"M\",\n  \"specialisations\": [\n    \"Cardiology\",\n    \"Internal Medicine\"\n  ],\n  \"qualifications\": [\n    \"MBBS\",\n    \"MD\",\n    \"DM\"\n  ],\n  \"about\": \"Dr. Rajesh Sharma is a renowned cardiologist with over 15 years of experience in interventional cardiology.\",\n  \"profile_image_url\": \"https://example.com/images/dr-rajesh.jpg\",\n  \"clinic_ids\": [\n    \"c-ab2c-34f2d-2gwd-2g2g\"\n  ],\n  \"partner_clinic_ids\": [\n    \"Part_clinic_1\"\n  ],\n  \"partner_id\": \"Part_doc\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.eka.care/cdr/v1/doctor/")

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

request = Net::HTTP::Post.new(url)
request["auth"] = '<auth>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"firstname\": \"Rajesh\",\n  \"lastname\": \"Sharma\",\n  \"mobile\": \"0000011111\",\n  \"dob\": \"1999-01-01\",\n  \"email\": \"dr.rajesh@example.com\",\n  \"gender\": \"M\",\n  \"specialisations\": [\n    \"Cardiology\",\n    \"Internal Medicine\"\n  ],\n  \"qualifications\": [\n    \"MBBS\",\n    \"MD\",\n    \"DM\"\n  ],\n  \"about\": \"Dr. Rajesh Sharma is a renowned cardiologist with over 15 years of experience in interventional cardiology.\",\n  \"profile_image_url\": \"https://example.com/images/dr-rajesh.jpg\",\n  \"clinic_ids\": [\n    \"c-ab2c-34f2d-2gwd-2g2g\"\n  ],\n  \"partner_clinic_ids\": [\n    \"Part_clinic_1\"\n  ],\n  \"partner_id\": \"Part_doc\"\n}"

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "ekaid": "do1769174683513"
}

{
  "<field>": [
    "This field is required."
  ],
  "message": [
    "Only one of partner_clinic_ids or clinic_ids should be provided, not both."
  ]
}

Onboarding APIs

Create Doctor Profile

Overview

Create a new doctor profile for your business. This endpoint lets you register a doctor with their personal details, specializations, qualifications, and profile image.

Endpoint: {{HOST}}/cdr/v1/doctor

Method: POST

Request Parameters

Parameter	Type	Description	Required
firstname	string	Doctor’s first name	Yes
lastname	string	Doctor’s last name	Yes
gender	string	Doctor’s gender (M/F/O)	Yes
dob	string	Doctor’s date of birth (YYYY-MM-DD)	No
email	string	Doctor’s email address	No
mobile	string	Doctor’s mobile number (10 digits)	No
specialisations	array	List of doctor’s specializations	No
qualifications	array	List of doctor’s qualifications/degrees	No
about	string	Brief description about the doctor	No
profile_image_url	string	URL of the doctor’s profile image	No
clinic_ids	array	List of Eka clinic IDs to assign to this doctor	No
partner_clinic_ids	array	List of partner clinic IDs to assign to this doctor	No
partner_id	string	Unique identifier provided by partner	No

Response Parameters

Parameter	Type	Description
status	string	Status of the response (e.g., “success”)
ekaid	string	Unique identifier for the created doctor

Note: The specialisations and qualifications fields accept predefined values, if wanted these can be left empty as they are optional fields. For the complete and up-to-date list, see this Google Sheet: View Specializations & Qualifications List

POST

cdr

doctor

Create Doctor Profile

curl --request POST \
  --url https://api.eka.care/cdr/v1/doctor/ \
  --header 'Content-Type: application/json' \
  --header 'auth: <auth>' \
  --data '
{
  "firstname": "Rajesh",
  "lastname": "Sharma",
  "mobile": "0000011111",
  "dob": "1999-01-01",
  "email": "dr.rajesh@example.com",
  "gender": "M",
  "specialisations": [
    "Cardiology",
    "Internal Medicine"
  ],
  "qualifications": [
    "MBBS",
    "MD",
    "DM"
  ],
  "about": "Dr. Rajesh Sharma is a renowned cardiologist with over 15 years of experience in interventional cardiology.",
  "profile_image_url": "https://example.com/images/dr-rajesh.jpg",
  "clinic_ids": [
    "c-ab2c-34f2d-2gwd-2g2g"
  ],
  "partner_clinic_ids": [
    "Part_clinic_1"
  ],
  "partner_id": "Part_doc"
}
'

import requests

url = "https://api.eka.care/cdr/v1/doctor/"

payload = {
    "firstname": "Rajesh",
    "lastname": "Sharma",
    "mobile": "0000011111",
    "dob": "1999-01-01",
    "email": "dr.rajesh@example.com",
    "gender": "M",
    "specialisations": ["Cardiology", "Internal Medicine"],
    "qualifications": ["MBBS", "MD", "DM"],
    "about": "Dr. Rajesh Sharma is a renowned cardiologist with over 15 years of experience in interventional cardiology.",
    "profile_image_url": "https://example.com/images/dr-rajesh.jpg",
    "clinic_ids": ["c-ab2c-34f2d-2gwd-2g2g"],
    "partner_clinic_ids": ["Part_clinic_1"],
    "partner_id": "Part_doc"
}
headers = {
    "auth": "<auth>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {auth: '<auth>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    firstname: 'Rajesh',
    lastname: 'Sharma',
    mobile: '0000011111',
    dob: '1999-01-01',
    email: 'dr.rajesh@example.com',
    gender: 'M',
    specialisations: ['Cardiology', 'Internal Medicine'],
    qualifications: ['MBBS', 'MD', 'DM'],
    about: 'Dr. Rajesh Sharma is a renowned cardiologist with over 15 years of experience in interventional cardiology.',
    profile_image_url: 'https://example.com/images/dr-rajesh.jpg',
    clinic_ids: ['c-ab2c-34f2d-2gwd-2g2g'],
    partner_clinic_ids: ['Part_clinic_1'],
    partner_id: 'Part_doc'
  })
};

fetch('https://api.eka.care/cdr/v1/doctor/', 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/cdr/v1/doctor/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'firstname' => 'Rajesh',
    'lastname' => 'Sharma',
    'mobile' => '0000011111',
    'dob' => '1999-01-01',
    'email' => 'dr.rajesh@example.com',
    'gender' => 'M',
    'specialisations' => [
        'Cardiology',
        'Internal Medicine'
    ],
    'qualifications' => [
        'MBBS',
        'MD',
        'DM'
    ],
    'about' => 'Dr. Rajesh Sharma is a renowned cardiologist with over 15 years of experience in interventional cardiology.',
    'profile_image_url' => 'https://example.com/images/dr-rajesh.jpg',
    'clinic_ids' => [
        'c-ab2c-34f2d-2gwd-2g2g'
    ],
    'partner_clinic_ids' => [
        'Part_clinic_1'
    ],
    'partner_id' => 'Part_doc'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "auth: <auth>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.eka.care/cdr/v1/doctor/"

	payload := strings.NewReader("{\n  \"firstname\": \"Rajesh\",\n  \"lastname\": \"Sharma\",\n  \"mobile\": \"0000011111\",\n  \"dob\": \"1999-01-01\",\n  \"email\": \"dr.rajesh@example.com\",\n  \"gender\": \"M\",\n  \"specialisations\": [\n    \"Cardiology\",\n    \"Internal Medicine\"\n  ],\n  \"qualifications\": [\n    \"MBBS\",\n    \"MD\",\n    \"DM\"\n  ],\n  \"about\": \"Dr. Rajesh Sharma is a renowned cardiologist with over 15 years of experience in interventional cardiology.\",\n  \"profile_image_url\": \"https://example.com/images/dr-rajesh.jpg\",\n  \"clinic_ids\": [\n    \"c-ab2c-34f2d-2gwd-2g2g\"\n  ],\n  \"partner_clinic_ids\": [\n    \"Part_clinic_1\"\n  ],\n  \"partner_id\": \"Part_doc\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("auth", "<auth>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.eka.care/cdr/v1/doctor/")
  .header("auth", "<auth>")
  .header("Content-Type", "application/json")
  .body("{\n  \"firstname\": \"Rajesh\",\n  \"lastname\": \"Sharma\",\n  \"mobile\": \"0000011111\",\n  \"dob\": \"1999-01-01\",\n  \"email\": \"dr.rajesh@example.com\",\n  \"gender\": \"M\",\n  \"specialisations\": [\n    \"Cardiology\",\n    \"Internal Medicine\"\n  ],\n  \"qualifications\": [\n    \"MBBS\",\n    \"MD\",\n    \"DM\"\n  ],\n  \"about\": \"Dr. Rajesh Sharma is a renowned cardiologist with over 15 years of experience in interventional cardiology.\",\n  \"profile_image_url\": \"https://example.com/images/dr-rajesh.jpg\",\n  \"clinic_ids\": [\n    \"c-ab2c-34f2d-2gwd-2g2g\"\n  ],\n  \"partner_clinic_ids\": [\n    \"Part_clinic_1\"\n  ],\n  \"partner_id\": \"Part_doc\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.eka.care/cdr/v1/doctor/")

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

request = Net::HTTP::Post.new(url)
request["auth"] = '<auth>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"firstname\": \"Rajesh\",\n  \"lastname\": \"Sharma\",\n  \"mobile\": \"0000011111\",\n  \"dob\": \"1999-01-01\",\n  \"email\": \"dr.rajesh@example.com\",\n  \"gender\": \"M\",\n  \"specialisations\": [\n    \"Cardiology\",\n    \"Internal Medicine\"\n  ],\n  \"qualifications\": [\n    \"MBBS\",\n    \"MD\",\n    \"DM\"\n  ],\n  \"about\": \"Dr. Rajesh Sharma is a renowned cardiologist with over 15 years of experience in interventional cardiology.\",\n  \"profile_image_url\": \"https://example.com/images/dr-rajesh.jpg\",\n  \"clinic_ids\": [\n    \"c-ab2c-34f2d-2gwd-2g2g\"\n  ],\n  \"partner_clinic_ids\": [\n    \"Part_clinic_1\"\n  ],\n  \"partner_id\": \"Part_doc\"\n}"

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "ekaid": "do1769174683513"
}

{
  "<field>": [
    "This field is required."
  ],
  "message": [
    "Only one of partner_clinic_ids or clinic_ids should be provided, not both."
  ]
}

Headers

auth

string

required

The auth token of the business. It is used to authenticate the client. This should be fetched from auth api.

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJiX2lkIjoiMTIzNDU2IiwiY2xpZW50X2lkIjoiNzg5MCIsImV4dHJhX2ZpZWxkIjoiZXh0cmFfZmllbGRfZGF0YSJ9.q9KzBI6f4l3OyM_EkB5Quq0l9EEMFh5JS-fx3F_PHUM"

Body

application/json

Request body for creating a doctor profile

firstname

string

required

Doctor's first name

Example:

"Rajesh"

lastname

string

required

Doctor's last name

Example:

"Sharma"

gender

enum<string>

required

Doctor's gender (M - Male, F - Female, O - Other)

Available options:

M,

F,

O

Example:

"M"

mobile

string

Doctor's mobile number (10 digits)

Example:

"0000011111"

dob

string

Doctor's date of birth (YYYY-MM-DD) default to 1990-01-01, if not provided.

Example:

"1999-01-01"

string<email>

Doctor's email address

Example:

"dr.rajesh@example.com"

specialisations

string[]

List of doctor's specializations. Refer to the Available Specializations section for valid values.

Example:

["Cardiology", "Internal Medicine"]

qualifications

string[]

List of doctor's qualifications/degrees. Refer to the Available Qualifications section for valid values.

Example:

["MBBS", "MD", "DM"]

about

string

Brief description about the doctor

Example:

"Dr. Rajesh Sharma is a renowned cardiologist with over 15 years of experience in interventional cardiology."

profile_image_url

string<uri>

URL of the doctor's profile image

Example:

"https://example.com/images/dr-rajesh.jpg"

clinic_ids

string[]

List of Eka clinic IDs to assign to this doctor

Example:

["c-ab2c-34f2d-2gwd-2g2g"]

partner_clinic_ids

string[]

List of partner clinic IDs to assign to this doctor

Example:

["Part_clinic_1"]

partner_id

string

Unique identifier provided by partner

Example:

"Part_doc"

Response

Created - Doctor successfully created

status

string

Example:

"success"

ekaid

string

Unique identifier for the created doctor

Example:

"do1769174683513"

Authorization

End-to-End Encryption

Connect

HealthAI

Medical Database

General Tools

Doctor Tool

ABDM Connect

Medical Knowledge-bases

Medical Records

User App

Create Doctor Profile

Overview

Request Parameters

Response Parameters

Headers

Body

Response