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 policies
      • GETRetrieve a policy
    • API Errors
Get access
LogoLogo
API ReferencePolicies

Retrieve a policy

GET
/policies/:policy_id
GET
/policies/:policy_id
$curl https://test.api.kota.io/policies/p_3b1333d87d9d4fd6ad83ba7f6b0e951a \
>     -H "Authorization: Bearer <apiKey>" \
>     -H "Content-Type: application/json"
1{
2  "id": "p_3b1333d87d9d4fd6ad83ba7f6b0e951a",
3  "employee_id": "ee_7f9a2c4d5b6e4f1a8c3d2e7f9b0a1c2d",
4  "group_policy_id": "gp_9a8b7c6d5e4f3a2b1c0d9e8f7a6b5c4d",
5  "bundling_type": "not_bundled",
6  "status": "scheduled",
7  "group_id": "gr_1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d",
8  "provider": {
9    "id": "pr_4d3c2b1a0f9e8d7c6b5a4e3f2d1c0b9a",
10    "name": "Acme Health Insurance",
11    "description": "Leading provider of comprehensive health insurance plans.",
12    "logo_url": "https://acmehealth.com/assets/logo.png"
13  },
14  "plan": {
15    "id": "pl_5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b",
16    "name": "Premium Health Plan",
17    "description": "Comprehensive coverage with low deductibles and extensive network.",
18    "currency": "eur",
19    "documents": [
20      {
21        "title": "Insurance Product Information Document",
22        "link": "https://acmehealth.com/docs/ipid-premium.pdf",
23        "type": "ipid"
24      }
25    ]
26  },
27  "start_date": "2024-12-01",
28  "type": "health_insurance",
29  "end_date": "2025-11-30",
30  "object": "policy"
31}

Retrieves a policy object.

Previous

List all policies

Next

List all policy amendment intents for a policy

Built with

Authentication

AuthorizationBearer
Authorization header using the Bearer scheme

Path parameters

policy_idstringRequiredformat: "p_.+"

Response

OK
idstringformat: "p_.+"

Unique identifier for the policy. Prefixed with p_.

employee_idstringformat: "ee_.+"

Identifier of the employee associated with this policy. Prefixed with ee_.

group_policy_idstringformat: "gp_.+"

Identifier of the group policy id associated with this policy. Prefixed with gp_.

bundling_typeenum
Indicates how this policy is bundled within a group
Allowed values:
statusenum
Current lifecycle state of the policy
Allowed values:
group_idstringformat: "gr_.+"

Identifier of the group associated with this policy. Prefixed with gr_.

providerobject
Provider information for this policy
planobject
Plan information for this policy
start_datedate

Policy start (effective) date in ISO 8601 (YYYY-MM-DD)

typeenum

Policy type. Determines which sub-object is populated.

Allowed values:
end_datedate or null

Policy end date (inclusive) in ISO 8601, or null if open-ended

cancellation_datedate or null

Date the policy was cancelled (if applicable)

health_insuranceobject

Health insurance–specific fields (present when type=health_insurance)

objectstringRead-only
Object type

Errors

404
Not Found Error