Properties
| Name | Type | Description |
|---|---|---|
| eligible | boolean | Whether the employee is eligible for the product. |
| employee_id | string | Verified employee identifier. |
| group_id | string | Employer group identifier. |
| product_type | string | Product type checked. |
| ineligibility_reason | string | Reason for ineligibility if not eligible. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/aflac/refs/heads/main/json-schema/enterprise-connect-eligibility-response-schema.json",
"title": "EligibilityResponse",
"description": "Result of an eligibility verification check.",
"type": "object",
"properties": {
"eligible": {
"type": "boolean",
"description": "Whether the employee is eligible for the product.",
"example": true
},
"employee_id": {
"type": "string",
"description": "Verified employee identifier.",
"example": "EMP-789012"
},
"group_id": {
"type": "string",
"description": "Employer group identifier.",
"example": "GRP-123456"
},
"product_type": {
"type": "string",
"description": "Product type checked.",
"example": "accident"
},
"ineligibility_reason": {
"type": "string",
"description": "Reason for ineligibility if not eligible.",
"example": "Employee not in an eligible employment class."
}
}
}