aflac · JSON Structure

Enterprise Connect Enrollment Request Structure

Request payload for creating or updating an enrollment.

Type: object Properties: 6 Required: 5
Fortune 500

EnrollmentRequest is a JSON Structure definition published by aflac, describing 6 properties, of which 5 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

employee_id group_id product_type coverage_level effective_date dependents

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aflac/refs/heads/main/json-structure/enterprise-connect-enrollment-request-structure.json",
  "name": "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": "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"
  ]
}