---
title: "Create Eka User"
method: POST
path: "/cdr/v1/ekauser/"
tags: ["HIP Users API"]
---

# Create Eka User

`POST /cdr/v1/ekauser/`

### 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    |

## Headers

- `auth` string, required

## Request body

- object
  - `firstname` string, required — User's first name
  - `lastname` string, required — User's last name
  - `mobile` string — User's mobile number (10 digits). Either mobile or email or auth_userid is required.
  - `email` string, email — User's email address. Either mobile or email or auth_userid is required.
  - `auth_userid` string — 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)
  - `dob` string, date, required — User's date of birth in YYYY-MM-DD format
  - `is_admin` boolean — 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_ids` string[] — List of doctor Eka IDs to assign to this user
  - `partner_doctor_ids` string[] — List of partner doctor IDs to assign to this user
  - `clinic_ids` string[] — List of clinic Eka IDs to assign to this user
  - `partner_clinic_ids` string[] — List of partner clinic IDs to assign to this user

## Response `201`

Created - Eka User successfully created

- object
  - `status` string
  - `ekaid` string — Unique identifier for the created Eka User

## Other responses

- `400` — Bad Request - Invalid or missing required parameters

---

[API](https://skmtc.net/eka/apis/eka-developer-apis.md) · [All operations](https://skmtc.net/eka/apis/eka-developer-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/eka/eka-developer-apis/revisions/9ea23456f722/schema)