v1

latestOpenAPI 3.0.32026-07-26229361630.0 KB

HIP Users API

Create Eka User

Overview

Create a new Eka User (HIP User) for your business. This endpoint lets you register a user with their personal details and assign them to specific doctors and clinics.

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

Method: POST

Request Parameters

Parameter	Type	Description	Required
firstname	string	User's first name	Yes
lastname	string	User's last name	Yes
mobile	string	User's mobile number (10 digits)	Yes*
email	string	User's email address	Yes*
auth_userid	string	auth_userid is used for the SSO authentication	Yes*
gender	string	User's gender (M/F/O)	Yes
dob	string	User's date of birth (YYYY-MM-DD)	Yes
is_admin	boolean	Whether the user is an admin	No
seat_type	string	Seat type (b - basic, p - premium). Default: b	No
persona	string	User persona (S - Staff, D - Doctor). Default: D	No
doctor_ids	array	List of doctor Eka IDs to assign to this user	No
partner_doctor_ids	array	List of partner doctor IDs to assign to this user	No
clinic_ids	array	List of clinic Eka IDs to assign to this user	No
partner_clinic_ids	array	List of partner clinic IDs to assign to this user	No

Note: Either mobile or email or auth_userid is required. At least one must be provided.

Response Parameters

Parameter	Type	Description
status	string	Status of the response (e.g., "success")
ekaid	string	Unique identifier for the created Eka User

post/cdr/v1/ekauser/

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

User's first name

lastnamestring required

User's last name

mobilestring

User's mobile number (10 digits). Either mobile or email or auth_userid is required.

emailstring email

User's email address. Either mobile or email or auth_userid is required.

auth_useridstring

auth_userid used for SSO authentication. Either mobile or email or auth_userid is required

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

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

dobstring date required

User's date of birth in YYYY-MM-DD format

is_adminboolean

Whether the user has admin privileges

seat_type'b' | 'p'

Seat type (b - basic, p - premium). Default: b

persona'S' | 'D'

User persona (S - Staff, D - Doctor). Default: D

doctor_idsstring[]

List of doctor Eka IDs to assign to this user

partner_doctor_idsstring[]

List of partner doctor IDs to assign to this user

clinic_idsstring[]

List of clinic Eka IDs to assign to this user

partner_clinic_idsstring[]

List of partner clinic IDs to assign to this user

Example request

{
  "firstname": "Amit",
  "lastname": "Kumar",
  "mobile": "0000011111",
  "email": "amit.kumar@example.com",
  "auth_userid": "Prateek_@_123",
  "gender": "M",
  "dob": "1990-05-15",
  "seat_type": "b",
  "persona": "D",
  "doctor_ids": [
    "171266028552522",
    "171266028552523"
  ],
  "partner_doctor_ids": [
    "Part_doc_1",
    "Part_doc_2"
  ],
  "clinic_ids": [
    "c-314086a34253rd",
    "c-415197b45364se"
  ],
  "partner_clinic_ids": [
    "Part_clinic_1",
    "Part_clinic_2"
  ]
}

Response

Created - Eka User successfully created

statusstring

ekaidstring

Unique identifier for the created Eka User

Example response

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