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/

Create Eka User

cURL

curl --request POST \
  --url https://api.eka.care/cdr/v1/ekauser/ \
  --header 'Content-Type: application/json' \
  --header 'auth: <auth>' \
  --data '
{
  "firstname": "Amit",
  "lastname": "Kumar",
  "mobile": "9876543210",
  "email": "[e-mail]",
  "auth_userid": "Prateek_@_123",
  "gender": "M",
  "dob": "1990-05-15",
  "is_admin": false,
  "seat_type": "b",
  "persona": "D",
  "doctor_ids": [
    "171266028552522",
    "171266028552523"
  ],
  "clinic_ids": [
    "c-314086a34253rd",
    "c-415197b45364se"
  ],
  "partner_doctor_ids": [
    "Part_doc_1",
    "Part_doc_2"
  ],
  "partner_clinic_ids": [
    "Part_clinic_1",
    "Part_clinic_2"
  ]
}
'

201

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

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 an Eka User

firstname · string · required

User's first name

Example:

"Amit"

lastname · string · required

User's last name

Example:

"Kumar"

gender · enum<string> · required

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

Available options: M, F, O

Example:

"M"

dob · string<date> · required

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

Example:

"1990-05-15"

mobile · string

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

Example:

"0000011111"

email · string<email>

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

Example:

"[e-mail]"

auth_userid · string

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

Example:

"Prateek_@_123"

is_admin · boolean · default: false

Whether the user has admin privileges

Example:

false

seat_type · enum<string>

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

Available options: b, p

Example:

"b"

persona · enum<string>

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

Available options: S, D

Example:

"D"

doctor_ids · string[]

List of doctor Eka IDs to assign to this user

Example:

["171266028552522", "171266028552523"]

partner_doctor_ids · string[]

List of partner doctor IDs to assign to this user

Example:

["Part_doc_1", "Part_doc_2"]

clinic_ids · string[]

List of clinic Eka IDs to assign to this user

Example:

["c-314086a34253rd", "c-415197b45364se"]

partner_clinic_ids · string[]

List of partner clinic IDs to assign to this user

Example:

["Part_clinic_1", "Part_clinic_2"]

Response

201

application/json

Created - Eka User successfully created

status · string

Example:

"success"

ekaid · string

Unique identifier for the created Eka User

Example:

"176917697553584"