Skip to main content

Health Declaration

Submit health declarations for members. Health declarations capture medical history statements and disclosures that are linked to a specific Member, policy holder, and insurance policy.

Base URL:

https://api.{client_namespace}.najeeb.ai/v4.0/health/health-declarations

Create Health Declaration

POST /create

Submit a health declaration for a member. The system validates that the referenced member, policy holder, and insurance policy all exist before creating the declaration.

Request Body

FieldTypeRequiredConstraintsDescription
member_id *stringYes1-255 charsUUID of the member (patient) this declaration belongs to
erp_ph_id *stringYes1-255 charsERP code of the policy holder
policy_no *stringYes1-255 charsPolicy number of the insurance policy
health_declaration_captionstringNo1-4096 charsPrimary caption or question text of the declaration
health_declaration_caption2stringNo1-4096 charsSecondary caption or question text
health_declaration_type *stringYes1-16 charsType or category of the health declaration
health_declaration_valuestringNo1-16 charsThe member's response or value for the declaration

Request Example

curl -X POST \
"https://api.{client_namespace}.najeeb.ai/v4.0/health/health-declarations/create" \
-H "access-key: your-api-key-here" \
-H "Content-Type: application/json" \
-d '{
"member_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"erp_ph_id": "PH-001",
"policy_no": "POL-2025-00123",
"health_declaration_caption": "Do you have any pre-existing medical conditions?",
"health_declaration_caption2": "هل لديك أي حالات طبية سابقة؟",
"health_declaration_type": "BOOLEAN",
"health_declaration_value": "YES"
}'

Response

201 Created

{
"health_declaration_internal_id": 42,
"code": 201,
"message": "Health declaration created successfully"
}

Error Responses

StatusDescription
400Bad Request - Invalid or missing required fields. Check the details array for specifics
401Unauthorized - Missing or invalid access-key header
404Not Found - Member, policy holder, or insurance policy not found

  • Member - Health declarations are linked to members
  • Overview - Back to API overview