Policy
Manage insurance policies, policy templates (categories, benefits, sub-benefits), patient-policy relationships, and patient benefit consumption. Policies belong to a Policy Holder and can have Members assigned through patient-policy operations. Networks are referenced when linking patients to policies.
Base URL
https://api.{client_namespace}.najeeb.ai/v4.0/health
Authentication
All API requests are authenticated using an API key passed in a dedicated header:
access-key: YOUR_API_KEY
For access key provisioning, please contact Najeeb support.
Policy Management
Create Policy
POST /policy/create
Create a new insurance policy linked to an existing policy holder. Optionally, you can add a patient to the policy in the same request using the add_patient_to_policy nested object.
A Policy Holder must exist before creating a policy. If you include add_patient_to_policy, the referenced Member and Network must also exist.
Request Body
| Parameter | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
policy_no * | string | Yes | Unique policy number | Alphanumeric string (e.g., POL-2024-001) |
start_date * | date | Yes | Policy start date | ISO date |
end_date * | date | Yes | Policy end date | ISO date |
created_date * | date | Yes | Date the policy was created | ISO date |
status * | Enum | Yes | Policy status | Enum: ACTIVE, INACTIVE, EXPIRED |
ph_erp_id * | string | Yes | ERP ID of the policy holder that owns this policy | Alphanumeric string |
plan_type | Enum | No | Type of the insurance plan | Enum: SME_POLICY, SME_AGGREGATOR_POLICY, TOURISM_VISA_POLICY, GROUP_POLICY, PREMIUM_VISA_POLICY, DOMESTIC_WORKER_POLICY, VISITOR_VISA_POLICY, VISITOR_VISA_EXTEND_POLICY |
policy_start_date | date | No | Policy start date | ISO date |
policy_end_date | date | No | Policy end date | ISO date |
policy_category | string | No | Category of the policy | Alphanumeric string |
add_patient_to_policy | object | No | Nested object to simultaneously add a patient to the policy | See nested object below |
add_patient_to_policy nested object:
| Parameter | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
member_id * | string | Yes | Member ID of the patient to add | Alphanumeric string |
network_code | string | No | Code of the network to associate | Alphanumeric string |
category_code * | string | Yes | Category code for the patient within the policy | Alphanumeric string |
start_date * | date | Yes | Patient-policy start date | ISO date |
end_date * | date | Yes | Patient-policy end date | ISO date |