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
| 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* |
| 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
mobileorauth_useridis required. At least one must be provided.
| Parameter | Type | Description |
|---|---|---|
| status | string | Status of the response (e.g., “success”) |
| ekaid | string | Unique identifier for the created Eka User |
Documentation Index
Fetch the complete documentation index at: https://ekacare-mintlify-changelog-1776733918.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
The auth token of the business. It is used to authenticate the client. This should be fetched from auth api.
"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJiX2lkIjoiMTIzNDU2IiwiY2xpZW50X2lkIjoiNzg5MCIsImV4dHJhX2ZpZWxkIjoiZXh0cmFfZmllbGRfZGF0YSJ9.q9KzBI6f4l3OyM_EkB5Quq0l9EEMFh5JS-fx3F_PHUM"
Request body for creating an Eka User
User's first name
"Amit"
User's last name
"Kumar"
User's gender (M - Male, F - Female, O - Other)
M, F, O "M"
User's date of birth in YYYY-MM-DD format
"1990-05-15"
User's mobile number (10 digits). Either mobile or email or auth_userid is required.
"0000011111"
User's email address. Either mobile or email or auth_userid is required.
"amit.kumar@example.com"
auth_userid used for SSO authentication. Either mobile or email or auth_userid is required
"Prateek_@_123"
Whether the user has admin privileges
false
Seat type (b - basic, p - premium). Default: b
b, p "b"
User persona (S - Staff, D - Doctor). Default: D
S, D "D"
List of doctor Eka IDs to assign to this user
["171266028552522", "171266028552523"]List of partner doctor IDs to assign to this user
["Part_doc_1", "Part_doc_2"]List of clinic Eka IDs to assign to this user
["c-314086a34253rd", "c-415197b45364se"]List of partner clinic IDs to assign to this user
["Part_clinic_1", "Part_clinic_2"]