Policies

Retrieve a policy

Changed on

Retrieves a policy object.

get/policies/{policy_id}

Request

  • Base URL
    https://test.api.kota.io
  • URL
    https://test.api.kota.io/policies/{policy_id}
  • Auth
    HTTP bearer

Path parameters

policy_idstring required
Example:p_3b1333d87d9d4fd6ad83ba7f6b0e951a

Response

OK

idstring required

Unique identifier for the policy. Prefixed with p_.

employee_idstring required

Identifier of the employee associated with this policy. Prefixed with ee_.

group_policy_idstring required

Identifier of the group policy id associated with this policy. Prefixed with gp_.

bundling_type'not_bundled' | 'bundled_primary' | 'bundled_secondary' required
status'scheduled' | 'active' | 'expired' | 'cancelled' required
group_idstring required

Identifier of the group associated with this policy. Prefixed with gr_.

start_datestring date required

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

end_datestring date nullable

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

cancellation_datestring date nullable

Date the policy was cancelled (if applicable)

opted_out_atstring date-time nullable

UTC timestamp of the moment the member opted out of this policy during the cooling-off window. Null when the policy is still running, and null when it ended any other way — an administrator cancelling it, the employee being offboarded, or the term expiring — even though those also set cancellation_date. Providers that only record the calendar day of an opt-out report midnight UTC.

type'health_insurance' | 'life_assurance' required
objectstring

Object type

Changes

  • 998f7cb004abRevision changes
    • warning

      deleted the header request parameter X-Platform-Id

  • ce9736d28f93Revision changes
    • warning

      added the new pooled_member_count enum value to the /////////////////// response property for the response status

    • warning

      added the new pooled_member_count enum value to the /////////////////// response property for the response status

    • info

      added the optional property /////////////// to the response with the status

    • info

      added the optional property /////////////// to the response with the status

    • info

      added the required property ////////// to the response with the status