Retrieve an enrolment intent | Kota Developer Products Documentation

curl https://test.api.kota.io/enrolment_intents/ei_3b1333d87d9d4fd6ad83ba7f6b0e951a \
     -H "Authorization: Bearer <apiKey>" \
     -H "Content-Type: application/json"

{
  "id": "ei_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "employee_id": "ee_7f9a2c4d5b6e4f1a8c3d2e7f9b0a1234",
  "group_id": "gr_9a8b7c6d5e4f3a2b1c0d9e8f7a6b5c4d",
  "status": "processing",
  "force_confirmation": true,
  "policy_enrolments": [
    {
      "type": "health_insurance",
      "estimated_effective_from": "2024-12-01",
      "provider": {
        "id": "pr_4d3c2b1a9f8e7d6c5b4a3f2e1d0c9b8a",
        "name": "Acme Health Providers",
        "description": "Leading provider of comprehensive health insurance plans.",
        "logo_url": "https://acmehealth.com/assets/logo.png"
      },
      "plan": {
        "id": "pl_1a2b3c4d5e6f7g8h9i0jklmnopqrstuv",
        "name": "Premium Health Plan",
        "description": "Comprehensive coverage including dental and vision.",
        "currency": "eur",
        "documents": [
          {
            "title": "Insurance Product Information Document",
            "link": "https://acmehealth.com/docs/ipid-premium.pdf",
            "type": "ipid"
          }
        ]
      },
      "id": "p_5f6e7d8c9b0a1b2c3d4e5f6a7b8c9d0e"
    }
  ],
  "disclosures": [
    {
      "category": "regulatory",
      "type": "intermediary_role",
      "text": "This enrolment is facilitated by an intermediary acting on behalf of the employee."
    }
  ],
  "object": "enrolment_intent"
}

Retrieves an enrolment_intent object.

curl https://test.api.kota.io/enrolment_intents/ei_3b1333d87d9d4fd6ad83ba7f6b0e951a \
     -H "Authorization: Bearer <apiKey>" \
     -H "Content-Type: application/json"

{
  "id": "ei_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "employee_id": "ee_7f9a2c4d5b6e4f1a8c3d2e7f9b0a1234",
  "group_id": "gr_9a8b7c6d5e4f3a2b1c0d9e8f7a6b5c4d",
  "status": "processing",
  "force_confirmation": true,
  "policy_enrolments": [
    {
      "type": "health_insurance",
      "estimated_effective_from": "2024-12-01",
      "provider": {
        "id": "pr_4d3c2b1a9f8e7d6c5b4a3f2e1d0c9b8a",
        "name": "Acme Health Providers",
        "description": "Leading provider of comprehensive health insurance plans.",
        "logo_url": "https://acmehealth.com/assets/logo.png"
      },
      "plan": {
        "id": "pl_1a2b3c4d5e6f7g8h9i0jklmnopqrstuv",
        "name": "Premium Health Plan",
        "description": "Comprehensive coverage including dental and vision.",
        "currency": "eur",
        "documents": [
          {
            "title": "Insurance Product Information Document",
            "link": "https://acmehealth.com/docs/ipid-premium.pdf",
            "type": "ipid"
          }
        ]
      },
      "id": "p_5f6e7d8c9b0a1b2c3d4e5f6a7b8c9d0e"
    }
  ],
  "disclosures": [
    {
      "category": "regulatory",
      "type": "intermediary_role",
      "text": "This enrolment is facilitated by an intermediary acting on behalf of the employee."
    }
  ],
  "object": "enrolment_intent"
}

Retrieves an enrolment_intent object.

Authentication

AuthorizationBearer

Authorization header using the Bearer scheme

Path parameters

enrolment_intent_idstringRequiredformat: "ei_.+"

Response

idstringformat: "ei_.+"

Unique identifier for the enrolment intent. Prefixed with ei_.

employee_idstringformat: "ee_.+"

Identifier for the employee associated with this enrolment intent. Prefixed with ee_.

group_idstringformat: "gr_.+"

Identifier for the group associated with this enrolment intent. Prefixed with gr_.

statusenum

Current status of the enrolment intent.

force_confirmationboolean

If set to true, the system will always force the PendingConfirmation state before enrolling the employee, even if no action is required. This can be useful in scenarios where you want to ensure that the employee explicitly confirms their enrolment, regardless of their eligibility or any other factors. Defaults to false.

policy_enrolmentslist of objects

Policy enrolment information

disclosureslist of objects

Disclosures associated with this intent.

objectstringRead-only

Object type identifier.

ineligibility_reasonobject

If the enrolment intent status is ineligible, this field provides details about the reason for employees ineligibility.

policy_configurationobject

Policy configuration associated with this enrolment intent.

action_requiredobject

If the enrolment intent status is action_required, this field provides details about the action that needs to be taken to proceed with the enrolment.

pending_confirmationobject

If the enrolment intent status is pending_confirmation, this field provides details about the pending confirmation state.

Errors

404

Not Found Error

$	curl https://test.api.kota.io/enrolment_intents/ei_3b1333d87d9d4fd6ad83ba7f6b0e951a \
>	-H "Authorization: Bearer <apiKey>" \
>	-H "Content-Type: application/json"

1	{
2	"id": "ei_3b1333d87d9d4fd6ad83ba7f6b0e951a",
3	"employee_id": "ee_7f9a2c4d5b6e4f1a8c3d2e7f9b0a1234",
4	"group_id": "gr_9a8b7c6d5e4f3a2b1c0d9e8f7a6b5c4d",
5	"status": "processing",
6	"force_confirmation": true,
7	"policy_enrolments": [
8	{
9	"type": "health_insurance",
10	"estimated_effective_from": "2024-12-01",
11	"provider": {
12	"id": "pr_4d3c2b1a9f8e7d6c5b4a3f2e1d0c9b8a",
13	"name": "Acme Health Providers",
14	"description": "Leading provider of comprehensive health insurance plans.",
15	"logo_url": "https://acmehealth.com/assets/logo.png"
16	},
17	"plan": {
18	"id": "pl_1a2b3c4d5e6f7g8h9i0jklmnopqrstuv",
19	"name": "Premium Health Plan",
20	"description": "Comprehensive coverage including dental and vision.",
21	"currency": "eur",
22	"documents": [
23	{
24	"title": "Insurance Product Information Document",
25	"link": "https://acmehealth.com/docs/ipid-premium.pdf",
26	"type": "ipid"
27	}
28	]
29	},
30	"id": "p_5f6e7d8c9b0a1b2c3d4e5f6a7b8c9d0e"
31	}
32	],
33	"disclosures": [
34	{
35	"category": "regulatory",
36	"type": "intermediary_role",
37	"text": "This enrolment is facilitated by an intermediary acting on behalf of the employee."
38	}
39	],
40	"object": "enrolment_intent"
41	}