---
agentTools:
  projectIndex: https://nuclues-enrolment.readme.io/llms.txt
---

# Buy Health Plan

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Introduction",
    "description": "**Technology for Africa’s Health Insurance Industry** Technology and finance infrastructure to make health insurance affordable and accessible.\nIntegrations We aim to provide our API's for developers and businesses to offer insurance services to their existing customer base through REST APIs and without doing the heavy lifting. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.",
    "version": "2.1.0"
  },
  "servers": [
    {
      "description": "Sandbox",
      "url": "https://api.staging.v2.nucleusisafrica.com/api"
    },
    {
      "description": "production",
      "url": "https://production.v1.nucleusisafrica.com/api/"
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "tags": [
    {
      "name": "Buy Health Plan (Individual)"
    }
  ],
  "paths": {
    "/buy-plan": {
      "post": {
        "tags": [
          "Buy Health Plan (Individual)"
        ],
        "summary": "Buy Health Plan",
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "examples": {
                "test case 1": {
                  "value": {
                    "plan": 7,
                    "entity": {
                      "firstname": "Francis",
                      "lastname": "Awuya",
                      "email": "francis@nucleus.com.ng",
                      "phone": "2348066518328",
                      "gender": "male",
                      "dob": "5/10/1997",
                      "address": "Olla’s Place, Millenium Estate, Lekki Phase 1, Lagos",
                      "hospital": "lorem",
                      "photo": null,
                      "agreement": true,
                      "existingConditions": true,
                      "condition": {
                        "healthCondition": "Lorem Ipsum",
                        "healthConditionDuration": "06/20",
                        "healthConditionMedication": "Lorem Ipsum"
                      }
                    },
                    "dependants": [
                      {
                        "dependantFirstName": "james",
                        "dependantLastName": "Awuya",
                        "dependantEmail": "james@example.com",
                        "dependantPhoneNumber": "234806518328",
                        "dependantGender": "Male",
                        "dependantDob": "2/2/1997",
                        "dependantAddress": "Olla’s Place, Millenium Estate, Lekki Phase 1, Lagos",
                        "dependantHospital": "",
                        "dependantExistingConditions": true,
                        "dependantCondition": {
                          "healthCondition": "Lorem Ipsum",
                          "healthConditionDuration": "06/20",
                          "healthConditionMedication": "Lorem Ipsum"
                        }
                      }
                    ]
                  }
                }
              },
              "schema": {
                "$ref": "#/components/schemas/buy-plan-requestBody"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Successful response",
            "content": {
              "application/json": {}
            }
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer"
      }
    },
    "schemas": {
      "buy-plan-requestBody": {
        "type": "object",
        "properties": {
          "plan": {
            "type": "integer",
            "description": "plan ID (selected plan ID)",
            "example": 7
          },
          "entity": {
            "type": "object",
            "description": "individual (policy principal)",
            "example": {
              "entity": {
                "firstname": "Francis",
                "lastname": "Awuya",
                "email": "francis@nucleus.com.ng",
                "phone": "2348066518328",
                "gender": "male",
                "dob": "5/10/1997",
                "address": "Olla’s Place, Millenium Estate, Lekki Phase 1, Lagos",
                "hospital": "lorem",
                "photo": null,
                "agreement": true,
                "existingConditions": true,
                "condition": {
                  "healthCondition": "Lorem Ipsum",
                  "healthConditionDuration": "06/20",
                  "healthConditionMedication": "Lorem Ipsum"
                }
              }
            }
          },
          "dependants": {
            "description": "all enrolles for the specified health plan.",
            "type": "array",
            "items": {
              "type": "object"
            },
            "example": {
              "dependants": [
                {
                  "dependantFirstName": "james",
                  "dependantLastName": "Awuya",
                  "dependantEmail": "james@example.com",
                  "dependantPhoneNumber": "234806518328",
                  "dependantGender": "Male",
                  "dependantDob": "2/2/1997",
                  "dependantAddress": "Olla’s Place, Millenium Estate, Lekki Phase 1, Lagos",
                  "dependantHospital": "",
                  "dependantExistingConditions": true,
                  "dependantCondition": {
                    "healthCondition": "Lorem Ipsum",
                    "healthConditionDuration": "06/20",
                    "healthConditionMedication": "Lorem Ipsum"
                  }
                }
              ]
            }
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 103,
      "1": 182,
      "2": 7,
      "3": 165,
      "4": 83,
      "5": 98,
      "6": 116,
      "7": 0,
      "8": 83,
      "9": 214,
      "10": 5,
      "11": 42
    }
  }
}
```