> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.kota.io/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.kota.io/_mcp/server.

# Check employee eligibility for a group

POST https://test.api.kota.io/groups/{group_id}/eligibility_check
Content-Type: application/json

Checks whether an `employee` qualifies for a `group` without adding them to it. This is a dry-run eligibility check — the employee is not enrolled or added. The response includes provider and plan information.

Reference: https://docs.kota.io/api-reference/groups/check-group-eligibility

## Authentication

- `Authorization` header (bearer token, required) — Authorization header using the Bearer scheme

## Servers

- `https://test.api.kota.io` (test, default)
- `https://api.kota.io` (production)

## Request

### Path parameters

- `group_id` (string, required)

### Headers

- `X-Platform-Id` (string, optional) — The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.

### Body (application/json)

This endpoint expects a CheckGroupEligibilityRequest.

- `employee_id` (string, required) — The employee to check eligibility for.

## Response

### 200

OK

- `eligibility_status` (enum, required) — Eligibility status: `eligible` or `ineligible`.
  - Allowed values: `pending`, `eligible`, `ineligible`
- `reasons` (list of EligibilityCheckReasonResponse, required) — List of reasons why the employee is ineligible. Empty if eligible.
- `provider` (PlanProviderResponse, required) — The insurance provider associated with the group.
- `plan` (EligibilityCheckPlanResponse, required) — The insurance plan associated with the group.
- `object` (string, optional) — The object type.

## Errors

### 400 Bad Request Error

Bad Request

- `type` (string, optional, nullable)
- `title` (string, optional, nullable)
- `status` (integer, optional, nullable)
- `detail` (string, optional, nullable)
- `instance` (string, optional, nullable)

### 404 Not Found Error

Not Found

- `type` (string, optional, nullable)
- `title` (string, optional, nullable)
- `status` (integer, optional, nullable)
- `detail` (string, optional, nullable)
- `instance` (string, optional, nullable)

## Types

### EligibilityCheckReasonResponse

- `code` (string, required) — Machine-readable ineligibility reason code in snake_case.
- `message` (string, required) — Human-readable description of the ineligibility reason.

### PlanProviderResponse

- `id` (string, required) — Unique identifier for the provider. Prefixed with `pr_`.
- `name` (string, required) — The name of the provider.
- `description` (string, required) — Description of the provider.
- `logo_url` (string, required) — URL to the provider's logo.

### EligibilityCheckPlanResponse

- `id` (string, required) — Unique identifier for the plan. Prefixed with `pl_`.
- `name` (string, required) — The name of the plan.
- `description` (string, required) — Description of the plan.

## Examples

**Request**

```json
{
  "employee_id": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a"
}
```

**Response**

```json
{
  "eligibility_status": "pending",
  "reasons": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "provider": {
    "id": "pr_allianz",
    "name": "string",
    "description": "string",
    "logo_url": "string"
  },
  "plan": {
    "id": "pl_3b1333d87d9d4fd6ad83ba7f6b0e951a",
    "name": "string",
    "description": "string"
  },
  "object": "string"
}
```

**SDK Code**

```python
import requests

url = "https://test.api.kota.io/groups/gr_3b1333d87d9d4fd6ad83ba7f6b0e951a/eligibility_check"

payload = { "employee_id": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a" }
headers = {
    "Authorization": "Bearer <apiKey>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://test.api.kota.io/groups/gr_3b1333d87d9d4fd6ad83ba7f6b0e951a/eligibility_check';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <apiKey>', 'Content-Type': 'application/json'},
  body: '{"employee_id":"ee_3b1333d87d9d4fd6ad83ba7f6b0e951a"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://test.api.kota.io/groups/gr_3b1333d87d9d4fd6ad83ba7f6b0e951a/eligibility_check"

	payload := strings.NewReader("{\n  \"employee_id\": \"ee_3b1333d87d9d4fd6ad83ba7f6b0e951a\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://test.api.kota.io/groups/gr_3b1333d87d9d4fd6ad83ba7f6b0e951a/eligibility_check")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"employee_id\": \"ee_3b1333d87d9d4fd6ad83ba7f6b0e951a\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://test.api.kota.io/groups/gr_3b1333d87d9d4fd6ad83ba7f6b0e951a/eligibility_check")
  .header("Authorization", "Bearer <apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"employee_id\": \"ee_3b1333d87d9d4fd6ad83ba7f6b0e951a\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://test.api.kota.io/groups/gr_3b1333d87d9d4fd6ad83ba7f6b0e951a/eligibility_check', [
  'body' => '{
  "employee_id": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a"
}',
  'headers' => [
    'Authorization' => 'Bearer <apiKey>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://test.api.kota.io/groups/gr_3b1333d87d9d4fd6ad83ba7f6b0e951a/eligibility_check");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"employee_id\": \"ee_3b1333d87d9d4fd6ad83ba7f6b0e951a\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <apiKey>",
  "Content-Type": "application/json"
]
let parameters = ["employee_id": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a"] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://test.api.kota.io/groups/gr_3b1333d87d9d4fd6ad83ba7f6b0e951a/eligibility_check")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```