v1

latestOpenAPI 3.0.32026-07-26229361630.0 KB

Doctor and clinic API

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/v1/doctor/

Headers

authstring required

Example:eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJiX2lkIjoiMTIzNDU2IiwiY2xpZW50X2lkIjoiNzg5MCIsImV4dHJhX2ZpZWxkIjoiZXh0cmFfZmllbGRfZGF0YSJ9.q9KzBI6f4l3OyM_EkB5Quq0l9EEMFh5JS-fx3F_PHUM

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

Request body

firstnamestring required

Doctor's first name

lastnamestring required

Doctor's last name

mobilestring

Doctor's mobile number (10 digits)

dobstring

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

emailstring email

Doctor's email address

gender'M' | 'F' | 'O' required

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

specialisationsstring[]

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

qualificationsstring[]

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

aboutstring

Brief description about the doctor

profile_image_urlstring uri

URL of the doctor's profile image

clinic_idsstring[]

List of Eka clinic IDs to assign to this doctor

partner_clinic_idsstring[]

List of partner clinic IDs to assign to this doctor

partner_idstring

Unique identifier provided by partner

Example request

{
  "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"
}

Response

Created - Doctor successfully created

statusstring

ekaidstring

Unique identifier for the created doctor

Example response

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