Retrieve employer quote

GET

/employers/:employer_id/health_insurance/quotes/:employer_quote_id

Returns group’s health insurance quote for an employer by employer_quote_id.

Path parameters

employer_idstringRequired

employer_quote_idstringRequired

Response

idstringformat: "erhq_.+"

Unique identifier for the quote

employer_idstringformat: "er_.+"

The Id of the employer for which the is created

quoted_atdatetime

Date and time the quote was created at

statusenum

Allowed values: pending_quoteaction_requirednot_undertakenacceptedpending_insurer_acceptance

Current status of the quote

coverage_levelslist of objects

List of levels covered under the policy, each item representing details about the plan’s cover. Currently Kota only supports a single level of cover.

objectstringOptional

The object type

required_actionobjectOptional

Actions required by the employer to proceed with the quote. Set only when status is action_required.

GET

1 curl https://test.api.kota.io/employers/er_3b1333d87d9d4fd6ad83ba7f6b0e951a/health_insurance/quotes/erhq_3b1333d87d9d4fd6ad83ba7f6b0e951a \
2      -H "Authorization: Bearer <apiKey>"

200Retrieved

1 {
2   "id": "erhq_3b1333d87d9d4fd6ad83ba7f6b0e951a",
3   "employer_id": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a",
4   "quoted_at": "2024-01-15T09:30:00Z",
5   "status": "pending_quote",
6   "coverage_levels": [
7     {
8       "plan_id": "pl_3b1333d87d9d4fd6ad83ba7f6b0e951a",
9       "plan_name": "plan_name",
10       "plan_currency": "eur",
11       "provider_name": "provider_name",
12       "provider_logo_url": "provider_logo_url",
13       "documents": [
14         {
15           "title": "title",
16           "link": "link"
17         }
18       ],
19       "provider_employer_platform_url": "provider_employer_platform_url",
20       "provider_support_phone": "provider_support_phone"
21     }
22   ],
23   "object": "object",
24   "required_action": {
25     "reason": "reason",
26     "reason_description": "reason_description",
27     "code": "code",
28     "due_at": "2024-12-01"
29   }
30 }

Built with

1	curl https://test.api.kota.io/employers/er_3b1333d87d9d4fd6ad83ba7f6b0e951a/health_insurance/quotes/erhq_3b1333d87d9d4fd6ad83ba7f6b0e951a \
2	-H "Authorization: Bearer <apiKey>"

1	{
2	"id": "erhq_3b1333d87d9d4fd6ad83ba7f6b0e951a",
3	"employer_id": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a",
4	"quoted_at": "2024-01-15T09:30:00Z",
5	"status": "pending_quote",
6	"coverage_levels": [
7	{
8	"plan_id": "pl_3b1333d87d9d4fd6ad83ba7f6b0e951a",
9	"plan_name": "plan_name",
10	"plan_currency": "eur",
11	"provider_name": "provider_name",
12	"provider_logo_url": "provider_logo_url",
13	"documents": [
14	{
15	"title": "title",
16	"link": "link"
17	}
18	],
19	"provider_employer_platform_url": "provider_employer_platform_url",
20	"provider_support_phone": "provider_support_phone"
21	}
22	],
23	"object": "object",
24	"required_action": {
25	"reason": "reason",
26	"reason_description": "reason_description",
27	"code": "code",
28	"due_at": "2024-12-01"
29	}
30	}