For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Get access
Getting Started Key Concepts Integration Types Core Components Embed Hosted API API Reference
  • API Reference
    • Contribution Reports
    • Events and Webhooks
      • GETList all plans
      • GETRetrieve a plan
    • API Errors
Get access
LogoLogo
API ReferencePlans

Retrieve a plan

GET
/plans/:plan_id
GET
/plans/:plan_id
$curl https://test.api.kota.io/plans/pl_3b1333d87d9d4fd6ad83ba7f6b0e951a \
>     -H "Authorization: Bearer <apiKey>" \
>     -H "Content-Type: application/json"
1{
2  "id": "pl_3b1333d87d9d4fd6ad83ba7f6b0e951a",
3  "type": "health_insurance",
4  "name": "Global Health Plus Plan",
5  "description": "Comprehensive international health insurance plan covering medical, dental, and vision care worldwide.",
6  "country": "us",
7  "provider": {
8    "id": "pr_7f8e9d6c5b4a3f2e1d0c9b8a7e6f5d4c",
9    "name": "Kota Health Insurance",
10    "description": "Leading provider of international health insurance solutions with a focus on global coverage and customer service.",
11    "logo_url": "https://cdn.kota.io/logos/kota_health_insurance.png"
12  },
13  "documents": [
14    {
15      "title": "Insurance Product Information Document",
16      "link": "https://cdn.kota.io/docs/global_health_plus_ipid.pdf",
17      "type": "ipid"
18    }
19  ],
20  "employer_eligibility_criteria": [
21    {
22      "type": "employees_count",
23      "description": "Employers must have between 10 and 500 employees to be eligible.",
24      "employees_count": {
25        "min": 10,
26        "max": 500
27      }
28    }
29  ],
30  "employee_eligibility_criteria": [
31    {
32      "type": "age_range",
33      "description": "Eligible employees must be between 18 and 65 years old.",
34      "age_range": {
35        "min": 18,
36        "max": 65
37      }
38    }
39  ],
40  "disclosures": [
41    {
42      "category": "regulatory",
43      "type": "intermediary_role",
44      "text": "This plan is offered through authorized intermediaries who act on behalf of the insurer."
45    }
46  ],
47  "available_from": "2024-01-01",
48  "object": "plan"
49}

Retrieves a plan object by its ID.

Previous

List all plans

Next

List all policies

Built with

Authentication

AuthorizationBearer
Authorization header using the Bearer scheme

Path parameters

plan_idstringRequiredformat: "pl_.+"

Response

OK
idstringformat: "pl_.+"

Unique identifier for the plan. Prefixed with pl_.

typeenum
The benefit type of the plan.
Allowed values:
namestring
The name of the plan.
descriptionstring
Description of the plan.
countryenum
The country this plan is available in.
providerobject
The provider offering this plan.
documentslist of objects

List of plan documents (e.g., IPIDs, T&Cs).

employer_eligibility_criterialist of objects
Eligibility criteria that employers must meet.
employee_eligibility_criterialist of objects
Eligibility criteria that employees must meet.
disclosureslist of objects
Disclosures associated with this plan.
available_fromdate

The date from which this plan is available (inclusive).

objectstringRead-only

Object type. Always plan.

health_insuranceobject

Health insurance-specific details. Only populated when type is health_insurance.

available_todate or null

The date until which this plan is available (inclusive). Null if the plan has no end date.

coverage_optionslist of objects or null
Coverage options available for this plan, organized by scope and input type.

Errors

404
Not Found Error