v1

latestOpenAPI 3.0.32026-07-26229361630.0 KB
Doctor and clinic API

Create Clinic

Overview

The Create Clinic API allows you to register a new clinic for your business, including its name, address, pincode, contact number, city, state, and assigned doctors.

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

Method: POST

Request Parameters

ParameterTypeDescriptionRequired
namestringName of the clinicYes
addressstringAddress of the clinicYes
partner_idstringUnique id of the clinic in partner's system.No
pincodestringPincode of the clinicNo
contactstringContact numberNo
doctor_idsarrayList of doctor Eka IDs to assign to this clinicNo
partner_doctor_idsarrayList of partner doctor IDs to assign to this clinicNo
citystringCity nameNo
statestringState nameNo

Response Parameters

ParameterTypeDescription
statusstringStatus of the response (e.g., "success")
ekaidstringUnique identifier for the created clinic
post/cdr/v1/clinic/

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

namestring required

Name of the clinic

addressstring required

Address of the clinic

partner_idstring

Unique identifier of the clinic in the partner’s system

pincodestring

Pincode of the clinic

contactstring

Contact number (10 or 11 digits)

doctor_idsstring[]

List of doctor Eka IDs to assign to this clinic

partner_doctor_idsstring[]

List of partner doctor IDs to assign to this clinic

citystring

City name

statestring

State name

Example request

{
  "name": "Sunrise Clinic",
  "address": "123 Main Street, Block A",
  "partner_id": "Clinic_321_Indore",
  "pincode": "560001",
  "contact": "9876543210",
  "doctor_ids": [
    "171266028552522",
    "171266028552523"
  ],
  "partner_doctor_ids": [
    "Part_Doc_1",
    "Part_Doc_2"
  ],
  "city": "Bangalore",
  "state": "Karnataka"
}

Response

Created - Clinic successfully created

statusstring
ekaidstring

Unique identifier for the created doctor

Example response

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