Retrieve a policy | Kota Embed Documentation

1 import requests 2 3 url = "https://test.api.kota.io/policies/p_3b1333d87d9d4fd6ad83ba7f6b0e951a" 4 5 headers = {"Authorization": "Bearer <token>"} 6 7 response = requests.get(url, headers=headers) 8 9 print(response.json())

1 { 2 "id": "p_3b1333d87d9d4fd6ad83ba7f6b0e951a", 3 "employee_id": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a", 4 "group_policy_id": "gp_3b1333d87d9d4fd6ad83ba7f6b0e951a", 5 "bundling_type": "not_bundled", 6 "status": "scheduled", 7 "group_id": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a", 8 "provider": { 9 "id": "pr_3b1333d87d9d4fd6ad83ba7f6b0e951a", 10 "name": "string", 11 "description": "string", 12 "logo_url": "string", 13 "employer_portal_url": "string", 14 "employee_portal_url": "string", 15 "support_phone_number": "string" 16 }, 17 "plan": { 18 "id": "pl_3b1333d87d9d4fd6ad83ba7f6b0e951a", 19 "name": "string", 20 "description": "string", 21 "currency": "eur", 22 "documents": [ 23 { 24 "title": "string", 25 "link": "string", 26 "type": "ipid" 27 } 28 ] 29 }, 30 "start_date": "2024-12-01", 31 "type": "health_insurance", 32 "end_date": "2024-12-01", 33 "cancellation_date": "2024-12-01", 34 "health_insurance": { 35 "opt_out_deadline": "2024-12-01", 36 "renewal": { 37 "renewal_date": "2024-12-01", 38 "window_start_date": "2024-12-01", 39 "window_end_date": "2024-12-01", 40 "status": "upcoming", 41 "renewed_policy_id": "p_3b1333d87d9d4fd6ad83ba7f6b0e951a" 42 }, 43 "configuration": { 44 "cost_sharing": { 45 "type": "member_count", 46 "member_count": { 47 "adults": 123, 48 "children": 123 49 }, 50 "member_selection": { 51 "partner": true, 52 "children": true 53 }, 54 "percentage": { 55 "percentage": 123 56 } 57 } 58 }, 59 "members": [ 60 { 61 "id": "pm_3b1333d87d9d4fd6ad83ba7f6b0e951a", 62 "first_name": "string", 63 "last_name": "string", 64 "date_of_birth": "2024-12-01", 65 "sex_at_birth": "male", 66 "member_type": "policyholder", 67 "member_number": "string" 68 } 69 ], 70 "estimated_gross_premium": { 71 "currency": "eur", 72 "monthly": { 73 "employee_contribution": 123, 74 "employer_contribution": 123, 75 "total": 123 76 }, 77 "term": { 78 "employee_contribution": 123, 79 "employer_contribution": 123, 80 "total": 123 81 } 82 }, 83 "policy_number": "string" 84 }, 85 "object": "string" 86 }

Retrieves a policy object.

Authentication

AuthorizationBearer

Authorization header using the Bearer scheme

Path Parameters

policy_idstringRequiredformat: "p_.+"

Response

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_datestringformat: "date"

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

typeenum

Policy type. Determines which sub-object is populated.

Allowed values:

end_datestring or nullformat: "date"

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

cancellation_datestring or nullformat: "date"

Date the policy was cancelled (if applicable)

health_insuranceobject or null

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

objectstring or null

Object type

Authentication

Path Parameters

Response

Errors