aflac · Schema

EnrollmentRequest

Request payload for creating or updating an enrollment.

Fortune 500

Properties

Name Type Description
employee_id string Employee identifier.
group_id string Employer group identifier.
product_type string Type of supplemental insurance product to enroll in.
coverage_level string Coverage level for the enrollment.
effective_date string Requested effective date for coverage.
dependents array List of dependents to include in family coverage.
View JSON Schema on GitHub

JSON Schema

enterprise-connect-enrollment-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aflac/refs/heads/main/json-schema/enterprise-connect-enrollment-request-schema.json",
  "title": "EnrollmentRequest",
  "description": "Request payload for creating or updating an enrollment.",
  "type": "object",
  "properties": {
    "employee_id": {
      "type": "string",
      "description": "Employee identifier.",
      "example": "EMP-789012"
    },
    "group_id": {
      "type": "string",
      "description": "Employer group identifier.",
      "example": "GRP-123456"
    },
    "product_type": {
      "type": "string",
      "description": "Type of supplemental insurance product to enroll in.",
      "enum": [
        "accident",
        "critical_illness",
        "cancer",
        "hospital_indemnity",
        "disability",
        "life"
      ],
      "example": "accident"
    },
    "coverage_level": {
      "type": "string",
      "description": "Coverage level for the enrollment.",
      "enum": [
        "employee_only",
        "employee_spouse",
        "employee_children",
        "family"
      ],
      "example": "employee_only"
    },
    "effective_date": {
      "type": "string",
      "format": "date",
      "description": "Requested effective date for coverage.",
      "example": "2025-01-01"
    },
    "dependents": {
      "type": "array",
      "description": "List of dependents to include in family coverage.",
      "items": {
        "$ref": "#/components/schemas/Dependent"
      },
      "example": [
        "example_value"
      ]
    }
  },
  "required": [
    "employee_id",
    "group_id",
    "product_type",
    "coverage_level",
    "effective_date"
  ]
}