KOkota
Policy Import Intents

Create a new policy import intent

Changed on

Initiates a policy import process for an employee with an existing policy created outside of Kota's systems. This endpoint allows importing policy details for an employee who has an existing policy with one of our existing providers.

post/policy_import_intents

Request

  • Base URL
    https://test.api.kota.io
  • URL
    https://test.api.kota.io/policy_import_intents
  • Auth
    HTTP bearer

Request body

employee_idstring required

The employee ID for the policy import. Prefixed with ee_.

group_idstring required

The group ID for the policy import. Prefixed with g_.

group_policy_idstring nullable

The Id of a group_policy to which this policy belongs,Required when a group contains more than one benefit type / group policy!

provider_policy_numberstring required

The provider's policy number.

member_numberstring required

The member number assigned by the provider.

policy_start_datestring date required

The start date of the policy.

policy_end_datestring date nullable

The end date of the policy. Leave null if the policy has no end date.

Example request

{
  "employee_id": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "group_id": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "group_policy_id": "gp_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "policy_start_date": "2024-12-01",
  "policy_end_date": "2024-12-01",
  "associated_persons": [
    {
      "associated_person_id": "ap_3b1333d87d9d4fd6ad83ba7f6b0e951a",
      "start_date": "2024-12-01",
      "end_date": "2024-12-01"
    }
  ]
}

Response

OK

idstring required

Unique identifier for the policy import intent. Prefixed with pii_.

objectstring

Object type identifier.

status'processing' | 'failed' | 'success' required
employee_idstring required

The employee ID for the policy import. Prefixed with ee_.

group_idstring required

The group ID for the policy import. Prefixed with g_.

group_policy_idstring nullable

The group policy the policy is imported onto. Prefixed with gp_. Null if none was given.

provider_policy_numberstring required

The provider's policy number.

member_numberstring required

The member number assigned by the provider.

policy_start_datestring date required

The start date of the policy.

policy_end_datestring date nullable

The end date of the policy. Null if the policy has no end date, or end date is not known.

Example response

{
  "id": "pii_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "employee_id": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "group_id": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "group_policy_id": "gp_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "policy_start_date": "2024-12-01",
  "policy_end_date": "2024-12-01",
  "associated_persons": [
    {
      "associated_person_id": "ap_3b1333d87d9d4fd6ad83ba7f6b0e951a",
      "start_date": "2024-12-01",
      "end_date": "2024-12-01"
    }
  ]
}

Changes