HealthInsurance
Get insurance quotes based on user inputs
{{baseUrl}}v1/api/HealthInsurance/CreateIndividualPolicyCreate Individual Policy
This endpoint is used to create an individual health insurance policy by submitting personal and policy details in the request body. Provide all required fields such as personal information, contact details, and policy identifiers to successfully create a new policy.
{
"address": "Lagos",
"dob": "2004-02-26",
"email": "femibranc34h@gmail.com",
"firstName": "Olamide",
"gender": 2,
"imageURL": "https://d23lsjgf7v9q0y.cloudfront.net/images/ef057ab2-2707-411c-88f3-c8c6fa9b6573_image.jpeg",
"lastName": "Olaoluwa",
"localGovernmentArea": "Alimosho",
"maritalStatus": 1,
"middleName": "Femi",
"occupation": "Trader",
"phone": "07032778223",
"priceId": "57123bb0-7525-4d25-b53e-7de84014ccb7",
"productId": "0f1e04bc-309d-4542-832c-d038027f337d",
"state": "Lagos",
"dataConsent": true,
"hospital": "heartthrobe"
}{{baseUrl}}v1/api/HealthInsurance/CreateFamilyPolicyCreate Family Policy
{
"address": "temidire Ogun State",
"dateofBirth": "1996-02-02T13:33:16.647Z",
"email": "teswtw210@yopmail.com",
"firstName": "Olayiki",
"gender": 2,
"imageURL": "string",
"lastName": "Femibranch",
"lga": "Alimosho",
"maritalStatus": 0,
"occupation": "Realtor",
"paymentCycle": 0,
"phone": "07023880229",
"priceId": "021023ef-0a0c-41c7-873e-3ced244a5dd7",
"productId": "d38bf09c-283c-451c-9a77-34eb54e7d9cf",
"provider": 0,
"state": "Lagos",
"hospital": "Hamkad"
}{{baseUrl}}/v1/api/HealthInsurance/AddFamilyBeneficiaryAdd Family Beneficiary
**Purpose:** This endpoint allows you to add a new family beneficiary to a health insurance policy. It is typically used by merchants or administrators to register dependents or family members under an existing policy. **HTTP Method:** POST **Endpoint:** `/v1/api/HealthInsurance/AddFamilyBeneficiary` --- ### Request Headers - `Content-Type: application/json` (Required) — Indicates the request body format. - `Accept: text/plain` (Optional) — Expected response format. - `x-api-version: 1.0` (Required) — API versioning header. - `ClientId: {{clientId}}` (Required) — Unique client identifier (use variable or your assigned value). - `ApiKey: {{apiKey}}` (Required) — API key for authentication (use variable or your assigned value). --- ### Request Body Parameters (JSON) - `address` (string, required): Address of the beneficiary. - `dateofBirth` (string, required, ISO 8601): Date of birth (e.g., "1996-11-18T00:33:44.732Z"). - `dependantTypeId` (string, required): Identifier for the type of dependent (e.g., spouse, child). - `firstName` (string, required): First name of the beneficiary. - `gender` (integer, required): Gender (typically 1 = Male, 2 = Female; confirm with API documentation). - `imageURL` (string, required): URL to the beneficiary's image. - `lastName` (string, required): Last name of the beneficiary. - `lga` (string, required): Local Government Area. - `maritalStatus` (integer, required): Marital status (e.g., 1 = Single, 2 = Married; confirm with API documentation). - `occupation` (string, required): Occupation of the beneficiary. - `phonenumber` (string, required): Phone number. - `policyId` (string, required): The unique identifier of the health insurance policy to which the beneficiary will be added. - `state` (string, required): State of residence. - `email` (string, required): Email address of the beneficiary. - `hospital` (string, required): Preferred hospital or healthcare provider. --- **Important Notes:** - Ensure all required fields are provided and valid. - Use the correct `policyId` to associate the beneficiary with the intended policy. - The API may enforce validation on enumerated fields such as `gender` and `maritalStatus`—refer to the main API documentation for allowed values. - Authentication is enforced via `ClientId` and `ApiKey` headers. **Typical Use Case:** Registering a spouse, child, or other dependent under an existing health insurance policy for coverage extension.
{
"address": "Lagos Ojodu",
"dateofBirth": "1996-11-18T00:33:44.732Z",
"dependantTypeId": "2",
"firstName": "Famobranchg",
"gender": 1,
"imageURL": "https://d23lsjgf7v9q0y.cloudfront.net/images/ef057ab2-2707-411c-88f3-c8c6fa9b6573_image.jpeg",
"lastName": "Olabranch",
"lga": "string",
"maritalStatus": 1,
"occupation": "Realtor",
"phonenumber": "07034770038",
"policyId": "205dd151-04b9-444a-91fa-0e97c956e366",
"state": "Lagos",
"email": "hassan.olatde.hh@gmail.com",
"hospital": "Hamkad"
}Product
Retrieve products, hospitals and states
{{baseUrl}}v1/api/Product/GetHealthProducts?provider=0&type=0Get Health Products
This endpoint is used to get the healthinsurance products we offer.
{
"headers": {
"Accept": "text/plain; x-api-version=1.0",
"ClientId": "{{clientId}}",
"ApiKey": "{{apiKey}}"
},
"method": "GET",
"url": "{{baseUrl}}v1/api/Product/GetHealthProducts?provider=0&type=0"
}{{baseUrl}}v1/api/Product/GetHospitalList?state=LagosGet Hospital List
This endpoint is used to get the Hospital List . You can filter by state and Providers
{
"headers": {
"Accept": "text/plain; x-api-version=1.0",
"ClientId": "{{clientId}}",
"ApiKey": "{{apiKey}}"
},
"method": "GET",
"url": "{{baseUrl}}v1/api/Product/GetHospitalList?state=Lagos"
}{{baseUrl}}v1/api/Product/GetStatesGet States
{
"headers": {
"Accept": "text/plain; x-api-version=1.0",
"ApiKey": "{{apiKey}}",
"ClientId": "{{clientId}}"
},
"method": "GET",
"url": "{{baseUrl}}v1/api/Product/GetStates"
}{{baseUrl}}v1/api/Product/GetHMOLGA?provider=2&state=LagosGet HMOLGA
This endpoint is used to get the City/LGA where we have hospitals in a state.
{
"headers": {
"Accept": "text/plain; x-api-version=1.0",
"ApiKey": "{{apiKey}}",
"ClientId": "{{clientId}}"
},
"method": "GET",
"url": "{{baseUrl}}v1/api/Product/GetHMOLGA?provider=2&state=Lagos"
}Policy
Manage policy lifecycle
{{baseUrl}}v1/api/Policy/ReactivatePolicyReactivate Policy
{
"policyId": "5a0ee5b7-b68b-4ede-ab57-a4512ed15330",
"paymentCycle": 0
}{{baseUrl}}v1/api/Policy/DeactivatePolicyDeactivate Policy
{
"policyId": "5a0ee5b7-b68b-4ede-ab57-a4512ed15330"
}