Retrieve a policy import intent | Kota Developer Products Documentation

import requests
url = "https://test.api.kota.io/policy_import_intents/pii_3b1333d87d9d4fd6ad83ba7f6b0e951a"
headers = {"Authorization": "Bearer <apiKey>"}
response = requests.get(url, headers=headers)
print(response.json())

{
  "id": "pii_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "status": "processing",
  "employee_id": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "group_id": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "provider_policy_number": "string",
  "member_number": "string",
  "policy_start_date": "2024-12-01",
  "associated_persons": [
    {
      "id": "pii_3b1333d87d9d4fd6ad83ba7f6b0e951a",
      "associated_person_id": "ap_3b1333d87d9d4fd6ad83ba7f6b0e951a",
      "member_number": null,
      "start_date": "2024-12-01",
      "end_date": "2024-12-01"
    }
  ],
  "object": "string",
  "policy_end_date": "2024-12-01"
}

Retrieves a policy_import_intent object.

Authentication

AuthorizationBearer

Authorization header using the Bearer scheme

Path parameters

policy_import_intent_idstringRequiredformat: "pii_.+"

Response

idstringformat: "pii_.+"

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

statusenum

Current status of the policy import intent.

Allowed values:

employee_idstringformat: "ee_.+"

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

group_idstringformat: "gr_.+"

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

provider_policy_numberstring

The provider's policy number.

member_numberstring

The member number assigned by the provider.

policy_start_datedate

The start date of the policy.

associated_personslist of objects

List of associated persons linked to this policy import.

objectstring or nullRead-only

Object type identifier.

policy_end_datedate or null

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

Authentication

Path parameters

Response

Errors