---
openapi: 3.0.0
info:
  title: Policy API
  description: "# Summary \nPolicy API endpoints allows the transmission of Policy data between Guardian and it's consumers.Policy data includes bill, class, rates and benefit level information. The API is designed according to REST (Representational State Transfer) principles and uses JavaScript Object Notation (JSON) for requests and responses. All API traffic is encrypted over HTTPS and authentication is handled with OAuth2.\n\n# Versioning   \nGroup Policy API uses url path prefixing to maintain different versions of the api. The format used is a 'v' followed by the version number. Current version is v4. \n\n# Status Codes \nStatus Code  | Description \n-------------|-------------\n200          | Everything worked as expected. See response if applicable.\n400          | Bad Request. See error response with message.\n401          | Not a valid API key or Unauthorized.\n404          | Not Found. Either no API endpoint was found or there were no results for given parameters. \n500          | Internal Server Error. \n \n# Authentication and Authorization  \nGroup policy API leverages Guardian's Authorization server to provide secure access using the JWT client credentials grant.\n \n# Change Log\n  * Date - 04/19/2024 (Production Release  TBD)\n    * Added new endpoint to request renewal document for a given inforce policy (Policy Renewal Documents).  \n\n* Date - 03/01/2024 \n  * Changes under section -  Coverages\n    * Fields Added \n      * Changes under section - deductible\n        - orthodontia_lifetime_max\n        - ortho_maximum\n      * Changes under section - disability_benefits\n        - W2_FICA_reporting\n        - definition_of_disability\n          - definition\n          - months\n        - limitations\n          - special_limitations\n          - type\n          - months\n        - rehabilitation\n          - rehab_type\n          - rehab_percentage\n        - survivor\n          - survivor_duration\n          - survivor_payment\n          - survivor_basis\n        - cola\n          - fixed_percentage\n          - half_cpi_to_max_percentage\n          - adjust_ct\n          - delayed_months\n          - cola_tied_to_adl\n        - ltd_riders\n          - rider\n          - rider_guidelines\n            - months\n            - monthly_max\n            - overall_max\n            - permanent_or_total_disability_months\n        - first_day_hospital\n        \n     * Changes under section - additional_benefits\n       - Changes under section - pre_existing_code\n         - pre_existing_limitation\n        - Changes under section - portability\n          - conversion\n       - dental_benefit\n          - service\n             - service_options\n             - service_type\n         - treatments\n              - treatment_options\n              - code\n              - age_limit\n              - times\n              - months\n              - year\n        - vision_benefit\n          - benefit_riders\n          - lens_options\n       - life_benefit\n         - waiver_of_premium\n           - type\n           - months\n           - age_limit\n         - accelerated_life_benefit\n           - code\n           - processing_fee\n           - min_base_percentage\n           - min_base_amount\n           - term_illness_months\n           - max_base_percentage\n           - max_base_amount\n     - Updated on 11/17/2023\n       - rate_effective_date \n       - renewal_indicator\n       - member_benefit_term_age\n        - member_maximum_enrollment_age \n       - rider_included\n       - plan_state_code \n        - funding_type \n       - tax_liability \n        - coinsurance\n       - copay\n       - service_name \n       - life_time_maximum_amount\n        - maximum_benefit_amount\n       - maximum_period\n       - conditional_amount\n        - aadditional_amount \n    * Fields Removed (Weren't being used before)\n      - end_reason\n      - group_policy_number\n      - erisa_id \n      - plan_anniversary\n      - contact_information\n      - hourly_work_requirements\n      - effective_date\n      - end_date           \n      - coverage_depended_policy_number  \n      - coverage_depended_eligibility_group_number\n      - coverage_depended_benefit_class_identifier\n      - enabled\n      - allow_enrollment_at_limit\n      - dollar_amount_contribution\n      - hipaa_type\n      - hipaa_eligible\n      - billing_cut_off_day_of_month\n      - surcharges\n    * Fields Refactored \n      - benefit_plan_identifier  \n      - open_enrollments\n      - termination_rule \n    * Enum Updates\n      - coverage_tier (under Deductible)\n      - rate_differentiator_type (under Rate)\n      - guarantee_issue_type (under guarantee_issue)\n      - open_enrollment_type (under open_enrollments)\n      - student_age_limit_termination_rule (under dependent_child_age_limit)\n      - age_limit_termination_age (under dependent_child_age_limit)\n  * Changes under section - Employer  \n    * Fields Added      \n      - next_anniversary_date\n      - Classes\n      - erisa_id \n      - plan_anniversary\n      - contact_information\n      - hourly_work_requirements\n      - effective_date\n      - end_date \n      - employer_legal_address\n      - billing_type \n      - contact_email \n    * Fields Removed (Weren't being used before)\n      - claim_group_identifier\n      - employer_events\n      - employer_address \n    * Fields Refactored\n  * Changes under section - Transmission  \n    * Fields Added      \n    * Fields Removed (Weren't being used before)\n      - benefit_administrator_platform\n      - receiver_name\n    * Fields Renamed\n    * Fields Refactored        \n      - state_province_code\n      - country_code\n      \n          \n"
  termsOfService: /terms-and-conditions
  contact:
    name: API Support
    email: API_Admin@glic.com
  version: v4
  x-logo:
    altText: Group Insurance logo
tags:
- name: Policy Specifications
  description: Group Policy Comprehensive
- name: Group-Policy
  description: Group-Policy
- name: Push Notification
  description: Group policy change push notification
- name: Policy Integration
  description: Group policy Integration
- name: Policy Search
  description: Group policy Search
- name: Plan Setup Configuration
  description: group policy plan setup configuration
- name: Policy Renewal Documents
  description: Renewal documents for policy
- name: Asynchronous Plan Setup
- name: employer_model
  description: |
    <SchemaDefinition schemaRef="#/components/schemas/Employer" />
  x-displayName: Employer
- name: coverages_model
  description: |
    <SchemaDefinition schemaRef="#/components/schemas/Coverages" />
  x-displayName: Coverage
- name: rate_model
  description: |
    <SchemaDefinition schemaRef="#/components/schemas/Rate" />
  x-displayName: Rate
- name: bill_identifier
  description: |
    <SchemaDefinition schemaRef="#/components/schemas/BillGroup" />
  x-displayName: BillGroup
- name: error_model
  description: |
    <SchemaDefinition schemaRef="#/components/schemas/ErrorResponse" />
  x-displayName: Error
paths:
  /v4/policies/{master-agreement-number}/policyspecs:
    get:
      tags:
      - Policy Specifications
      summary: Get policy details.
      description: "Policyspecs endpoint will return a comprehensive list of information regarding group policy including plan benefit coverages, classes and rates. Policyspecs can be utilized as a companion guide to support building Guardian policy information."
      parameters:
      - name: master-agreement-number
        in: path
        description: An eight digit Carrier assigned group number with leading zeros. All individual policies or certificates at the group level would roll up to this master group number.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Request is processed as expected
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Transmission'
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "404":
          description: No results found
        "500":
          description: Internal Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        default:
          description: Internal Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v4/policies/{master-agreement-number}/computestatus:
    get:
      tags:
      - Group-Policy
      summary: Get policy status.
      description: "Computestatus endpoint retrieves information regarding the policy including effective date, termination date and status. Computestatus is key to know when the policy information is ready to be pulled or member enrollment is ready to be received.  "
      parameters:
      - name: master-agreement-number
        in: path
        description: An eight digit Carrier assigned group number with leading zeros. All individual policies or certificates at the group level would roll up to this master group number.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: as_of_date
        in: query
        description: "date for which policy status is required , Date format is mm/dd/yyyy, if not given current date will be considerd as as of date"
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        "200":
          description: Request is processed as expected
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PolicyStatus'
            application/xml:
              schema:
                $ref: '#/components/schemas/PolicyStatus'
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "404":
          description: No results found
        "500":
          description: Internal Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        default:
          description: Internal Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v4/policies/{master-agreement-number}/billgroup:
    get:
      tags:
      - Group-Policy
      summary: Get policy division details.
      description: Billgroup endpoint retrieves limited information regarding the policy division details.
      parameters:
      - name: master-agreement-number
        in: path
        description: An eight digit Carrier assigned group number with leading zeros. All individual policies or certificates at the group level would roll up to this master group number.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Request is processed as expected
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BillGroups'
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "404":
          description: No results found
        "500":
          description: Internal Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        default:
          description: Internal Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v4/policies/policy-change-notification:
    post:
      tags:
      - Push Notification
      summary: Carrier sends policy updates.
      description: This API allows Guardian to notify the recipient when plan updates have been made in the Guardian system and are available to be pulled using the GET PolicySpecs end point.
      requestBody:
        description: Request object containing policy change notification
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PolicyChangeInfo'
        required: true
      responses:
        "200":
          description: Request is processed as expected
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "404":
          description: No results found
        "500":
          description: Internal Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        default:
          description: Internal Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v4/policies/{master-agreement-number}/integration:
    post:
      tags:
      - Policy Integration
      summary: Feed from BenAdmin to update benadmin reference id and authorization key corresponding to Guardian master-agreement-number.
      description: Policy Integration.
      parameters:
      - name: master-agreement-number
        in: path
        description: An eight digit Carrier assigned group number with leading zeros. All individual policies or certificates at the group level would roll up to this master group number.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: Request object containing policy change notification
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Integration'
        required: true
      responses:
        "200":
          description: Request is processed as expected
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "404":
          description: No results found
        "500":
          description: Internal Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        default:
          description: Internal Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v4/policies/search:
    post:
      tags:
      - Policy Search
      summary: Search policies based on tax id.
      description: Policy Integration.
      parameters:
      - name: max_records_to_return
        in: query
        description: Maximum records to return.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: record_offset
        in: query
        description: Number of records to skip.
        required: false
        style: form
        explode: true
        schema:
          type: string
      requestBody:
        description: Request object containing policy change notification
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Taxid'
        required: true
      responses:
        "200":
          description: Request is processed as expected
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PolicySearchResponse'
  /v4/policies/{master-agreement-number}/plan/setup/status:
    post:
      tags:
      - Asynchronous Plan Setup
      summary: Send Plan Setup Status.
      description: This end point will be used for partner to send policy response asynchronously.
      parameters:
      - name: master-agreement-number
        in: path
        description: An eight digit Carrier assigned group number with leading zeros. All individual policies or certificates at the group level would roll up to this master group number.
        required: true
        style: simple
        explode: false
        schema:
          maxLength: 8
          minLength: 8
          type: string
          example: "00123456"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AsyncResponse'
        required: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
  /v4/policies/plan/setup/configuration:
    post:
      tags:
      - Plan Setup Configuration
      summary: Configure Plan Information.
      description: This end point will be used for benAdmin to send the policy plan setup configuration.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TransmissionNB'
        required: true
      responses:
        "200":
          description: Request is processed as expected
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "404":
          description: No results found
        "500":
          description: Internal Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        default:
          description: Internal Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v4/policies/{master-agreement-number}/plan/setup/configuration:
    put:
      tags:
      - Plan Setup Configuration
      summary: Configure Plan Information.
      description: This end point will be used for benAdmin to send the policy plan setup configuration amendment.
      parameters:
      - name: master-agreement-number
        in: path
        description: An eight digit Carrier assigned group number with leading zeros. All individual policies or certificates at the group level would roll up to this master group number.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Transmission_1'
        required: true
      responses:
        "200":
          description: Request is processed as expected
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "404":
          description: No results found
        "500":
          description: Internal Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        default:
          description: Internal Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v4/policies/{master-agreement-number}/renewal/documents:
    get:
      tags:
      - Policy Renewal Documents
      summary: Policy Renewal Document.
      description: Policy Renewal Document.
      parameters:
      - name: master-agreement-number
        in: path
        description: An eight digit Carrier assigned group number with leading zeros. All individual policies or certificates at the group level would roll up to this master group number.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Ok.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Transmission_2'
        "400":
          description: Bad Request.
        "401":
          description: Not valid API Key.
        "404":
          description: Not Found. Either no API endpoint was found or there were no results for given parameters.
        "500":
          description: Internal Server Error
        default:
          description: Internal Server Error

security:
  - bearerAuth:[]
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearerAuth
      bearerFormat: JWT

  schemas:
    Transmission:
      type: object
      properties:
        transmission_guid:
          type: string
          description: Global Unique identifier created by the originator for this instance of the electronic transmission.
          example: 030c89b1-8732-492b-b69a-2239e14264e5
        sender_name:
          type: string
          description: Name of the company sending electronic benefit records on behalf of a group.
          example: The Guardian Life Insurance Company of America
        creation_date_time:
          type: string
          description: UTC date and time the transmission was created.
          example: 2019-08-23T15:36:40.881
        test_production_code:
          type: string
          description: Indicates the elements contained in this data set are production or test data.
          example: Test
        transmission_type_code:
          type: string
          description: "The type of data contained within the data set. requirements - Situational - when TransmissionTypeCode = ChangesOnly then an Event record with an EventType and EventReason are required in the WBEDX transmission, else no Event record."
          example: FullFile
        schema_version_identifier:
          type: string
          description: Identifies the version of the standard that is being adhered to in this data set.
          example: 1.1.5
        Employers:
          $ref: '#/components/schemas/Employers'
        Audit:
          $ref: '#/components/schemas/Audit'
    Employers:
      required:
      - Employer
      type: object
      properties:
        employer:
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/Employer'
      description: "An organized group of people with a particular purpose, such as a business or government department."
    Employer:
      required:
      - employees
      - employer_name
      - employer_party_id
      - master_agreement_number
      type: object
      properties:
        employer_party_id:
          type: string
          description: Guardian generated system assigned number which gives uniqueness to the policies.
          example: "00000001"
        federal_employer_identification_number:
          type: string
          description: A nine-digit unique number assigned by the Internal Revenue Service (IRS) to businesses operating in the United States.
          example: "123456789"
        master_agreement_number:
          type: string
          description: Guardian generated system assigned number which gives uniqueness to the policies.
          example: "00000001"
        policy_effective_date:
          type: string
          description: Effective date of the policy.
          example: 01/01/2021
        policy_termination_date:
          type: string
          description: Termination date of the policy.
          example: 12/31/2021
        plan_anniversary:
          $ref: '#/components/schemas/Employer_plan_anniversary'
        renewal_date:
          type: string
          description: Renewal date MM/dd format.
          example: 08/01
        renewal_start:
          type: string
          description: Renewal date MM/dd format.
          example: 02/01
        next_anniversary_date:
          type: string
          description: Upcoming anniversary date.
          example: 01/01/2021
        broker_id:
          type: string
          description: Producer Id from VMS
          example: 000AB123
        employer_name:
          type: string
          description: Legal name of the employer.
          example: ABC Corporation
        employer_legal_address:
          $ref: '#/components/schemas/PostalAddress'
        contact_information:
          $ref: '#/components/schemas/Employer_contact_information'
        billing_type:
          type: string
          description: Billing Type.
          enum:
          - SELF_ADMINISTERED
          - HOME_OFFICE_BILLED
          - LIST_BILLED
        erisa_id:
          type: string
          description: Describes if the coverage is exempt or non exempt from the Employee Retirement Income Security Act of 1974.
          example: Non-Exempt
        state_disclaimers:
          type: string
          description: State Disclaimers URL.
        events:
          $ref: '#/components/schemas/Events'
        bill_group_identifiers:
          type: array
          items:
            $ref: '#/components/schemas/BillGroupIdentifiers'
        classes:
          type: array
          items:
            $ref: '#/components/schemas/Classes'
        coverages:
          type: array
          items:
            $ref: '#/components/schemas/Coverages'
        Attachment:
          type: array
          items:
            $ref: '#/components/schemas/Attachment'
      description: An entity that employees people or is organized for a joint purpose.
    PostalAddress:
      required:
      - city_nName
      - first_line_address
      - postal_code
      type: object
      properties:
        first_line_address:
          type: string
          description: "The first line of a formatted address - e.g., Street Number + Street Name, P.O. Box, etc."
          example: 7 Hanover Sq
        second_line_address:
          type: string
          description: The second line of a formatted address
          example: 10th Floor
        third_line_address:
          type: string
          description: The third line of a formatted address that is sometimes used for things like 'care of'.
          example: Care of Guardian
        city_name:
          type: string
          description: The city where the address is located.
          example: New York City
        state_province_code:
          $ref: '#/components/schemas/StateProvince'
        postal_code:
          type: string
          description: The unique identifier used to associate postal deliveries. This may also be referred to as zip code or post code where the address is located.
          example: 10004-1234
        country_code:
          $ref: '#/components/schemas/Country'
      description: "An address used for the delivery of letters and packages by an external mailing or packaging service, at a place where the recipient usually lives or works."
    StateProvince:
      type: string
      description: "A short, alphabetic geographic abbreviation for the state or province within a country."
      example: NY
      enum:
      - AL
      - AK
      - AZ
      - AR
      - CA
      - CO
      - CT
      - DE
      - FL
      - GA
      - HI
      - ID
      - IL
      - IN
      - IA
      - KS
      - KY
      - LA
      - ME
      - MD
      - MA
      - MI
      - MN
      - MS
      - MO
      - MT
      - NE
      - NV
      - NH
      - NJ
      - NM
      - NY
      - NC
      - ND
      - OH
      - OK
      - OR
      - PA
      - RI
      - SC
      - SD
      - TN
      - TX
      - UT
      - VT
      - VA
      - WA
      - WV
      - WI
      - WY
      - DC
      - AS
      - GU
      - MP
      - PR
      - UM
      - VI
      - AB
      - BC
      - MB
      - NB
      - NL
      - NS
      - PE
      - QE
      - SU
      - NT
      - NU
      - YT
      - AG
      - BS
      - CM
      - CS
      - CH
      - CL
      - DF
      - DG
      - GT
      - GR
      - HG
      - JA
      - EM
      - NA
      - OA
      - PU
      - QT
      - QR
      - SL
      - SI
      - SO
      - TB
      - TM
      - TL
      - VE
      - YU
      - ZA
    Country:
      type: string
      description: "A short alphabetic, geographical code for a country used for data processing and communications."
      example: USA
      enum:
      - USA
      - CA
      - OTH
      - US
      - MX
    Events:
      type: object
      properties:
        event:
          type: array
          items:
            $ref: '#/components/schemas/Event'
      description: "A collection of things that happen or take place, especially one of importance - e.g., a universal reason for member enrollment such as new hire, annual enrollment, qualifying life event"
    Event:
      required:
      - event_date
      - event_id
      - event_type_code
      - event_type_reason_code
      type: object
      properties:
        event_id:
          type: string
          description: "Provide description of the data we are pushing to vendor.  Code details to be provided, but examples include New Business, Amendment, Renewal, etc."
        event_type_code:
          $ref: '#/components/schemas/Event_event_type_code'
        event_type_reason_code:
          $ref: '#/components/schemas/Event_event_type_reason_code'
        event_date:
          type: string
          description: The date on which a specific occurrence took place.
          format: date
        transaction_date:
          type: string
          description: Date the employee enrolled and saved their elections in the enrollment system.
          format: date
      description: "A thing that happens or takes place, especially one of importance - e.g., a universal reason for member enrollment such as new hire, annual enrollment, qualifying life event."
    EventType:
      type: string
      description: It describes the things that are happening / taking place that are of importance.
      enum:
      - Coverage
      - Employment
      - Demographic
    EventTypeReason:
      type: string
      description: "A cause, explanation, or justification for an action or event."
      enum:
      - AdministrativeCorrection
      - ApprovedEvidenceOfInsurability
      - ApprovedPendedEnrollment
      - Cancellation
      - CHANGEForChangeOrTermination
      - ChangeInCoverageUnderOtherEmployer'sPlan
      - ChangeNewHireNE
      - ChildNoLongerEligible
      - ClientTermination
      - COBRAActivation
      - COBRAEndCoverage
      - GainOfSpousesBenefitEligibility
      - InitialEnrollment
      - LateEntrant
      - LossOfSpousesBenefitEligibility
      - New
      - NewHireEnrollment
      - NewRetireeEnrollment
      - NonPaymentOfContributions
      - OpenEnrollment
      - OtherNon-COBRALossOfCoverage
      - Qualifying Life Event Enrollment
      - Reenrollment
      - Reinstatement
      - RejectedEvidenceOfInsurability
      - RetirementEndCoverage
      - Rollover
      - SpecialEnrollment
      - SpouseCoverageChange
      - UnderwritingDecision
      - CoverageChange
      - AddressChange
      - BirthAdoption
      - Birthdate
      - ChangeToFullTimeStudent
      - ChildDeath
      - ChildRegainsEligibility
      - Death
      - DemographicChange
      - DivorceLegalSeparation
      - DomesticPartnerSeparation
      - Marriage
      - SpouseDeath
      - SurvivingChildEmployeeDeceased
      - SurvivingSpouseEmployeeDeceased
      - TobaccoChange
      - ZipLocationChange
      - BenefitClassChangeSpecial
      - CommenceFMLALeave
      - CommenceUnpaidLeaveOfAbsence
      - ExtendedLeave
      - IncreaseInHours
      - InterCompanyTransfer
      - Layoff
      - LossOfBenefitStatus
      - MilitaryLeaveOfAbsence
      - ReductionInHours
      - Rehire
      - Retirement
      - ReturnFromFMLALeave
      - ReturnFromMilitaryLeave
      - ReturnFromOtherUnpaidLeaveOfAbsence
      - Suspension
      - Termination
      - TerminationNotCOBRAEligible
      - Unknown
    BillGroupIdentifiers:
      type: object
      properties:
        bill_group_identifier:
          type: string
          description: Carrier assigned code to tie the coverage back to a billing arrangement.
          example: "0001"
        bill_group_name:
          type: string
          description: Carrier assigned bill group name.
          example: Bill Group
        bill_group_effective_date:
          type: string
          description: Carrier assigned bill group effective date.
          example: Bill Group Effective Date
        bill_group_end_date:
          type: string
          description: Carrier assigned bill group end date.
          example: Bill Group End Date
        bill_sub_group:
          type: array
          items:
            $ref: '#/components/schemas/BillSubGroup'
    BillSubGroup:
      type: object
      properties:
        bill_sub_group_type:
          type: string
          description: Indicates the type of bill sub group.
          example: CLASS
          enum:
          - CLASS
          - LOCATION
          - CUSTOM
          - JOB_TITLE
        bill_sub_group_identifier:
          type: string
          description: Carrier assigned code to tie the coverage back to a billing sort group/department
          example: "0001"
    Classes:
      type: object
      properties:
        benefit_class_name:
          type: string
          description: The display name of the eligibility or population group.
          example: ALL ELIGIBLE EMPLOYEES
        benefit_class_identifier:
          type: string
          description: "A carrier specific identifier of this eligibility group, intended for the BenAdmin to store and send back to the carrier with enrollment data."
          example: "0001"
        hourly_work_requirements:
          type: string
          description: Describes the number of hours required to be eligible for the benefit plan.
          example: "30.0"
        effective_date:
          type: string
          description: This will display the effective date of the plan
          example: 01/01/2019
        end_date:
          type: string
          description: This will display the end date of the plan
          example: ' '
    Coverages:
      type: object
      properties:
        BenefitPlanEvents:
          type: array
          items:
            $ref: '#/components/schemas/PlanBenefit'
    PlanBenefit:
      type: object
      properties:
        plan_name:
          type: string
          description: Coverage / Benefit name
          example: Dental
        plan_effective_Date:
          type: string
          description: Effective date of the coverage
          example: 01/01/2021
        plan_termination_date:
          type: string
          description: Termination date of the coverage
          example: 01/01/2021
        plan_year_start_date:
          type: string
          description: Plan Start Date
          example: 01/01/2021
        plan_year_end_date:
          type: string
          description: Plan End Date
          example: 01/01/2021
        plan_state_code:
          $ref: '#/components/schemas/PlanBenefit_plan_state_code'
        benefit_plan_identifier:
          $ref: '#/components/schemas/PlanBenefit_benefit_plan_identifier'
        product_type:
          type: string
          description: Product type is currently set to be the descriptor in Guardian's system to assist in explaining the plan identifier.  We plan on defining these fields in the near future.
          example: Dental
        product_descriptor:
          type: string
          description: Description of the the product.
          example: MDG
        coverage_tier:
          type: string
          description: "Requirements-for Life, LTD, STD, AD&D this is Employee; for Spouse Life and Spouse AD&D this is SpouseOnly; for Child Life and Child AD&D this is ChildOnly. Not needed for health and welfare (ProductType Dental, Vision, Medical)"
          example: EMPLOYEE_FAMILY
          enum:
          - EMPLOYEE
          - EMPLOYEE_DEPENDENT
          - EMPLOYEE_SPOUSE
          - EMPLOYEE_CHILDREN
          - EMPLOYEE_FAMILY
          - EMPLOYEE_2_DEPENDENT
          - SPOUSE_ONLY
          - SPOUSE_DEPENDENT
          - SPOUSE_CHILDREN
          - CHILD_ONLY
        funding_type:
          type: string
          description: Funding Type
          enum:
          - ADMINISTRATIVE_SERVICE_ONLY
          - MINIMUM_PREMIUM_PLAN
          - FULLY_INSURED
        buy_up:
          type: string
        buy_up_percentage_increase_overbase:
          type: string
          description: "Describes the inrease in covered percentage of earnings over the base PercentageOfEarnings for buyup coverage. Requirements- required for buyup coverage, not populated for base coverage."
        cobra_eligible:
          type: string
          description: Describes if the benefit_plan_descriptor is cobra eligible.
          example: "Cobra benefits apply, no vendor services"
        deductible:
          type: array
          items:
            $ref: '#/components/schemas/Deductible'
        coinsurance:
          type: array
          items:
            $ref: '#/components/schemas/Coinsurance'
        copay:
          type: array
          items:
            $ref: '#/components/schemas/Copay'
        rate_guarantee_expiration_date:
          type: string
          description: "The date on which the contractual guarantee of rates expires. For Medical, Dental, and Vision plans this is typically the next anniversary date. For insurance and voluntary plans this may be further in the future."
          example: ' '
        rate_effective_date:
          type: string
          description: Effective date of the rates.
          example: 01/01/2021
        renewal_indicator:
          type: string
          description: Indicates if the renewal rates exist.
          enum:
          - "true"
        conditional_underwriting:
          type: string
          description: An additional question in the electronic evidence of insurability application which needs to be answered favorably before coverage can be approved.
          enum:
          - "true"
        member_benefit_term_age:
          type: string
          description: Member benefit term age. Applicable for Hospital Indemnity (HIN). Values between '1' and '99'.
          example: "75"
        member_maximum_enrollment_age:
          type: string
          description: Member maximum enrollment age. Applicable for Hospital Indemnity (HIN). Values between '1' and '99'.
          example: "80"
        rider_included:
          type: string
          description: Indicates if the rider coverage also is included in the core coverage.
          enum:
          - "TRUE"
          - "FALSE"
        coverage_dependency:
          $ref: '#/components/schemas/PlanBenefit_coverage_dependency'
        coverage_parameters:
          type: array
          items:
            $ref: '#/components/schemas/CoverageParameter'
        dependent_child_age_limit:
          $ref: '#/components/schemas/PlanBenefit_dependent_child_age_limit'
        guarantee_issue:
          type: array
          items:
            $ref: '#/components/schemas/GuaranteeIssue'
        rates:
          type: array
          items:
            $ref: '#/components/schemas/Rate'
        disability_benefit:
          $ref: '#/components/schemas/PlanBenefit_disability_benefit'
        contribution_splits:
          type: array
          items:
            $ref: '#/components/schemas/ContributionSplit'
        waiting_period_rules:
          type: array
          items:
            $ref: '#/components/schemas/WaitingPeriodRule'
        termination_info:
          type: array
          items:
            $ref: '#/components/schemas/PlanBenefit_termination_info'
        benefit_earnings_definitions:
          type: array
          items:
            $ref: '#/components/schemas/BenefitEarningsDefinition'
        redetermination_type:
          type: string
          description: Refers when benefits with salary based volumes are recalculated in the system.
          example: IMMEDIATE
          enum:
          - IMMEDIATE
          - ANNIVERSARY
          - DATE
        redetermination_date:
          $ref: '#/components/schemas/PlanBenefit_redetermination_date'
        age_calculation_rule:
          type: string
          example: ACTUAL_AGE_AS_OF_ANNIVERSARY
          enum:
          - ACTUAL_AGE_AS_OF_ANNIVERSARY
          - ACTUAL_AGE_AS_OF_RENEWAL
          - ACTUAL_AGE_AS_OF_INSURANCE_AGE
          - ACTUAL_AGE_AS_OF_BIRTHDAY
          - ACTUAL_AGE_AS_OF_ON_1ST_DAY_OF_BIRTH_MONTH
          - ACTUAL_AGE_AS_OF_NEXT_DUE_DATE
          - ACTUAL_AGE_AS_OF_JANUARY
          - ACTUAL_AGE_AS_OF_FEBRUARY
          - ACTUAL_AGE_AS_OF_MARCH
          - ACTUAL_AGE_AS_OF_APRIL
          - ACTUAL_AGE_AS_OF_MAY
          - ACTUAL_AGE_AS_OF_JUNE
          - ACTUAL_AGE_AS_OF_JULY
          - ACTUAL_AGE_AS_OF_AUGUST
          - ACTUAL_AGE_AS_OF_SEPTEMBER
          - ACTUAL_AGE_AS_OF_OCTOBER
          - ACTUAL_AGE_AS_OF_NOVEMBER
          - ACTUAL_AGE_AS_OF_DECEMBER
          - ACTUAL_AGE_ON_GROUP_RECORD
          - ACTUAL_AGE_AS_OF_NEAREST_COMMON_ANNIVERSARY
          - ACTUAL_AGE_AS_OF_NEAREST_POLICY_ANNIVERSARY
          - ACTUAL_AGE_NEAREST_BIRTHDAY_AS_OF_MEMBER_ANNIVERSARY
          - TREAT_MEMBER_AND_SPOUSE_AS_ADULTS
          - ACTUAL_AGE_ON_BN_TO_DETERMINE_HOW_TO_TREAT_MEMBER_AND_SPOUSE
          - ACTUAL_YEAR_OF_BIRTH_SUBTRACTED_FROM_CURRENT_POLICY_ANNIVERSARY
          - ACTUAL_AGE_NEAREST_MEMBER'S_BIRTH_DATE
          - ACTUAL_AGE_BY_YEAR_OF_BIRTH_JAN_1_OF_RATING_YEAR
        age_reductions:
          type: array
          items:
            $ref: '#/components/schemas/AgeReduction'
        requires_eoi:
          type: string
          description: Indicates the carrier requires evidence of insurability for late entrants or increases in coverage for life and AD&D plans.
          enum:
          - "true"
        retroactive_termination_limit_months:
          type: string
          description: Up to 90 days based on coverages and contract.
        open_enrollments:
          type: array
          items:
            $ref: '#/components/schemas/OpenEnrollment'
        additional_benefits:
          $ref: '#/components/schemas/AdditionalBenefits'
    AssociatedClass:
      type: object
      properties:
        benefit_class_identifier:
          type: string
          description: "A carrier specific identifier of this eligibility group, intended for the BenAdmin to store and send back to the carrier with enrollment data."
          example: "0001"
    Deductible:
      type: object
      properties:
        coverage_tier:
          type: string
          description: Describes the level of coverage.
          example: INDIVIDUAL
          enum:
          - INDIVIDUAL
          - FAMILY
          - ORTHODONTIA
        deductible_period:
          type: string
          description: "Describes the amount associated with overall deductibles attached with the plan (Deductible) or deductibles that are met as of the request date (Met to date). Possible values - Deductible, Met-To-Date"
          example: Calendar year - 01/01
        orthodontia_code:
          type: string
          description: Orthodontia Code
          enum:
          - NONE
          - STANDARDORTHO
          - ADULTORTHO
        ortho_maximum:
          type: string
          description: Per individual orthodontia maximum for the lifetime of the plan. 
          example: "50.0"
        orthodontia_age_limit:
          type: string
          description: Ortho Age Lmt
        orthodontia_plan_type:
          type: string
          description: orthodontia_plan_type
        network_name:
          type: string
          description: "Name of the network, network names can change based on the benefit plan type e.g. if Alliance network names could be In-Network, Out-Network etc. If Tier, it could be Tier1, Tier2 etc.. Possible values - In-Network, Out-Network, Non-Participating DG Alliance, Tier1, Tier2, Tier3. For Vision, only Out-Network is applicable."
          example: In-Network
        service_name:
          type: string
          description: Vision service names. Not applicable for Dental or other coverages.
          enum:
          - EXAM
          - SINGLE_VISION_LENS
          - BIFOCAL_LENS
          - TRIFOCAL_LENS
          - LENTICULAR_LENS
          - FRAMES
          - ELECTIVE_CONTACT_LENSES
          - NECESSARY_CONTACT_LENSES
        amount:
          type: string
          description: Amount associated with Guardian Network. In case of family deductibles this refers to total combined amount or 3 per family.
          example: "500.0"
        life_time_maximum_amount:
          type: string
          description: Life time maximum amount. Only for dental.
          example: "1000.0"
        orthodontia_lifetime_max:
          type: string
          description: Overall orthodontia life time maximum for plan.
          example: "80.0"
        maximum_benefit_amount:
          type: string
          description: Maximum benefit amount
          example: "1000.0"
        maximum_period:
          type: string
          description: Maximum period in months.
          example: "10"
        individual_diminishing_deductible:
          $ref: '#/components/schemas/Deductible_individual_diminishing_deductible'
    Coinsurance:
      type: object
      properties:
        network_name:
          type: string
          description: Name of the network.
          example: IN
          enum:
          - IN
          - OUT
        service_name:
          type: string
          description: Dental service names. Not applicable for Vision.
          example: PREVENTIVE
          enum:
          - PREVENTIVE
          - BASIC
          - MAJOR
          - ORTHODONTIA
        percent:
          type: string
          description: Coinsurance percentage.
          example: "100"
        deductible_waived_in:
          type: string
          description: Deductible waived indicator.
          example: "YES"
          enum:
          - "YES"
          - "NO"
    Copay:
      type: object
      properties:
        network_name:
          type: string
          description: Name of the network.
          example: IN
          enum:
          - IN
          - OUT
        service_name:
          type: string
          description: Dental service names. Not applicable for Vision.
          example: PREVENTIVE
          enum:
          - EXAM
          - LENSES
          - FRAMES
          - ELECTIVE_CONTACT_LENSES
          - NECESSARY_CONTACT_LENSES
        amount:
          type: string
          description: Copay amount
          example: $10000
        co_payment_code:
          type: string
          example: GUARDIAN
          enum:
          - GUARDIAN
          - MEMBER
        exam_payment_rate:
          type: string
          description: Exam payment rate percentage.
          example: "100"
        exam_frequency_maximum_period:
          type: string
          description: Exam frequency maximum period in months. Between 0 and 99.
          example: "50"
        exam_maximum_amount:
          type: string
          description: Exam maximum amount.
          example: $5000
    CoverageParameter:
      type: object
      properties:
        dependent_type:
          type: string
          description: Indicates the type of dependent.
          enum:
          - SPOUSE
          - CHILD
          - FULLTIME_STUDENT
        insurance_parameters:
          type: array
          items:
            $ref: '#/components/schemas/InsuranceParameter'
    InsuranceParameter:
      type: object
      properties:
        plan_identifier:
          type: string
          description: Unique plan identifier when there are multiple occurences.
          example: A
        dollar_amount:
          type: string
          description: "The flat dollar amount of coverage provided by the base plan. Requirements- optional for the InsuranceParameter describing base plan coverage; not populated for buyup. One of (DollarAmount, MultipleOfEarnings) must be populated for base coverage."
          example: FLAT
        multiple_of_earnings:
          type: string
          description: "The flat multiple of earnings coverage provided by the base plan. Requirements- optional for the InsuranceParameter describing base plan coverage; not populated for buyup. One of (DollarAmount, MultipleOfEarnings) must be populated for base coverage."
          example: 60%
        percent_of_member:
          type: string
          description: Percent of member salary. This field is only applicable for child and spouse coverages.
        dollar_flat:
          type: string
          description: Flat dollar amount.
          example: "1000"
        dollar_minimum:
          type: string
          description: "The lower bound of the flat dollar range of buyup coverage. Requirements- optional for buyup coverage, not populated for base coverage. One of (DollarMinimum, MultipleOfEarningsMinimum) must be populated for buyup coverage. If DollarMinimum is populated, DollarMaximum and DollarIncrement must also be populated."
          example: "1000"
        dollar_maximum:
          type: string
          description: "The upper bound of the flat dollar range of buyup coverage. Requirements- optional for buyup coverage, not populated for base coverage. One of (DollarMaximum, MultipleOfEarningsMaximum) must be populated for buyup coverage. If DollarMaximum is populated, either (DollarMinimm and DollarIncrement) or (MultipleOfEarningsMinimum, MultipleOfEarningsMaximum, and MultipleOfEarningsIncrement) must be populated."
          example: "5000"
        dollar_increment:
          type: string
          description: "The flat dollar increment of buyup coverage providing distinct coverage options between DollarMinimum and DollarMaximum. Requirements- optional for buyup coverage, not populated for base coverage. One of (DollarIncrement, MultipleOfEarningsIncrement) must be populated for buyup coverage. If DollarIncrement is populated, DollarMinimum and DollarMaximum must also be populated."
          example: "100"
        multiple_of_earnings_minimum:
          type: string
          description: "The lower bound of the earnings range of buyup coverage. Requirements- optional for buyup coverage, not populated for base coverage. One of (MultipleOfEarningsMinimum, DollarMinimum) must be populated for buyup coverage. If MultipleOfEarningsMinimum is populated, MultipleOfEarningsMaximum and MultipleOfEarningsIncrement must also be populated."
          example: "1000"
        multiple_of_earnings_maximum:
          type: string
          description: "The upper bound of the earnings range of buyup coverage. Requirements- optional for buyup coverage, not populated for base coverage. One of (DollarMaximum, MultipleOfEarningsMaximum) must be populated for buyup coverage. If MultipleOfEarningsMaximum is populated, MultipleOfEarningsMinimum and MultipleOfEarningsIncrement must also be populated."
          example: "5000"
        multiple_of_earnings_increment:
          type: string
          description: "The earrnings increment of buyup coverage providing distinct coverage options between MultipleOfEarningsMinimum and MultipleOfEarningsMaximum. Requirements- optional for buyup coverage, not populated for base coverage. One of (DollarIncrement, MultipleOfEarningsIncrement) must be populated for buyup coverage. If MultipleOfEarningsIncrement is populated, MultipleOfEarningsMinimum and DollarMaximum must also be populated."
        modifying_code:
          type: string
          description: Modifying Code.
          example: PLUS
          enum:
          - PLUS
          - MINUS
        modifying_amount:
          type: string
          description: Modifying Amount.
          example: "1.0"
        rounding_rule:
          type: string
          description: Describes how to round the total elected coverage amount for life and disability benefits
          example: NEAREST_1_DOLLAR
          enum:
          - NEAREST_1_DOLLAR
          - NEAREST_10_DOLLARS
          - NEAREST_100_DOLLARS
          - NEAREST_500_DOLLARS
          - NEAREST_1000_DOLLARS
          - NEAREST_5000_DOLLARS
          - NEAREST_10000_DOLLARS
          - NEXT_HIGHER_1_DOLLAR
          - NEXT_HIGHER_10_DOLLARS
          - NEXT_HIGHER_100_DOLLARS
          - NEXT_HIGHER_500_DOLLARS
          - NEXT_HIGHER_1000_DOLLARS
          - NEXT_HIGHER_5000_DOLLARS
          - NEXT_HIGHER_10000_DOLLARS
          - NEXT_LOWER_1_DOLLAR
          - NEXT_LOWER_10_DOLLARS
          - NEXT_LOWER_100_DOLLARS
          - NEXT_LOWER_500_DOLLARS
          - NEXT_LOWER_1000_DOLLARS
          - NEXT_LOWER_5000_DOLLARS
          - NEXT_LOWER_10000_DOLLARS
        covered_payroll_minimum:
          type: string
          description: Covered payroll minimum amount.
          example: "65.1"
        covered_payroll_maximum:
          type: string
          description: Covered payroll maximum amount.
          example: "70.15"
        begin_age:
          type: string
          description: Begin age for pay out amount. Applicable only for CHILD or FULLTIME-STUDENT dependent_type.
          example: "1"
        begin_age_period:
          type: string
          description: Indicates the period type for value found in begin_age.
          example: DAYS
          enum:
          - DAYS
          - MONTHS
          - YEARS
        end_age:
          type: string
          description: End age for pay out amount. Applicable only for CHILD or FULLTIME-STUDENT dependent_type
          example: "16"
        end_age_period:
          type: string
          description: Indicates the period type for value found in end_age.
          example: DAYS
          enum:
          - DAYS
          - MONTHS
          - YEARS
    GuaranteeIssue:
      type: object
      properties:
        age_limit:
          type: string
          description: Evidence of insurability age limit.
          example: "65"
        guarantee_issue_type:
          type: string
          description: Describes the guarantee issue rule. Requirements- if type is FLAT_DOLLAR or LESSER_OF_MULTIPLE_AND_DOLLAR then GuaranteeIssueDollarAmount is populated with the dollar amount to be considered; if type is MULTIPLE_OF_EARNINGS or LESSER_OF_MULTIPLE_AND_FLAT then GuaranteeIssueMultipleOfEarnings is populated with the multiple of earnings to be considered.
          example: DOLLAR_AMOUNT
          enum:
          - DOLLAR_AMOUNT
          - MULTIPLE_OF_EARNINGS
          - LESSER_OF_MULTIPLE_AND_DOLLAR
          - ALL_AMTS_IN_EXCESS_OF_FIXED_AMT
          - ALL_AMOUNTS
          - ELECTION_OF_HIGHER_LEVEL_OF_COVG
          - LATE_ENTRANT
          - PLAN_INCREASE
          - OTHER
        guarantee_issue_dollar_amount:
          type: string
          description: Requirements-required when GuaranteeIssueType is FLAT_DOLLAR or LESSER_OF_MULTIPLE_AND_DOLLAR; not populated otherwise.
          example: "100"
        guarantee_issue_multiple_of_earnings:
          type: string
          description: Requirements- required whern GuaranteeIssueType is MULTIPLE_OF_EARNINGS or LESSER_OF_MULTIPLE_AND_DOLLAR
          example: "100"
        over_guarantee_issue_type:
          type: string
          description: "issue request is approved. The carrier can approve the exact dollar amount over guarantee issue, meaning if the employee's salary increases from a multiple of earnings election, their approved coverage does not increase unless a separate EOI is approved. Or the carrier can approve \"total elected coverage\", meaning the carrier approves the multiple of earnings election, so if the employee's salary increases, their coverage amount also increases without needing separate EOI approval."
          example: CARRIER_APPROVES_DOLLAR_AMOUNT
          enum:
          - CARRIER_APPROVES_DOLLAR_AMOUNT
          - CARRIER_APPROVES_TOTAL_ELECTED_COVERAGE
        conditional_amount:
          type: string
          description: "When Conditional Issue sold, Employee Conditional non-medical amount is returned here."
          example: "50"
        additional_amount:
          type: string
          description: When Guarantee Issue with the additional amount is sold employee Additional Amount is returned here.
          example: "50"
    Rate:
      type: object
      properties:
        differentiators:
          type: array
          items:
            $ref: '#/components/schemas/Differentiator'
        rate_amount:
          type: string
          description: The amount of the rate.
          example: "15.00"
        renewal_rate_amount:
          type: string
          description: Renewal rate amount. This field is only applicable if there are renewal rates.
          example: "15.00"
        renewal_rate_effective_date:
          type: string
          description: Renewal effective date. This field is only applicable if renewal_rate_amount has a valid value.
          example: 01/01/2020
        renewal_rate_status:
          type: string
          description: Renewal rate status.
          example: Appeal With no Action
        rate_paid_by_employee:
          type: string
          description: The amount of the rate that should be paid by the employee. This field is only displayed for Dental and Vision coverage.
          example: "15.00"
        rate_paid_by_employer:
          type: string
          description: The amount of the rate that should be paid by the employer. This field is only displayed for Dental and Vision coverage.
          example: "0"
        rate_unit_type:
          type: string
          description: "Describes the units of this rate. Requirements- this is DOLLARS for flat rates (e.g., differentiator type of NONE). PERCENTAGE_OF_SALARY is applicable for retirement plans where the employee contributes a given percentage. The other unit types are applicable for life and disa"
          example: DOLLARS
          enum:
          - DOLLARS
          - VOLUME_PER_1000
          - VOLUME_PER_100
          - VOLUME_PER_10
    Differentiator:
      type: object
      properties:
        rate_design:
          type: string
          description: Rate design
          example: MULTI_TIERED
          enum:
          - MEMBER_ONLY
          - COMPOSITE
          - MULTI_TIERED
          - COUNTED_ROSTERED
          - COUNTED_ROSTERED_2
          - SPOUSE_ONLY
          - DEPENDENTS_ONLY
          - CHILD_ONLY
          - EMPLOYEE_FAMILY
          - COMPOSITE_EMPLOYEE_FAMILY
          - CHILD_ONLY_COUNTED
          - SUPPLEMENTAL_FAMILY
          - ACCUMULATED_FAMILY_COUNTED
          - SUPPLEMENTAL_ADULT_CHILD
          - SUPPLEMENTAL_FAMILY_COUNTED
          - ADULT_CHILD_COUNTED
          - SUPPLEMENTAL_RATE_AGE
          - EMPLOYEE_+1DEP_+2DEP_+3DEP_+4DEP_FAM
          - NO_WAIVER
          - WAIVER_TO_67
          - LIFEASSIST_TO_67
        rate_differentiator_type:
          type: array
          items:
            $ref: '#/components/schemas/RateDifferentiator'
        range_lower_bound:
          type: string
          description: Describes the lower age range for the differentiator.
          example: "15"
        range_upper_bound:
          type: string
          description: Describes the upper age range for the differentiator.
          example: "99"
        coverage_tier:
          type: string
          description: Describes the coverage tier that the rate differentiator belongs to.
          example: EMPLOYEE
        tobacco_user:
          type: string
          description: Indicates if the rates is based on tobacco users.
          example: BOTH_MEMBER_AND_SPOUSE_STANDARD
          enum:
          - BOTH_MEMBER_AND_SPOUSE_STANDARD
          - MEMBER_AND_SPOUSE_PREFERRED
          - MEMBER_STANDARD
          - SPOUSE_PREFERRED
          - MEMBER_PREFERRED
          - SPOUSE_STANDARD
          - STANDARD_SMOKER_GPL
          - PREMIUM_NON_SMOKER_GPL
        gender:
          type: string
          description: Indicates if the rates is based on gender.
          example: MALE_RATES
          enum:
          - MALE_RATES
          - FEMALE_RATES
        age_basis:
          type: string
          description: Describes if the rate is based on an age basis.
          example: EMPLOYEE
          enum:
          - EMPLOYEE
          - SPOUSE
    RateDifferentiator:
      type: object
      properties:
        rate_differentiator_type:
          type: string
          description: "Enumeration describing the type of rate differentiation. Possible values are COVERAGE LEVEL, AGE RANGE,TOBACCO USER, GENDER with a suffix of AGGREGATE or blanks."
          example: Coverage level
          enum:
          - COVERAGE_LEVEL
          - AGE_RANGE
          - GENDER
          - TOBACCO_USER
          - ISSUE_AGE
          - ATTAINED_AGE
          - COVERAGE_LEVEL_AGGREGATE
          - AGE_RANGE_AGGREGATE
          - GENDER_AGGREGATE
          - TOBACCO_USER_AGGREGATE
          - ISSUE_AGE_AGGREGATE
          - ATTAINED_AGE_AGGREGATE
          - RIDER
    disabilityBenefit_limitations:
      type: object
      properties:
        special_limitations:
          type: string
          description: Describes special limitations for certain benefits
          example: SPECIAL_CONDITIONS_LIMITATIONS
          enum:
          - SPECIAL_CONDITIONS_LIMITATIONS
          - MENTAL_ILLNESS
          - DRUG
          - ALCOHOL
        type:
          type: string
          description: Describes if the disability benefit is paid individual or jointly.
          example: PAYMENT_LIMITS_NOT_APPLIED_JOINTLY
          enum:
          - PAYMENT_LIMITS_NOT_APPLIED_JOINTLY
          - AS_ANY_OTHER_ILLNESS
          - LEGISLATIVE
          - PAYMENT_LIMITS_APPLIED_JOINTLY
          - SUBJECTIVE_DISORDER_COMBINED_LIMITS
          - NONE
          - DISABILITY_THIRTY_DAY_RECONFINE
          - PAYMENT_NO_RECONFINE
          - PAYMENT_LIMITS_APPLY_JOINTLY
          - DISABILITY_APPLY_JOINTLY
        months:
          type: string
          description: Number of months the benefit is avialable.
          example: "10"
    disabilityBenefit_ltd_riders:
      type: object
      properties:
        rider:
          type: string
          description: Type of rider available.
          example: PROGRESSIVE_ILLNESS_PROTECTION
          enum:
          - PROGRESSIVE_ILLNESS_PROTECTION
          - PRIOR_COMPENSATION_EXEMPTION
          - SCHEDULED_CONTRACT_EMPLOYEE_PAYMENT
          - RETROACTIVE_PAYMENT
          - LOAN_PAYMENT_PROTECTION
        rider_guidelines:
          $ref: '#/components/schemas/disabilityBenefit_ltd_riders_rider_guidelines'
    ContributionSplit:
      type: object
      properties:
        contributor_type:
          type: string
          description: Contribution code for the coverage. If N displays the employee is required to have the coverage. If C or V the employee has the option to elect the coverage.
          example: Employee Voluntary
        percentage_of_contribution:
          type: string
          description: Percentage amount the employer is contributing towards the coverage. Requirements - either DollarAmountContribution or PercentageOfContribution may be populated but never both.
          example: Mem 100.00 percent
    WaitingPeriodRule:
      type: object
      properties:
        waiting_period_type:
          type: string
          description: "Displays if the group has no waiting period, first of the month waiting period, etc."
          example: FUTURE
          enum:
          - NEW_HIRE
          - WORK_EVENT
          - REHIRE
          - PRESENT
          - FUTURE
          - SPECIAL
        waiting_period_rule_type:
          type: string
          example: HIRE_DATE
          enum:
          - HIRE_DATE
          - FIRST_OF_MONTH_AFTER_X_MONTHS
          - FIRST_OF_MONTH_AFTER_X_DAYS
          - AFTER_X_MONTHS
          - AFTER_X_DAYS
          - FIRST_OF_MONTH_AFTER_EVENT
          - FIRST_PAY_PERIOD_AFTER_X_DAYS
          - OTHER
          - FIRST_OF_MONTH_AFTER_X_WEEKS
          - FIRST_OF_MONTH_AFTER_X_YEARS
          - FIRST_OF_MONTH_AFTER_DATE_OF_HIRE
          - FIFTEENTH_OF_MONTH_AFTER_X_DAYS
          - FIFTEENTH_OF_MONTH_AFTER_X_WEEKS
          - FIFTEENTH_OF_MONTH_AFTER_X_MONTHS
          - FIFTEENTH_OF_MONTH_AFTER_X_YEARS
          - FIFTEENTH_OF_THE_MONTH_AFTER_DATE_OF_HIRE
          - AFTER_X_WEEKS
          - AFTER_X_YEARS
        num_days:
          type: string
          description: "Required when WaitingPeriodRuleType is FIRST_OF_MONTH_AFTER_X_DAYS, AFTER_X_DAYS, FIRST_PAY_PERIOD_AFTER_X_DAYS or FIFTEENTH_OF_MONTH_AFTER_X_DAYS. Not populated otherwise"
          example: FIRST_OF_MONTH_AFTER_X_DAYS
        num_weeks:
          type: string
          description: "Required when WaitingPeriodRuleType is FIRST_OF_MONTH_AFTER_X_WEEKS, AFTER_X_WEEKS,  FIRST_PAY_PERIOD_AFTER_X_WEEKS, FIRST_OF_MONTH_AFTER_X_WEEKS, FIFTEENTH_OF_MONTH_AFTER_X_WEEKS or AFTER_X_WEEKS. Not populated otherwise"
          example: FIRST_OF_MONTH_AFTER_X_WEEKS
        num_months:
          type: string
          description: "Required when WaitingPeriodRuleType is FIRST_OF_MONTH_AFTER_X_MONTHS, AFTER_X_MONTHS or FIFTEENTH_OF_MONTH_AFTER_X_MONTHS . Not populated otherwise."
          example: FIRST_OF_MONTH_AFTER_X_MONTHS
        num_years:
          type: string
          description: "Required when WaitingPeriodRuleType is FIRST_OF_MONTH_AFTER_X_YEARS, AFTER_X_YEARS or FIFTEENTH_OF_MONTH_AFTER_X_YEARS. Not populated otherwise."
          example: FIRST_OF_MONTH_AFTER_X_YEARS
      description: waiting period
    BenefitEarningsDefinition:
      type: object
      properties:
        benefit_earnings_type:
          type: string
          description: Indicates the type of earnings for salary benefit plans.
          enum:
          - BASE_SALARY
          - BASE_SALARY_BONUS
          - BASE_SALARY_COMMISSION
          - BASE_SALARY_BONUS_COMMISSION
          - W2
          - CUSTOM
        description:
          type: string
          description: Describes the type of earnings for salary benefit plans.
    AgeReduction:
      type: object
      properties:
        age_threshold:
          type: string
          description: Describes the age a salary benefit will be cutback.
        percentage_reduction:
          type: string
          description: Describes the percentage of the salary benefit once the age has been reached.
    OpenEnrollment:
      type: object
      properties:
        open_enrollment_method:
          type: string
          description: Indicates if the enrollment method is standard or special
          example: STANDARD
          enum:
          - STANDARD
          - SPECIAL
        open_enrollment_type:
          type: string
          description: Displays if this is a Section 125 plan or not
          example: SECTION_125
          enum:
          - SECTION_125
          - ONE_TIME_OPEN_ENROLLMENT
          - ANNUAL_ENROLLMENT
          - ANNUAL_WITH_AGE_70_HLTH_QUESTIONS
          - ANNUAL_WITHOUT_AGE_70_HLTH_QUESTIONS
          - BUY-UP_DUAL-OPTION_WITH_OR_WITHOUT_SECTION_125
          - BENEFITS_MATCH_ENROLL_TIED_TO_MEMBER_OPTIONAL_LIFE
          - BENEFITS_MATCH_ENROLL_NOT_TIED_TO_MEMBER_OPTIONAL_LIFE
          - ANNUAL_RE_ENROLLMENT
          - ANNUAL_INCREASE
          - ANNUAL_RE_ENROLLMENT_GI
          - ANNUAL_RE_ENROLLMENT_STEPS
        open_enrollment_from_date:
          type: string
          description: Open enrollment start date
          example: 08/01
        open_enrollment_to_date:
          type: string
          description: Open enrollment end date
          example: 08/31
        transfer_date:
          type: string
          description: When coverage will be effective during Open enrollment.
          example: 09/01
    AdditionalBenefits:
      type: object
      properties:
        hospital_benefit_type:
          type: array
          items:
            $ref: '#/components/schemas/HospitalBenefits'
        pre_existing_code:
          $ref: '#/components/schemas/AdditionalBenefits_pre_existing_code'
        portability:
          $ref: '#/components/schemas/AdditionalBenefits_portability'
        cancer_included:
          type: string
          description: Whether cancer included.
          enum:
          - "TRUE"
          - "FALSE"
        critical_illness_benefit:
          type: array
          items:
            $ref: '#/components/schemas/CriticalIllnessBenefits'
        accident_benefit:
          $ref: '#/components/schemas/AdditionalBenefits_accident_benefit'
        well-being:
          $ref: '#/components/schemas/AdditionalBenefits_wellbeing'
        dental_benefit:
          type: array
          items:
            $ref: '#/components/schemas/DentalBenefits'
        vision_benefit:
          type: array
          items:
            $ref: '#/components/schemas/VisionBenefit'
        life_benefit:
            $ref: '#/components/schemas/AdditionalBenefitsLifeBenfit'
    AdditionalBenefitsForDisabilityBenefit:
      type: object
      properties:
        
        lookback:
          type: string
          example: "3"
        limiting_period:
          type: string
          example: "12"
        treatment_free:
          type: string
          example: "21"
        pre_existing_limitation:
          type: string
          example: WAIVED
          enum:
          - WAIVED
          - SIX_MONTHS_RUNNING
          - EXCLUSION
          - LIMITATION
    HospitalBenefits:
      type: object
      properties:
        benefit_type:
          type: string
          description: Benefit Type.
          example: HOSPITAL_CONFINEMENT
          enum:
          - HOSPITAL_ADMISSION
          - HOSPITAL_CONFINEMENT
          - ICU_HOSPITAL_ADMISSION_COMBINED
          - ICU_HOSPITAL_CONFINEMENT_COMBINED
          - AMBULANCE_GROUND
          - AMBULANCE_AIR_GROUND_COMBINED
          - EMERGENCY_ROOM
          - URGENT_CARE_FACILITY
          - INPATIENT_SURGICAL
          - OUTPATIENT_SURGICAL_CATEGORY_ONE
          - OUTPATIENT_SURGICAL_CATEGORY_TWO_AND_ONE_COMBINED
          - PRESCRIPTION_DRUGS
          - REHAB_UNIT_CONFINEMENT
          - HOME_HEALTH_CARE
          - HOSPICE_CARE
          - DOCTORS_VISITS
          - DIAGNOSTIC_TESTS
          - OUTPATIENT_THERAPY
          - TRANSPORTATION
          - LODGING
          - HEALTH_SCREENINGS
        amount:
          type: string
          description: Amount
          example: "10000"
        limits:
          type: array
          items:
            $ref: '#/components/schemas/Limits'
    Limits:
      type: object
      properties:
        limit_type:
          type: string
          enum:
          - INDIVIDUAL_DAYS_PER_YEAR
          - FAMILY_DAYS_PER_YEAR
          - DAYS_PER_YEAR
          - DAYS_PER_LIFE_TIME
        limit:
          type: string
          description: Limit value.
          example: "5"
    CriticalIllnessBenefits:
      type: object
      properties:
        illness_type:
          type: string
          description: Benefit Type.
          example: HEART_ATTACK
          enum:
          - HEART_ATTACK
          - STROKE
          - ARTERIOSCLEROSIS
          - ORGAN_FAILURE
          - KIDNEY_FAILURE
          - HEART_FAILURE
          - SUDDEN_CARDIAC_ARREST
        covered_conditions:
          type: array
          items:
            $ref: '#/components/schemas/CoveredConditions'
    CoveredConditions:
      type: object
      properties:
        occurrence:
          type: string
          description: Occurrence
          enum:
          - FIRST
          - SECOND
        percentage:
          type: string
          description: Percentage
          example: "100"
    DentalBenefits:
      type: object
      properties:
        service:
          type: array
          items:
            $ref: '#/components/schemas/DentalBenefit_Service'
        treatments:
          type: array
          items:
            $ref: '#/components/schemas/DentalBenefit_Treaments'
    DentalBenefit_Service:
      type: object
      properties:
        service_options:
          type: string
          description: Type of service 
          example: RADIOGRAPHS
          enum:
          - RADIOGRAPHS
          - RE_CEMENT_SPACE_MAINT_AND_SPACE_MAINT_AND_HARMFUL_HABITS
          - ORAL_SURGERY_EXCEPT_SIMPLE_EXTRACTIONS
          - GINGIVAL_CURETTAGE_OTHER_PERIODONTAL_SERVICES
          - PERIODONTAL_SURGERY
          - SEALANTS
          - INLAYS_AND_ONLAYS_AND_VENEERS_AND_POST_AND_CORES_AND_CORE_BUILD_UPS
          - SINGLE_CROWNS
          - SURGICAL_EXTRACTIONS_AND_OTHER_ORAL_SURGERY
          - NON_SURGICAL_EXTRACTIONS_ONLY
          - ENDODONTIC_SERVICES
          - MOLAR_ROOT_CANAL
          - REPAIRS_AND_MAINT
          - X_RAYS_OTHER_THAN_BITEWINGS
          - ANESTHESIA
          - ENDODONTIC
        service_type:
          type: string
          description: Displays if the service is considered basic, preventative, or major. 
          example: BASIC
          enum:
          - BASIC
          - MAJOR
          - PREVENTIVE
    DentalBenefit_Treaments:
      type: object
      properties:
        treatment_options:
          type: string
          description: Type of treatment
          example: ORAL_EXAM
          enum:
          - ORAL_EXAM
          - FLUORIDE
          - PANORAMIC_OR_FULL_MOUTH_X_RAY
          - SEALANT
          - PROPHYLAXES
          - PERIODONTAL_PROPHYLAXES
          - BITEWING_X_RAYS
          - AMALGAM_COMPOSITE_RESTORATIONS
          - BRIDGE
          - CROWNS
          - DENTURE_AND_APPLIANCES
          - IMPLANTS
          - COMPOSITE_COVERAGE
          - SPACE_MAINTAINER
          - TMJ
          - COVER_HIGH_NOBLE_METAL_CROWNS_AND_BRIDGES
          - PORCELAIN_OR_CERAMIC_CROWNS_COVERED_ALL_TEETH
        code:
          type: string
          description: Sealant coverage options
          example: EXCLUDE_SEALANTS
          enum:
          - EXCLUDE_SEALANTS
          - UNRESTORED_PERMANENT_MOLARS
          - SEALANTS_COVERED_ON_ALL_UNRESTORED_PERMANENT_TEETH_NOT_JUST_MOLARS
          - SEALANTS_COVERED_ON_ALL_UNRESTORED_TEETH_INCLUDING_DECIDUOUS
          - SEALANTS_COVERED_ON_ALL_UNRESTORED_DECIDUOUS_TEETH_IN_ADDITION_TO_PERMANENT_MOLARS
          - SEALANTS_COVERED_ON_PERMANENT_UNRESTORED_BICUSPIDS_IN_ADDITION_TO_PERMANENT_MOLARS
          - SEALANTS_COVERED_ON_PRIMARY_UNRESTORED_MOLARS_IN_ADDITION_TO_PERMANENT_MOLARS
          - SEALANTS_COVERED_ON_RESTORED_OR_UNRESTORED_PRIMARY_AND_PERMANENT_BICUSPIDS_AND_MOLARS
          - AMALGAM_BENEFIT_APPLIES_FOR_POSTERIOR_COMPOSITES
          - COMPOSITES_COVERED_ON_ALL_TEETH_NOT_JUST_LIMITED_TO_ANTERIOR_TEETH
          - COMPOSITES_COVERED_BASED_ON_SURFACES_SUBMITTED_NOT_DOWN_CODED_TO_ONE_SURFACE_BENEFIT
          - COMPOSITES_COVERED_ON_ALL_TEETH_NOT_JUST_LIMITED_TO_ANTERIOR_TEETH_AND_COMPOSITES_COVERED_BASED_ON_SURFACES_SUBMITTED_NOT_DOWN_CODED_TO_ONE_SURFACE_BENEFIT
          - COMPOSITES_COVERED_ON_ALL_TEETH_NOT_JUST_LIMITED_TO_ANTERIOR_TEETH_AND_COMPOSITES_COVERED_BASED_ON_SURFACES_SUBMITTED_NOT_DOWN_CODED_TO_ONE_SURFACE_BENEFIT_POSTERIOR_COMPOSITES_BASIC
          - COMPOSITES_COVERED_ON_ALL_TEETH_NOT_JUST_LIMITED_TO_ANTERIOR_TEETH_AND_COMPOSITES_COVERED_BASED_ON_SURFACES_SUBMITTED_NOT_DOWN_CODED_TO_ONE_SURFACE_BENEFIT_POSTERIOR_COMPOSITES_MAJOR
        age_limit:
          type: string
          description: Age limit for treatment.
          example: "35"
        times:
          type: string
          description: Number of times the treatment can be used in a period of months or years displayed below. 
          example: "35"
        months:
          type: string
          description: Number of months for the treatment.
          example: "10"
        year:
          type: string
          description: Number of years for the treatment.
          example: "35"
    VisionBenefit:
      type: object
      properties:
        benefit_riders:
          type: array
          description: Type of benefit rider available.
          items:
            $ref: '#/components/schemas/VisionBenefit_BenefitRiders'
        lens_options:
          type: array
          description: Displays the lens options available. 
          items:
            $ref: '#/components/schemas/VisionBenefit_LenOptions'
    AdditionalBenefitsLifeBenfit:
      type: object
      properties:
        waiver_of_premium:
          $ref: '#/components/schemas/AdditionalBenefitsLifeBenfit_waiver_of_premium'
        accelerated_life_benefit:
          $ref: '#/components/schemas/AdditionalBenefitsLifeBenfit_accelerated_life_benefit'
    WaiverOfPremium:
      type: object
      properties:
        type:
          type: string
          description: Displays to what age the waiver of premium is available
          example: NO_WAIVER
          enum:
          - NO_WAIVER
          - WAIVED_TO_SPECIFIC_AGE
          - WAIVER_OF_PREMIUM_WITH_LIFETIME_FEATURE
          - LIFEASSIST_TO_AGE_SIXTYFIVE
          - LIFEASSIST_OR_LIFETIME
          - SSNRA
          - SSNRA_LIFEASSIST
          - LIFEASSIST_TO_AGE_SEVENTY
        months:
          type: string
          description: Elimination period months. 
          example: "11"
        age_limit:
          type: string
          description: Waiver of premium age limit,
          example: "11"
    AcceleratedLifeBenefit:
      type: object
      properties:
        code:
          type: string
          description: Who pays the processing fee.
          example: EMPLOYEE_PAYING_PROCESSING_FEE
          enum:
          - EMPLOYEE_PAYING_PROCESSING_FEE
          - EMPLOYER_PAYING_PROCESSING_FEE
        processing_fee:
          type: string
          description: Processing fee amount
          example: "150.0"
        min_base_percentage:
          type: string
          description: Minimum base percentage of benefit.
          example: "0.8"
        min_base_amount:
          type: string
          description: Minimum base amount of benefit.
          example: "10000"
        term_illness_months:
          type: string
          description: Terminal illness timeframe. 
          example: "12"
        max_base_percentage:
          type: string
          description: Maximum percentage of benefit.
          example: "0.9"
        max_base_amount:
          type: string
          description: Maximum base amount of benefit
          example: "20000"
    VisionBenefit_BenefitRiders:
      type: object
      properties:
        benefit_riders:
          type: string
          example: SECOND_PAIR_COV
          enum:
          - SECOND_PAIR_COV
          - COV_CONTACT_LENS
          - SAFETY_EYECARE
          - PRIMARY_EYECARE
          - INTERIM_BEN_OPT
          - RETAIL_CHAIN_PROV
          - DIABETIC_EYECARE
          - FITTING_AND_EVAL
          - GLASSES_AND_CONTACTS
          - HEARING_BENEFIT
          - LASER_SURGERY_$300
          - LASER_SURGERY_$600
    VisionBenefit_LenOptions:
      type: object
      properties:
        len_option:
          type: string
          example: PROGRESSIVE_LENS
          enum:
          - PROGRESSIVE_LENS
          - ANTI_REFLECT_COATING
          - POLYCARB_LENS
          - TINTING
          - UV
          - EDGE_TREATMENT
          - BLENDED
          - SCRATCH_RESISTANT_COATING
          - HIGH_INDEX
          - MIRROR_OR_SKI_COATING
          - OVERSIZED
          - POLARIZED_OR_LAMINATED
          - LENS_OPTION_PACKAGE
          - TRANSITION
    Attachment:
      type: object
      properties:
        Name:
          type: string
        Format:
          $ref: '#/components/schemas/Attachment_Format'
        Type:
          type: string
        Data:
          type: string
          format: byte
        Coverages:
          type: array
          items:
            type: string
    DocumentFormat:
      type: string
      enum:
      - PDF
      - DOC
      - DOCX
      - TXT
      - XLS
      - XLSX
      - XLSB
      - RNWL
      - TIF
    Audit:
      type: object
      properties:
        audit_ID:
          type: string
          description: Unique identifier created by the originator for this instance of the electronic transmission.
          example: 030c89b1-8732-492b-b69a-2239e14264e5
        employer_record_quantity:
          type: integer
          description: A count of Employer records included in the electronic transmission.
          format: int32
          example: 1
        employee_record_quantity:
          type: integer
          description: A count of Employee records included in the electronic transmission.
          format: int32
          example: 0
        dependent_record_quantity:
          type: integer
          description: A count of Dependent records included in the electronic transmission.
          format: int32
          example: 0
        other_party_record_quantity:
          type: integer
          description: A count of Other Party records included in the electronic transmission.
          example: 0
        beneficiary_group_record_quantity:
          type: integer
          description: A count of Beneficiary Group records included in the electronic transmission.
          example: 0
        event_record_quantity:
          type: integer
          description: A count of Event records included in the electronic transmission.
          example: 1
        coverage_record_quantity:
          type: integer
          description: A count of Coverage records included in the electronic transmission.
          format: int32
          example: 2
        coverage_rider_record_quantity:
          type: integer
          description: A count of Coverage Rider records included in the electronic transmission.
          format: int32
          example: 0
      description: An instance of auditable information provided to ensure accuracy and consistency of the exchanged information.
    ErrorResponse:
      title: ErrorResponse
      type: object
      properties:
        corelation_id:
          type: string
          description: Id to trace the request of the message
          example: 030c89b1-8732-492b-b69a-2239e14264e5
        code:
          type: string
          description: "High level error code. The first 6 position indicates the API provider like POLICY and the next 4 position indicates the type of error. If the API is returning a 400 type of error (data error) and API provider identifier is POLICY (For POLICY API) the error code should be returned as POLICY4000, POLICY4001, etc."
          example: POLICY4001
        message:
          type: string
          description: High level Error description.
        more_info:
          type: array
          items:
            $ref: '#/components/schemas/ErrorDetails'
    ErrorDetails:
      type: object
      properties:
        code:
          type: string
          description: "Low level error code. The first 6 position indicates the API provider like POLICY and the next 4 position indicates the type of error. If the API is returning a 400 type of error (data error) and API provider identifier is POLICY (For POLICY API) the error code should be returned as POLICY4000, POLICY4002, etc."
          example: POLICY4002
        field:
          type: string
          description: Indicates the field name(input) that caused the error
          example: group_id
        message:
          type: string
          description: Specific description of the error
          example: Group id cannot be blank
    PolicyStatus:
      type: object
      properties:
        effective_date:
          type: string
          description: Original effective date of the policy.
          example: 01/01/2019
        termination_date:
          type: string
          description: Termination date of the policy.
          example: 12/31/2019
        status:
          type: string
          description: if policy status is work in progress or inforce.
          example: INFORCE
          enum:
          - WORK IN PROGRESS
          - INFORCE
        status_category:
          type: string
          description: Describes when policy data is ready to be pulled and enrollments are ready to be consumed by Guardian.
          example: READY
          enum:
          - READY FOR ENROLL
          - READY
          - NOT READY
    BillGroups:
      type: array
      items:
        $ref: '#/components/schemas/BillGroup'
    BillGroup:
      type: object
      properties:
        bill_group_identification:
          type: string
          description: Carrier assigned code to tie the coverage back to a billing arrangement.
          example: "0000"
        bill_group_name:
          type: string
          description: Name of the bill group identification.
          example: ABC Corporation
        effective_date:
          type: string
          description: Original effective date of the bill group.
          example: 01/01/2019
        termination_date:
          type: string
          description: Termination date of the bill group.
          example: 12/31/2019
    PolicyChangeInfo:
      type: object
      properties:
        updates_made:
          type: array
          items:
            $ref: '#/components/schemas/Updated_Coverages'
      allOf:
      - $ref: '#/components/schemas/MasterAgreementNumber'
      - $ref: '#/components/schemas/BrokerId'
      - $ref: '#/components/schemas/Taxid'
      - $ref: '#/components/schemas/BenAdminGroupId'
      - $ref: '#/components/schemas/ChangeEffectiveDate'
      - $ref: '#/components/schemas/PolicyChangeDescription'
    MasterAgreementNumber:
      type: object
      properties:
        master_agreement_number:
          type: string
          description: Guardian generated system assigned number which gives uniqueness to the policies.
          example: "00000001"
    BrokerId:
      type: object
      properties:
        broker_id:
          type: string
          description: Producer Id from VMS
          example: 000AB123
    Taxid:
      type: object
      properties:
        federal_employer_identification_number:
          type: string
          description: A nine-digit unique number assigned by the Internal Revenue Service (IRS) to businesses operating in the United States.
          example: "123456789"
    BenAdminGroupId:
      type: object
      properties:
        group_reference_id:
          type: string
          description: Benadmin assigned group reference id for corresponding Guardian assigned group policy id.
          example: "12345789000"
    ChangeEffectiveDate:
      type: object
      properties:
        change_effective_date:
          type: string
          description: Effective date of the change.
          example: 01/01/2021
    PolicyChangeDescription:
      type: object
      properties:
        description:
          type: string
          description: Description of the change. For now the only possible value is UPDATE_TO_POLICY
          example: POLICY_NEW_BUSINESS_INITIATED
          enum:
          - POLICY_NEW_BUSINESS_INITIATED
          - POLICY_NEW_BUSINESS_COMPLETED
          - POLICY_UPDATE_INITIATED
          - POLICY_UPDATE_COMPLETED
          - POLICY_SYSTEM_UPDATE_COMPLETED
          - POLICY_RENEWAL_RATE_INITIATED
          - CANCELLATION
          - REINSTATEMENT
          - BROKER_CHANGE
          - BROKER_CHANGE_REMOVING_TECHNOLOGY_PLATFORM
          - BROKER_CHANGE_ADDING_TECHNOLOGY_PLATFORM
          - NEW_TECHNOLOGY_PLATFORM_CONNECTION
    Updated_Coverages:
      type: object
      properties:
        event:
          type: string
          description: Lists the coverages for which the underlying data changed.
          enum:
          - POLICY_UPDATE
          - CLASS_UPDATE
          - DENTAL_UPDATE
          - VISION_UPDATE
          - HOSPITAL_INDEMNITY_UPDATE
          - BASIC_LIFE_UPDATE
          - BASIC_ADD_UPDATE
          - LONG_TERM_DISABILITY_UPDATE
          - SHORT_TERM_DISABILITY_UPDATE
          - VOLUNTARY_LIFE_UPDATE
          - CRITICAL_ILLNESS_UPDATE
          - CANCER_UPDATE
          - ACCIDENT_UPDATE
        sections_updated:
          type: array
          items:
            $ref: '#/components/schemas/Updated_Sections'
    Updated_Sections:
      type: object
      properties:
        section_updated:
          type: string
          description: Sections within Coverages that were updated.
          enum:
          - PLAN_ANNIVERSARY
          - BENEFIT_CLASS
          - COVERAGE_DEPENDENCY
          - COVERAGE_PARAMETER
          - DEPENDENT_CHILD_AGE_LIMIT
          - GUARANTEE_ISSUE
          - RATES
          - DISABILITY_BENEFIT
          - CONTRIBUTION_SPLITS
          - WAITING_PERIOD_RULES
          - TERMINATION_RULES
          - BENEFIT_EARNING_DEFINITION
          - REDETERMINATION_DATE
          - AGE_CALCULATION
          - AGE_REDUCTIONS
          - OPEN_ENROLLMENT_TYPE
    Integration:
      type: object
      properties:
        transmission_guid:
          type: string
          description: Global Unique identifier created by the originator for this instance of the electronic transmission.
          example: 030c89b1-8732-492b-b69a-2239e14264e5
        group_reference_id:
          type: string
          description: Benadmin assigned group reference id for corresponding Guardian assigned group policy id.
        authorization_key:
          type: string
          description: Benadmin assigned authorization key for a given Guaridan policy id.
    SuccessResponse:
      type: object
      properties:
        transmission_guid:
          type: string
          description: Global Unique identifier created by the originator for this instance of the electronic transmission.
          example: 030c89b1-8732-492b-b69a-2239e14264e5
        status:
          type: string
          description: Indicates the status of the request. Only possible value is Success
          example: SUCCESS
          enum:
          - SUCCESS
      description: A generic response object that is returned after successfull processing of incoming request.
    PolicySearchResponse:
      type: object
      properties:
        policy_list_count:
          type: string
          description: Total policy match found based on the search request.
          example: "50"
        policy_list:
          type: array
          items:
            $ref: '#/components/schemas/PolicyListView'
    PolicyListView:
      type: object
      properties:
        group_policy_identifier:
          type: string
          description: Guardian generated plan number which uniquely identifies the group customer.
          example: "00123456"
        organization_name:
          type: string
          description: Name of the organization
          example: ABC CORP
        effective_date:
          type: string
          description: Plan Effective Date
          example: 12/31/2015
        contact_person:
          type: string
          description: Describes the name of the person on file for the policy holder.
          example: John Smith
        state_province_code:
          $ref: '#/components/schemas/StateProvince'
    AsyncResponse:
      type: object
      properties:
        TransmissionGUID:
          type: string
          example: 030c89b1-8732-492b-b69a-2239e14264e5
        TransmissionStatusCode:
          type: string
          enum:
          - Success
          - Failure
          - Partial
        CreationDateTime:
          type: string
          example: 2021-01-23T15:36:40.881
        TransactionDetail:
          type: array
          items:
            $ref: '#/components/schemas/TransactionDetail'
        TransactionRemark:
          type: array
          items:
            $ref: '#/components/schemas/TransactionRemark'
        Audit:
          $ref: '#/components/schemas/Audit_1'
    TransactionDetail:
      required:
      - MasterAgreementNumber
      type: object
      properties:
        MasterAgreementNumber:
          type: string
        EmployerId:
          type: string
        TransactionRemark:
          type: array
          items:
            $ref: '#/components/schemas/TransactionRemark'
        TransactionBenefitPlanEvent:
          $ref: '#/components/schemas/TransactionBenefitPlanEvent'
    TransactionRemark:
      type: object
      properties:
        EntityCode:
          type: string
        EntityReferenceID:
          type: string
        FieldName:
          type: string
        RemarkStatusCode:
          type: array
          items:
            $ref: '#/components/schemas/InformationCategory'
        MessageTypeCode:
          type: string
        MessageText:
          type: string
    InformationCategory:
      type: string
      enum:
      - Error
      - Warning
    TransactionBenefitPlanEvent:
      type: object
      properties:
        BenefitPlanIdentifier:
          type: string
          example: DEN01
        ProductType:
          type: string
        CoverageTier:
          type: string
        GroupPolicyNumber:
          type: string
        BenefitPlanClassIdentifier:
          type: string
    Audit_1:
      required:
      - CarrierQuantity
      type: object
      properties:
        AuditID:
          type: string
          description: A unique identifier created by the originator for this instance of the electronic transmission.
        CarrierQuantity:
          type: integer
          description: A count of Carrier records included in the electronic transmission.
          format: int32
        EmployerRecordQuantity:
          type: integer
          description: A count of Employer records included in the electronic transmission.
          format: int32
        EmployeeRecordQuantity:
          type: integer
          description: A count of Employee records included in the electronic transmission.
          format: int32
        DependentRecordQuantity:
          type: integer
          description: A count of Dependent records included in the electronic transmission.
          format: int32
        OtherPartyRecordQuantity:
          type: integer
          description: A count of Other Party records included in the electronic transmission.
        BeneficiaryGroupRecordQuantity:
          type: integer
          description: A count of Beneficiary Group records included in the electronic transmission.
        EventRecordQuantity:
          type: integer
          description: A count of Event records included in the electronic transmission.
        CoverageRecordQuantity:
          type: integer
          description: A count of Coverage records included in the electronic transmission.
          format: int32
        CoverageRiderRecordQuantity:
          type: integer
          description: A count of Coverage Rider records included in the electronic  transmission.
          format: int32
      description: An instance of auditable information provided to ensure accuracy and consistency of the exchanged information.
    TransmissionNB:
      required:
      - creation_date_time
      - employer
      - receiver_name
      - schema_version_identifier
      - sender_name
      - test_production_code
      - transmission_guid
      - transmission_type_code
      type: object
      properties:
        transmission_guid:
          type: string
          description: Global unique identifier created by the originator for this instance of the electronic transmission.
          example: 030c89b1-8732-492b-b69a-2239e14264e5
        sender_name:
          type: string
          description: Name of the company sending electronic benefit records on behalf of a group.
          example: BagelCorporation
        receiver_name:
          type: string
          description: Name of the company receiving electronic benefit records.
          example: Guardian
        creation_date_time:
          type: string
          description: UTC date and time the transmission was created.
          example: 2019-08-23T15:36:40.881
        test_production_code:
          $ref: '#/components/schemas/TestProduction'
        transmission_type_code:
          $ref: '#/components/schemas/TransmissionType'
        schema_version_identifier:
          type: string
          description: Identifies the version of the standard that is being adhered to in this data set.
          example: 1.1.5
        employer:
          $ref: '#/components/schemas/EmployerNB'
      description: "An instance of the electronically transmitted information, such as the Benefit Administrator, Insurance Carrier, version, etc."
    TestProduction:
      type: string
      description: Indicates the elements contained in this data set are production or test data.
      example: Test
      enum:
      - Test
      - Production
    TransmissionType:
      type: string
      description: The type of data contained within the data set.
      example: FullFile
      enum:
      - FullFile
    EmployerNB:
      required:
      - applied_for_guardian_benefits_before
      - bankruptcy
      - benefit_class_definitions
      - contribution
      - correspondent
      - coverage
      - date_established
      - domestic_partner
      - employees
      - employer_legal_address
      - employer_name
      - enrollment
      - federal_employer_identification_number
      - insurance_broker_information
      - master_application_signature
      - master_application_signature_date
      - open_enrollments
      - policy_effective_date
      - requested_renewal_date
      - sic_code
      - type_of_organization
      - waiting_period_rules
      type: object
      properties:
        employer_name:
          type: string
          description: Legal name of the employer.
          example: ABC Corporation
        policy_effective_date:
          type: string
          description: Effective date of the policy and date format should be MM/DD/YYYY.
          example: 01/21/2021
        requested_renewal_date:
          type: string
          description: Renewal date of the policy and date format should be MM/DD/YYYY.
          example: 01/21/2021
        employer_legal_address:
          $ref: '#/components/schemas/EmployerLegalAddressNB'
        main_billing_address_of_applicant:
          $ref: '#/components/schemas/MainBillingAddressOfApplicantNB'
        sic_code:
          type: string
          description: It is Standard Industrial Code.
          example: ""
        type_of_organization:
          $ref: '#/components/schemas/OrganizationNB'
        nature_of_business:
          type: string
          description: nature of business.
          example: ""
        federal_employer_identification_number:
          type: string
          description: A nine-digit unique number assigned by the Internal Revenue Service (IRS) to businesses operating in the United States.
          example: "123456789"
        date_established:
          type: string
          description: Established date. Date format should be MM/DD/YYYY.
          example: 01/21/2020
        guard_o_matic_information_for_eft:
          $ref: '#/components/schemas/EmployerNB_guard_o_matic_information_for_eft'
        correspondent:
          $ref: '#/components/schemas/CorrespondentNB'
        bankruptcy:
          $ref: '#/components/schemas/BankruptcyNB'
        applied_for_guardian_benefits_before:
          $ref: '#/components/schemas/EmployerNB_applied_for_guardian_benefits_before'
        workers_compensation:
          $ref: '#/components/schemas/EmployerNB_workers_compensation'
        cobra_participants:
          $ref: '#/components/schemas/EmployerNB_cobra_participants'
        health_related_information:
          $ref: '#/components/schemas/EmployerNB_health_related_information'
        master_application_signature:
          $ref: '#/components/schemas/EmployerNB_master_application_signature'
        master_application_signature_date:
          type: string
          description: Date format should be MM/DD/YYYY.
          example: 01/21/2020
        insurance_broker_information:
          type: array
          items:
            $ref: '#/components/schemas/InsuranceBrokerInformationNB'
        commissions:
          type: array
          items:
            $ref: '#/components/schemas/CommissionsNB'
        affiliated_companies:
          type: array
          items:
            $ref: '#/components/schemas/AffiliatedCompaniesNB'
        employees:
          $ref: '#/components/schemas/EmployerNB_employees'
        contribution:
          type: array
          items:
            $ref: '#/components/schemas/EmployerContributionNB'
        benefit_class_definitions:
          type: array
          items:
            $ref: '#/components/schemas/BenefitClassDefinitionsNB'
        prior_carrier:
          type: array
          items:
            $ref: '#/components/schemas/PriorCarrierNB'
        enrollment:
          $ref: '#/components/schemas/EmployerNB_enrollment'
        waiting_period_rules:
          type: array
          items:
            $ref: '#/components/schemas/WaitingPeriodRulesNB'
        domestic_partner:
          $ref: '#/components/schemas/EmployerNB_domestic_partner'
        dependent_child_age_limit:
          $ref: '#/components/schemas/EmployerNB_dependent_child_age_limit'
        redetermination_type:
          type: string
          description: Requirements - Situational - Required IF coverage is STD/LTD.
          example: OtherDate
          enum:
          - Immediate
          - PlanAnniversary
          - OtherDate
        redetermination_date:
          $ref: '#/components/schemas/RedeterminationDateNB'
        cobra:
          $ref: '#/components/schemas/EmployerNB_cobra'
        open_enrollments:
          $ref: '#/components/schemas/EmployerNB_open_enrollments'
        section125:
          type: boolean
          example: true
        coverage:
          $ref: '#/components/schemas/CoverageNB'
    EmployerLegalAddressNB:
      required:
      - city_name
      - country_code
      - first_line_address
      - mailing_address_same_as_legal_address
      - postal_code
      - state_province_code
      type: object
      properties:
        first_line_address:
          type: string
          description: "The first line of a formatted address - e.g., Street Number + Street Name, etc."
          example: 123 Any Street
        second_line_address:
          type: string
          description: The second line of a formatted address
          example: 10th Floor
        third_line_address:
          type: string
          description: The third line of a formatted address that is sometimes used for things like 'care of'.
          example: Care of Guardian
        city_name:
          type: string
          description: The city where the address is located.
          example: New York City
        state_province_code:
          $ref: '#/components/schemas/StateProvinceNB'
        postal_code:
          type: string
          description: The unique identifier used to associate postal deliveries. This may also be referred to as zip code or post code where the address is located.
          example: 53027-1234
        country_code:
          $ref: '#/components/schemas/CountryNB'
        mailing_address_same_as_legal_address:
          type: boolean
          description: Identifies if the Mailing address is same as Legal address.
          example: true
      description: "An address used for the delivery of letters and packages by an external mailing or packaging service, at a place where the recipient usually lives or works. Legal address must not have a PO Box."
    StateProvinceNB:
      type: string
      description: "A short, alphabetic geographic abbreviation for the state or province within a country."
      example: AL
      enum:
      - AL
      - AK
      - AZ
      - AR
      - CA
      - CO
      - CT
      - DE
      - FL
      - GA
      - HI
      - ID
      - IL
      - IN
      - IA
      - KS
      - KY
      - LA
      - ME
      - MD
      - MA
      - MI
      - MN
      - MS
      - MO
      - MT
      - NE
      - NV
      - NH
      - NJ
      - NM
      - NY
      - NC
      - ND
      - OH
      - OK
      - OR
      - PA
      - RI
      - SC
      - SD
      - TN
      - TX
      - UT
      - VT
      - VA
      - WA
      - WV
      - WI
      - WY
      - DC
      - AS
      - GU
      - MP
      - PR
      - UM
      - VI
      - AB
      - BC
      - MB
      - NB
      - NL
      - NS
      - PE
      - QE
      - SU
      - NT
      - NU
      - YT
      - AG
      - BS
      - CM
      - CS
      - CH
      - CL
      - DF
      - DG
      - GT
      - GR
      - HG
      - JA
      - EM
      - NA
      - OA
      - PU
      - QT
      - QR
      - SL
      - SI
      - SO
      - TB
      - TM
      - TL
      - VE
      - YU
      - ZA
    CountryNB:
      type: string
      description: "A short alphabetic, geographical code for a country used for data processing and communications."
      example: USA
      enum:
      - USA
      - CA
      - OTH
      - US
      - MX
    MainBillingAddressOfApplicantNB:
      type: object
      properties:
        first_line_address:
          type: string
          description: "The first line of a formatted address - e.g., Street Number + Street Name, etc."
          example: 123 Any Street
        second_line_address:
          type: string
          description: The second line of a formatted address
          example: 10th Floor
        third_line_address:
          type: string
          description: The third line of a formatted address that is sometimes used for things like 'care of'.
          example: Care of Guardian
        city_name:
          type: string
          description: The city where the address is located.
          example: New York City
        state_province_code:
          $ref: '#/components/schemas/StateProvinceNB'
        postal_code:
          type: string
          description: The unique identifier used to associate postal deliveries. This may also be referred to as zip code or post code where the address is located.
          example: 53027-1234
        country_code:
          $ref: '#/components/schemas/CountryNB'
      description: "An address used for the delivery of letters and packages by an external mailing or packaging service, at a place where the recipient usually lives or works. Requirements - Situational - Needed when if MailingAddressSameAsLegalAddress is false."
    OrganizationNB:
      type: string
      description: types of organization.
      example: Corporation
      enum:
      - Corporation
      - Partnership
      - Proprietorship
      - SCorp
      - LLC
      - NonProfit
      - Government
      - Other
    CorrespondentNB:
      required:
      - contact_email
      - first_name
      - last_name
      - member_services_phone
      type: object
      properties:
        first_name:
          type: string
          description: Describes the first name of the person on file for the policy holder.
          example: Angle
        last_name:
          type: string
          description: Describes the last name of the person on file for the policy holder.
          example: Mathur
        title:
          type: string
          description: Describes the title of the person on file for the policy holder.
          example: Mrs.
        contact_email:
          type: string
          description: Describes the email address of the contact on file for the policy holder.
          example: angle.mathur@glic.com
        member_services_phone:
          type: string
          description: Describes the phone number of the contact on file for the policy holder.
          example: ""
        fax_number:
          type: string
          description: Describes the fax number of the contact on file for the policy holder.
          example: ""
    BankruptcyNB:
      required:
      - filed
      type: object
      properties:
        filed:
          type: boolean
          description: Describes the confirmation of the Bankruptcy.
          example: true
    ParticipantNB:
      type: object
      properties:
        name:
          type: string
          example: David
        date_of_birth:
          type: string
          description: Format of DateOfBirth is MM/DD/YYYY.
          example: 06/14/2021
        type:
          type: string
          example: State
          enum:
          - State
          - Federal
          - ExtensionOfBenefits
        reason:
          type: string
          example: Disability
          enum:
          - Disability
          - NonDisability
        continuation_start:
          type: string
          description: Format of ContinuationStart is MM/DD/YYYY.
          example: 05/12/2021
        continuation_end:
          type: string
          description: Format of ContinuationStart is MM/DD/YYYY.
          example: 07/12/2021
      description: Corbra participants name allowing multiple instance.
    InsuranceBrokerInformationNB:
      required:
      - broker_name
      - national_producer_number
      type: object
      properties:
        broker_name:
          type: string
          example: Broker
        national_producer_number:
          type: string
          example: ""
        agent:
          type: array
          items:
            $ref: '#/components/schemas/AgentNB'
      description: Information of insurance broker.
    AgentNB:
      type: object
      properties:
        agent_first_name:
          type: string
          example: Abc
        agent_last_name:
          type: string
          example: Corp
        first_line_address:
          type: string
          example: Abc Corp
        second_line_address:
          type: string
          example: 2nd. lane
        third_line_address:
          type: string
          example: street
        city_name:
          type: string
          example: New Jersy
        state_province_code:
          $ref: '#/components/schemas/StateProvinceNB'
        postal_code:
          type: string
          example: ""
        country_code:
          $ref: '#/components/schemas/CountryNB'
        guardian_broker_code:
          type: string
          example: ""
      description: Describes the information of the agents.
    CommissionsNB:
      type: object
      properties:
        plan_name:
          $ref: '#/components/schemas/CoverageTypeNB'
        commission_percent:
          type: string
          example: ""
    CoverageTypeNB:
      type: string
      description: Describes the types of coverage.
      example: Dental
      enum:
      - Dental
      - Vision
      - LongTermDisability
      - ShortTermDisability
      - MemberLife
      - ADD
    AffiliatedCompaniesNB:
      type: object
      properties:
        affiliate_name:
          type: string
          description: Describes the Affiliate name.
          example: ""
        first_line_address:
          type: string
          description: "The first line of a formatted address - e.g., Street Number + Street Name, etc."
          example: 123 Any Street
        second_line_address:
          type: string
          description: The second line of a formatted address
          example: 10th Floor
        third_line_address:
          type: string
          description: The third line of a formatted address that is sometimes used for things like 'care of'.
          example: Care of Guardian
        city_name:
          type: string
          description: The city where the address is located.
          example: New York City
        state_province_code:
          $ref: '#/components/schemas/StateProvinceNB'
        postal_code:
          type: string
          description: The unique identifier used to associate postal deliveries. This may also be referred to as zip code or post code where the address is located.
          example: 53027-1234
        country_code:
          $ref: '#/components/schemas/CountryNB'
    EmployerContributionNB:
      required:
      - percent_employee_pays_employee
      - percent_employee_pays_for_dependent
      type: object
      properties:
        coverage:
          $ref: '#/components/schemas/CoverageTypeNB'
        percent_employee_pays_employee:
          type: string
          description: Percentage amount the employee is contributing towards the coverage.
          example: "100.0"
        percent_employee_pays_for_dependent:
          type: string
          description: Percentage amount the employee is contributing towards the coverage.
          example: "100.0"
    BenefitClassDefinitionsNB:
      required:
      - benefit_class_description
      - hourly_work_requirements
      type: object
      properties:
        benefit_class_description:
          type: string
          description: The display name of the eligibility or population group.
          example: ""
        hourly_work_requirements:
          type: string
          description: Describes the number of hours required to be eligible for the benefit plan.
          example: ""
    PriorCarrierNB:
      type: object
      properties:
        prior_carrier:
          type: boolean
          example: true
        coverage:
          $ref: '#/components/schemas/CoverageTypeNB'
        name_of_carrier:
          type: string
          example: ""
        termination_date:
          type: string
          description: Date format should be MM/DD/YYYY.
          example: 02/23/2021
    WaitingPeriodRulesNB:
      required:
      - not_coinciding_with_hire_date
      - waiting_period_rule_type
      - waiting_period_type
      type: object
      properties:
        coverage:
          $ref: '#/components/schemas/CoverageTypeNB'
        waiting_period_type:
          type: string
          description: Displays the waiting period type.
          example: HiredOnEffectiveDateOfGroup
          enum:
          - HiredOnEffectiveDateOfGroup
          - HiredBeforeEffectiveDateOfGroup
          - HiredAfterEffectiveDateOfGroup
        waiting_period_rule_type:
          type: string
          description: "Displays if the group has no waiting period, first of the month waiting period, etc."
          example: HireDate
          enum:
          - HireDate
          - FirstOfMonthAfter
          - After
          - FirstOfMonthAfterEvent
          - FirstPayPeriodAfter
          - FirstOfMonthAfterDateOfHire
          - FifteenthOfMonthAfter
          - FifteenthOfMonthAfterDateOfHire
        not_coinciding_with_hire_date:
          type: boolean
          description: Describes if the waiting period coincides with the employee hire date.
          example: true
        num_days:
          type: string
          description: "Requirements - Situational - Required if when First Of Month, FifteenthOfMonth After OR After is selected from WaitingPeriodRuleType - One element MUST have a value."
          example: "15"
        num_weeks:
          type: string
          description: "Requirements - Situational - Required if when First Of Month, FifteenthOfMonth After OR After is selected from WaitingPeriodRuleType - One element MUST have a value."
          example: "7"
        num_months:
          type: string
          description: "Requirements - Situational - Required if when First Of Month, FifteenthOfMonth After OR After is selected from WaitingPeriodRuleType - One element MUST have a value."
          example: "4"
        num_years:
          type: string
          description: "Requirements - Situational - Required if when First Of Month, FifteenthOfMonth After OR After is selected from WaitingPeriodRuleType - One element MUST have a value."
          example: "1"
    RedeterminationDateNB:
      type: object
      properties:
        redetermination_date_one:
          type: string
          example: 02-15
        redetermination_date_two:
          type: string
          example: 02-16
        redetermination_date_three:
          type: string
          example: 02-17
        redetermination_date_four:
          type: string
          example: 02-18
      description: Format should be MM-DD. Requirements - Situational - Only need a value if OtherDate is selected.
    CoverageNB:
      required:
      - billing_preferences
      type: object
      properties:
        dental:
          $ref: '#/components/schemas/CoverageNB_dental'
        vision:
          $ref: '#/components/schemas/CoverageNB_vision'
        long_term_disability:
          $ref: '#/components/schemas/CoverageNB_long_term_disability'
        short_term_disability:
          $ref: '#/components/schemas/CoverageNB_short_term_disability'
        life:
          $ref: '#/components/schemas/CoverageNB_life'
        add:
          $ref: '#/components/schemas/CoverageNB_add'
        billing_preferences:
          $ref: '#/components/schemas/CoverageNB_billing_preferences'
        delivery_of_plan_materials:
          $ref: '#/components/schemas/CoverageNB_delivery_of_plan_materials'
    DHMOResideNB:
      type: string
      example: NewJersey
      enum:
      - NewJersey
      - California
      - Florida
      - Illinois
      - Texas
      - Indiana
      - Colorado
      - Missouri
      - Ohio
      - Michigan
    ContributionNB:
      type: string
      example: NonContributory
      enum:
      - NonContributory
      - Contributory
      - Voluntary
    CoInsuranceNB:
      type: object
      properties:
        service_name:
          $ref: '#/components/schemas/ServiceNameNB'
        percent:
          type: string
          example: ""
    ServiceNameNB:
      type: string
      example: Preventive
      enum:
      - Preventive
      - Basic
      - Major
    DeductibleNB:
      type: object
      properties:
        network_name:
          $ref: '#/components/schemas/NetworkNB'
        service_name:
          $ref: '#/components/schemas/ServiceNameNB'
        percent:
          type: string
    NetworkNB:
      type: string
      example: InNetwork
      enum:
      - InNetwork
      - OutOfNetwork
    ClaimsPaymentBasisNB:
      type: object
      properties:
        network_name:
          $ref: '#/components/schemas/NetworkNB'
        basis:
          type: string
          example: NegotiatedFeeSchedule
          enum:
          - NegotiatedFeeSchedule
          - 90th
    RatesNB:
      required:
      - employee
      - employee_and_children
      - employee_and_spouse
      - employee_family
      type: object
      properties:
        employee:
          type: integer
        employee_and_spouse:
          type: integer
        employee_and_children:
          type: integer
        employee_family:
          type: integer
        rate_guarantee:
          type: string
    ReimbursementScheduleNB:
      type: object
      properties:
        network_name:
          $ref: '#/components/schemas/NetworkNB'
        lenses_benefit:
          type: string
          example: SingleVision
          enum:
          - SingleVision
          - Bifocal
          - Trifocal
          - Lenticular
        co_pay:
          type: string
          description: Requirements - required Only with InNetwork.
        before_co_pay:
          type: string
          description: Requirements - required Only with OutOfNetwork.
        contact_lenses:
          type: string
          example: MedicalNecessary
          enum:
          - MedicalNecessary
          - ElectiveMaterials
          - ElectiveFittingAndEvalution
        co_pay_waived:
          type: string
          description: Requirements - required Only with ElectiveMaterials.
        discount:
          type: string
          description: Requirements - required Only with ElectiveFittingAndEvaluation.
    PreExistingNB:
      type: object
      properties:
        months_look_back:
          type: string
        months_after_exclusion:
          type: string
    EarningsDefinitionNB:
      type: string
      description: Indicates the type of earnings for salary benefit plans.
      enum:
      - BASE_SALARY
      - BASE_SALARY_BONUS
      - BASE_SALARY_COMMISSION
      - BASE_SALARY_BONUS_COMMISSION
      - W2
      - CUSTOM
    EmployeesResideNB:
      type: object
      properties:
        state:
          type: string
        percent:
          type: string
    RatesLTDSTDNB:
      type: object
      properties:
        employee:
          type: integer
        age_band:
          type: integer
          example: 15
      description: Rates for long_term_disability/short_term_disability.
    Transmission_1:
      required:
      - creation_date_time
      - employer
      - receiver_name
      - schema_version_identifier
      - sender_name
      - test_production_code
      - transmission_guid
      - transmission_type_code
      type: object
      properties:
        transmission_guid:
          type: string
          description: Global unique identifier created by the originator for this instance of the electronic transmission.
          example: 030c89b1-8732-492b-b69a-2239e14264e5
        sender_name:
          type: string
          description: Name of the company sending electronic benefit records on behalf of a group.
          example: BagelCorporation
        receiver_name:
          type: string
          description: Name of the company receiving electronic benefit records.
          example: Guardian
        creation_date_time:
          type: string
          description: UTC date and time the transmission was created.
          example: 2019-08-23T15:36:40.881
        test_production_code:
          $ref: '#/components/schemas/TestProduction'
        transmission_type_code:
          $ref: '#/components/schemas/TransmissionType'
        schema_version_identifier:
          type: string
          description: Identifies the version of the standard that is being adhered to in this data set.
          example: 1.1.5
        employer:
          $ref: '#/components/schemas/Employer_1'
        events:
          type: array
          items:
            $ref: '#/components/schemas/Event_1'
      description: "An instance of the electronically transmitted information, such as the Benefit Administrator, Insurance Carrier, version, etc."
    Employer_1:
      required:
      - applied_for_guardian_benefits_before
      - benefit_class_definitions
      - contribution
      - correspondent
      - coverage
      - domestic_partner
      - employees
      - employer_legal_address
      - employer_name
      - enrollment
      - federal_employer_identification_number
      - insurance_broker_information
      - master_application_signature
      - master_application_signature_date
      - open_enrollments
      - policy_effective_date
      - requested_renewal_date
      - sic_code
      - type_of_organization
      - waiting_period_rules
      type: object
      properties:
        employer_name:
          type: string
          description: Legal name of the employer.
          example: ABC Corporation
        policy_effective_date:
          type: string
          description: Effective date of the policy and date format should be MM/DD/YYYY.
          example: 01/21/2021
        requested_renewal_date:
          type: string
          description: Renewal date of the policy and date format should be MM/DD/YYYY.
          example: 01/21/2021
        employer_legal_address:
          $ref: '#/components/schemas/EmployerLegalAddress'
        main_billing_address_of_applicant:
          $ref: '#/components/schemas/MainBillingAddressOfApplicant'
        sic_code:
          type: string
          description: It is Standard Industrial Code.
          example: ""
        type_of_organization:
          $ref: '#/components/schemas/Organization'
        nature_of_business:
          type: string
          description: nature of business.
          example: ""
        federal_employer_identification_number:
          type: string
          description: A nine-digit unique number assigned by the Internal Revenue Service (IRS) to businesses operating in the United States.
          example: "123456789"
        date_established:
          type: string
          description: Established date. Date format should be MM/DD/YYYY.
          example: 01/21/2020
        guard_o_matic_information_for_eft:
          $ref: '#/components/schemas/Employer_1_guard_o_matic_information_for_eft'
        correspondent:
          $ref: '#/components/schemas/Correspondent'
        bankruptcy:
          $ref: '#/components/schemas/Bankruptcy'
        applied_for_guardian_benefits_before:
          $ref: '#/components/schemas/Employer_1_applied_for_guardian_benefits_before'
        workers_compensation:
          $ref: '#/components/schemas/Employer_1_workers_compensation'
        cobra_participants:
          $ref: '#/components/schemas/Employer_1_cobra_participants'
        health_related_information:
          $ref: '#/components/schemas/Employer_1_health_related_information'
        master_application_signature:
          $ref: '#/components/schemas/Employer_1_master_application_signature'
        master_application_signature_date:
          type: string
          description: Date format should be MM/DD/YYYY.
          example: 01/21/2020
        insurance_broker_information:
          type: array
          items:
            $ref: '#/components/schemas/InsuranceBrokerInformation'
        commissions:
          type: array
          items:
            $ref: '#/components/schemas/Commissions'
        affiliated_companies:
          type: array
          items:
            $ref: '#/components/schemas/AffiliatedCompanies'
        employees:
          $ref: '#/components/schemas/Employer_1_employees'
        contribution:
          type: array
          items:
            $ref: '#/components/schemas/EmployerContribution'
        benefit_class_definitions:
          type: array
          items:
            $ref: '#/components/schemas/BenefitClassDefinitions'
        prior_carrier:
          type: array
          items:
            $ref: '#/components/schemas/PriorCarrier'
        enrollment:
          $ref: '#/components/schemas/Employer_1_enrollment'
        waiting_period_rules:
          type: array
          items:
            $ref: '#/components/schemas/WaitingPeriodRules'
        domestic_partner:
          $ref: '#/components/schemas/Employer_1_domestic_partner'
        dependent_child_age_limit:
          $ref: '#/components/schemas/Employer_1_dependent_child_age_limit'
        redetermination_type:
          type: string
          description: Requirements - Situational - Required IF coverage is STD/LTD.
          example: OtherDate
          enum:
          - Immediate
          - PlanAnniversary
          - OtherDate
        redetermination_date:
          $ref: '#/components/schemas/RedeterminationDate'
        cobra:
          $ref: '#/components/schemas/Employer_1_cobra'
        open_enrollments:
          $ref: '#/components/schemas/Employer_1_open_enrollments'
        section125:
          type: boolean
          example: true
        coverage:
          $ref: '#/components/schemas/Coverage'
    EmployerLegalAddress:
      required:
      - city_name
      - country_code
      - first_line_address
      - mailing_address_same_as_legal_address
      - postal_code
      - state_province_code
      type: object
      properties:
        first_line_address:
          type: string
          description: "The first line of a formatted address - e.g., Street Number + Street Name, etc."
          example: 123 Any Street
        second_line_address:
          type: string
          description: The second line of a formatted address
          example: 10th Floor
        third_line_address:
          type: string
          description: The third line of a formatted address that is sometimes used for things like 'care of'.
          example: Care of Guardian
        city_name:
          type: string
          description: The city where the address is located.
          example: New York City
        state_province_code:
          $ref: '#/components/schemas/StateProvince_1'
        postal_code:
          type: string
          description: The unique identifier used to associate postal deliveries. This may also be referred to as zip code or post code where the address is located.
          example: 53027-1234
        country_code:
          $ref: '#/components/schemas/Country'
        mailing_address_same_as_legal_address:
          type: boolean
          description: Identifies if the Mailing address is same as Legal address.
          example: true
      description: "An address used for the delivery of letters and packages by an external mailing or packaging service, at a place where the recipient usually lives or works. Legal address must not have a PO Box."
    StateProvince_1:
      type: string
      description: "A short, alphabetic geographic abbreviation for the state or province within a country."
      example: AL
      enum:
      - AL
      - AK
      - AZ
      - AR
      - CA
      - CO
      - CT
      - DE
      - FL
      - GA
      - HI
      - ID
      - IL
      - IN
      - IA
      - KS
      - KY
      - LA
      - ME
      - MD
      - MA
      - MI
      - MN
      - MS
      - MO
      - MT
      - NE
      - NV
      - NH
      - NJ
      - NM
      - NY
      - NC
      - ND
      - OH
      - OK
      - OR
      - PA
      - RI
      - SC
      - SD
      - TN
      - TX
      - UT
      - VT
      - VA
      - WA
      - WV
      - WI
      - WY
      - DC
      - AS
      - GU
      - MP
      - PR
      - UM
      - VI
      - AB
      - BC
      - MB
      - NB
      - NL
      - NS
      - PE
      - QE
      - SU
      - NT
      - NU
      - YT
      - AG
      - BS
      - CM
      - CS
      - CH
      - CL
      - DF
      - DG
      - GT
      - GR
      - HG
      - JA
      - EM
      - NA
      - OA
      - PU
      - QT
      - QR
      - SL
      - SI
      - SO
      - TB
      - TM
      - TL
      - VE
      - YU
      - ZA
    MainBillingAddressOfApplicant:
      type: object
      properties:
        first_line_address:
          type: string
          description: "The first line of a formatted address - e.g., Street Number + Street Name, etc."
          example: 123 Any Street
        second_line_address:
          type: string
          description: The second line of a formatted address
          example: 10th Floor
        third_line_address:
          type: string
          description: The third line of a formatted address that is sometimes used for things like 'care of'.
          example: Care of Guardian
        city_name:
          type: string
          description: The city where the address is located.
          example: New York City
        state_province_code:
          $ref: '#/components/schemas/StateProvince_1'
        postal_code:
          type: string
          description: The unique identifier used to associate postal deliveries. This may also be referred to as zip code or post code where the address is located.
          example: 53027-1234
        country_code:
          $ref: '#/components/schemas/Country'
      description: "An address used for the delivery of letters and packages by an external mailing or packaging service, at a place where the recipient usually lives or works. Requirements - Situational - Needed when if MailingAddressSameAsLegalAddress is false."
    Organization:
      type: string
      description: types of organization.
      example: Corporation
      enum:
      - Corporation
      - Partnership
      - Proprietorship
      - SCorp
      - LLC
      - NonProfit
      - Government
      - Other
    Correspondent:
      required:
      - contact_email
      - first_name
      - last_name
      - member_services_phone
      type: object
      properties:
        first_name:
          type: string
          description: Describes the first name of the person on file for the policy holder.
          example: Angle
        last_name:
          type: string
          description: Describes the last name of the person on file for the policy holder.
          example: Mathur
        title:
          type: string
          description: Describes the title of the person on file for the policy holder.
          example: Mrs.
        contact_email:
          type: string
          description: Describes the email address of the contact on file for the policy holder.
          example: angle.mathur@glic.com
        member_services_phone:
          type: string
          description: Describes the phone number of the contact on file for the policy holder.
          example: ""
        fax_number:
          type: string
          description: Describes the fax number of the contact on file for the policy holder.
          example: ""
    Bankruptcy:
      required:
      - filed
      type: object
      properties:
        filed:
          type: boolean
          description: Describes the confirmation of the Bankruptcy.
          example: true
    Participant:
      type: object
      properties:
        name:
          type: string
          example: David
        date_of_birth:
          type: string
          description: Format of DateOfBirth is MM/DD/YYYY.
          example: 06/14/2021
        type:
          type: string
          example: State
          enum:
          - State
          - Federal
          - ExtensionOfBenefits
        reason:
          type: string
          example: Disability
          enum:
          - Disability
          - NonDisability
        continuation_start:
          type: string
          description: Format of ContinuationStart is MM/DD/YYYY.
          example: 05/12/2021
        continuation_end:
          type: string
          description: Format of ContinuationStart is MM/DD/YYYY.
          example: 07/12/2021
      description: Corbra participants name allowing multiple instance.
    InsuranceBrokerInformation:
      required:
      - broker_name
      - national_producer_number
      type: object
      properties:
        broker_name:
          type: string
          example: Broker
        national_producer_number:
          type: string
          example: ""
        agent:
          type: array
          items:
            $ref: '#/components/schemas/Agent'
      description: Information of insurance broker.
    Agent:
      type: object
      properties:
        agent_first_name:
          type: string
          example: Abc
        agent_last_name:
          type: string
          example: Corp
        first_line_address:
          type: string
          example: Abc Corp
        second_line_address:
          type: string
          example: 2nd. lane
        third_line_address:
          type: string
          example: street
        city_name:
          type: string
          example: New Jersy
        state_province_code:
          $ref: '#/components/schemas/StateProvince_1'
        postal_code:
          type: string
          example: ""
        country_code:
          $ref: '#/components/schemas/Country'
        guardian_broker_code:
          type: string
          example: ""
      description: Describes the information of the agents.
    Commissions:
      type: object
      properties:
        plan_name:
          $ref: '#/components/schemas/CoverageType'
        commission_percent:
          type: string
          example: ""
    CoverageType:
      type: string
      description: Describes the types of coverage.
      example: Dental
      enum:
      - Dental
      - Vision
      - LongTermDisability
      - ShortTermDisability
      - MemberLife
      - ADD
    AffiliatedCompanies:
      type: object
      properties:
        affiliate_name:
          type: string
          description: Describes the Affiliate name.
          example: ""
        first_line_address:
          type: string
          description: "The first line of a formatted address - e.g., Street Number + Street Name, etc."
          example: 123 Any Street
        second_line_address:
          type: string
          description: The second line of a formatted address
          example: 10th Floor
        third_line_address:
          type: string
          description: The third line of a formatted address that is sometimes used for things like 'care of'.
          example: Care of Guardian
        city_name:
          type: string
          description: The city where the address is located.
          example: New York City
        state_province_code:
          $ref: '#/components/schemas/StateProvince_1'
        postal_code:
          type: string
          description: The unique identifier used to associate postal deliveries. This may also be referred to as zip code or post code where the address is located.
          example: 53027-1234
        event_id:
          type: string
          description: ""
          example: ""
        country_code:
          $ref: '#/components/schemas/Country'
    EmployerContribution:
      required:
      - percent_employee_pays_employee
      - percent_employee_pays_for_dependent
      type: object
      properties:
        coverage:
          $ref: '#/components/schemas/CoverageType'
        percent_employee_pays_employee:
          type: string
          description: Percentage amount the employee is contributing towards the coverage.
          example: "100.0"
        percent_employee_pays_for_dependent:
          type: string
          description: Percentage amount the employee is contributing towards the coverage.
          example: "100.0"
        event_id:
          type: string
          description: ""
          example: ""
    BenefitClassDefinitions:
      required:
      - benefit_class_description
      - hourly_work_requirements
      type: object
      properties:
        benefit_class_description:
          type: string
          description: The display name of the eligibility or population group.
          example: ""
        hourly_work_requirements:
          type: string
          description: Describes the number of hours required to be eligible for the benefit plan.
          example: ""
        event_id:
          type: string
          description: ""
          example: ""
    PriorCarrier:
      type: object
      properties:
        prior_carrier:
          type: boolean
          example: true
        coverage:
          $ref: '#/components/schemas/CoverageType'
        name_of_carrier:
          type: string
          example: ""
        termination_date:
          type: string
          description: Date format should be MM/DD/YYYY.
          example: 02/23/2021
    WaitingPeriodRules:
      required:
      - not_coinciding_with_hire_date
      - waiting_period_rule_type
      - waiting_period_type
      type: object
      properties:
        coverage:
          $ref: '#/components/schemas/CoverageType'
        waiting_period_type:
          type: string
          description: Displays the waiting period type.
          example: HiredOnEffectiveDateOfGroup
          enum:
          - HiredOnEffectiveDateOfGroup
          - HiredBeforeEffectiveDateOfGroup
          - HiredAfterEffectiveDateOfGroup
        waiting_period_rule_type:
          type: string
          description: "Displays if the group has no waiting period, first of the month waiting period, etc."
          example: HireDate
          enum:
          - HireDate
          - FirstOfMonthAfter
          - After
          - FirstOfMonthAfterEvent
          - FirstPayPeriodAfter
          - FirstOfMonthAfterDateOfHire
          - FifteenthOfMonthAfter
          - FifteenthOfMonthAfterDateOfHire
        not_coinciding_with_hire_date:
          type: boolean
          description: Describes if the waiting period coincides with the employee hire date.
          example: true
        num_days:
          type: string
          description: "Requirements - Situational - Required if when First Of Month, FifteenthOfMonth After OR After is selected from WaitingPeriodRuleType - One element MUST have a value."
          example: "15"
        num_weeks:
          type: string
          description: "Requirements - Situational - Required if when First Of Month, FifteenthOfMonth After OR After is selected from WaitingPeriodRuleType - One element MUST have a value."
          example: "7"
        num_months:
          type: string
          description: "Requirements - Situational - Required if when First Of Month, FifteenthOfMonth After OR After is selected from WaitingPeriodRuleType - One element MUST have a value."
          example: "4"
        num_years:
          type: string
          description: "Requirements - Situational - Required if when First Of Month, FifteenthOfMonth After OR After is selected from WaitingPeriodRuleType - One element MUST have a value."
          example: "1"
        event_id:
          type: string
          description: ""
          example: ""
    RedeterminationDate:
      type: object
      properties:
        redetermination_date_one:
          type: string
          example: 02-15
        redetermination_date_two:
          type: string
          example: 02-16
        redetermination_date_three:
          type: string
          example: 02-17
        redetermination_date_four:
          type: string
          example: 02-18
      description: Format should be MM-DD. Requirements - Situational - Only need a value if OtherDate is selected.
    Coverage:
      required:
      - billing_preferences
      type: object
      properties:
        dental:
          type: array
          items:
            $ref: '#/components/schemas/CoverageDental'
        vision:
          type: array
          items:
            $ref: '#/components/schemas/CoverageVision'
        long_term_disability:
          type: array
          items:
            $ref: '#/components/schemas/CoverageLongTermDisability'
        short_term_disability:
          type: array
          items:
            $ref: '#/components/schemas/CoverageShortTermDisability'
        life:
          type: array
          items:
            $ref: '#/components/schemas/CoverageLife'
        add:
          type: array
          items:
            $ref: '#/components/schemas/CoverageAdd'
        billing_preferences:
          $ref: '#/components/schemas/Coverage_billing_preferences'
        delivery_of_plan_materials:
          $ref: '#/components/schemas/Coverage_delivery_of_plan_materials'
    CoverageDental:
      required:
      - contribution
      - product_descriptor
      type: object
      properties:
        coverage_event_id:
          type: string
          example: ""
        product_descriptor:
          type: string
          example: ""
        plan_type:
          type: string
          example: ""
        plan_code:
          type: string
          example: ""
        pponap_number:
          type: string
          example: ""
        dhmo_reside:
          type: array
          items:
            $ref: '#/components/schemas/DHMOReside'
        contribution:
          $ref: '#/components/schemas/Contribution'
        co_insurance:
          type: array
          items:
            $ref: '#/components/schemas/Coinsurance'
        deductible:
          type: array
          items:
            $ref: '#/components/schemas/Deductible_1'
        orthodontia:
          $ref: '#/components/schemas/Coverage_dental_orthodontia'
        annual_maximum:
          type: string
        maximum_rollover:
          $ref: '#/components/schemas/Coverage_dental_maximum_rollover'
        claims_payment_basis:
          type: array
          items:
            $ref: '#/components/schemas/ClaimsPaymentBasis'
        rates:
          $ref: '#/components/schemas/Rates'
    DHMOReside:
      type: string
      example: NewJersey
      enum:
      - NewJersey
      - California
      - Florida
      - Illinois
      - Texas
      - Indiana
      - Colorado
      - Missouri
      - Ohio
      - Michigan
    Contribution:
      type: string
      example: NonContributory
      enum:
      - NonContributory
      - Contributory
      - Voluntary
    Deductible_1:
      type: object
      properties:
        network_name:
          $ref: '#/components/schemas/Network'
        service_name:
          $ref: '#/components/schemas/ServiceName'
        percent:
          type: string
    Network:
      type: string
      example: InNetwork
      enum:
      - InNetwork
      - OutOfNetwork
    ServiceName:
      type: string
      example: Preventive
      enum:
      - Preventive
      - Basic
      - Major
    ClaimsPaymentBasis:
      type: object
      properties:
        network_name:
          $ref: '#/components/schemas/Network'
        basis:
          type: string
          example: NegotiatedFeeSchedule
          enum:
          - NegotiatedFeeSchedule
          - 90th
    Rates:
      required:
      - employee
      - employee_and_children
      - employee_and_spouse
      - employee_family
      type: object
      properties:
        employee:
          type: integer
        employee_and_spouse:
          type: integer
        employee_and_children:
          type: integer
        employee_family:
          type: integer
        rate_guarantee:
          type: string
    CoverageVision:
      required:
      - contribution
      - lock_in_lock_out
      - product_descriptor
      - rates
      type: object
      properties:
        coverage_event_id:
          type: string
          example: ""
        product_descriptor:
          type: string
        plan_type:
          type: string
        plan_network:
          type: string
        lock_in_lock_out:
          type: string
        contributor_type:
          $ref: '#/components/schemas/Contribution'
        participation:
          type: string
        co_pay:
          type: string
        service_frequencies:
          $ref: '#/components/schemas/Coverage_vision_service_frequencies'
        reimbursement_schedule:
          type: array
          items:
            $ref: '#/components/schemas/ReimbursementSchedule'
        frames:
          $ref: '#/components/schemas/Coverage_vision_frames'
        rates:
          $ref: '#/components/schemas/Rates'
    ReimbursementSchedule:
      type: object
      properties:
        network_name:
          $ref: '#/components/schemas/Network'
        lenses_benefit:
          type: string
          example: SingleVision
          enum:
          - SingleVision
          - Bifocal
          - Trifocal
          - Lenticular
        co_pay:
          type: string
          description: Requirements - required Only with InNetwork.
        before_co_pay:
          type: string
          description: Requirements - required Only with OutOfNetwork.
        contact_lenses:
          type: string
          example: MedicalNecessary
          enum:
          - MedicalNecessary
          - ElectiveMaterials
          - ElectiveFittingAndEvalution
        co_pay_waived:
          type: string
          description: Requirements - required Only with ElectiveMaterials.
        discount:
          type: string
          description: Requirements - required Only with ElectiveFittingAndEvaluation.
    CoverageLongTermDisability:
      required:
      - product_descriptor
      - rates
      type: object
      properties:
        coverage_event_id:
          type: string
          example: ""
        product_descriptor:
          type: string
        coverage_amount_percent:
          type: string
        coverage_amount_max:
          type: string
        maximum_payment_period:
          type: string
        accident_benefits_begin:
          type: string
        illness_benefits_begin:
          type: string
        guarantee_issue:
          type: string
        pre_existing:
          $ref: '#/components/schemas/PreExisting'
        premium_waived_if_disabled:
          type: string
        benefit_earnings_definition:
          $ref: '#/components/schemas/EarningsDefinition'
        employees_reside:
          $ref: '#/components/schemas/EmployeesReside'
        rates:
          type: array
          items:
            $ref: '#/components/schemas/RatesLTDSTD'
    PreExisting:
      type: object
      properties:
        months_look_back:
          type: string
        months_after_exclusion:
          type: string
    EarningsDefinition:
      type: string
      description: Indicates the type of earnings for salary benefit plans.
      enum:
      - BASE_SALARY
      - BASE_SALARY_BONUS
      - BASE_SALARY_COMMISSION
      - BASE_SALARY_BONUS_COMMISSION
      - W2
      - CUSTOM
    EmployeesReside:
      type: object
      properties:
        state:
          type: string
        percent:
          type: string
    RatesLTDSTD:
      type: object
      properties:
        employee:
          type: integer
        age_band:
          type: integer
          example: 15
      description: Rates for long_term_disability/short_term_disability.
    CoverageShortTermDisability:
      required:
      - product_descriptor
      - rates
      type: object
      properties:
        coverage_event_id:
          type: string
          example: ""
        product_descriptor:
          type: string
        coverage_amount_percent:
          type: string
        coverage_amount_max:
          type: string
        maximum_payment_period:
          type: string
        accident_benefits_begin:
          type: string
        illness_benefits_begin:
          type: string
        pre_existing:
          $ref: '#/components/schemas/PreExisting'
        benefit_earnings_definition:
          $ref: '#/components/schemas/EarningsDefinition'
        w2fica:
          type: string
          enum:
          - NoW2Reporting
          - MemberReceivesW2AndNoFICAToEmployer
        employees_reside:
          $ref: '#/components/schemas/EmployeesReside'
        rates:
          type: array
          items:
            $ref: '#/components/schemas/RatesLTDSTD'
    CoverageLife:
      required:
      - product_descriptor
      - rates
      type: object
      properties:
        coverage_event_id:
          type: string
          example: ""
        product_descriptor:
          type: string
        employee_benefit:
          type: string
        accidental_death_and_dismemberment:
          type: boolean
        conversion:
          type: boolean
        accelerated_life_benefit:
          type: boolean
        waiver_of_premiums:
          type: boolean
        age_reductions:
          $ref: '#/components/schemas/Coverage_life_age_reductions'
        rates:
          $ref: '#/components/schemas/Coverage_life_rates'
    CoverageAdd:
      required:
      - rates
      type: object
      properties:
        coverage_event_id:
          type: string
          example: ""
        rates:
          $ref: '#/components/schemas/Coverage_add_rates'
    Event_1:
      title: Event
      type: object
      properties:
        event_date:
          type: string
          description: The date on which a specific occurrence took place.
          format: date
        event_id:
          type: string
          description: "Provide description of the data we are pushing to vendor.  Code details to be provided, but examples include New Business, Amendment, Renewal, etc."
        event_type_code:
          type: string
          enum:
          - Coverage
          - Demographic
          - Employment
        event_type_reason_code:
          type: string
          enum:
          - AddCoverageProvision
          - AddCoverage
          - EditCoverage
          - ReInstateCoverage
          - TerminateCoverageProvision
          - TerminateCoverage
          - FMLAdd
          - FMLAmend
          - FMLRemove
          - TravelAidAdd
          - TravelAidRemove
          - New Business
          - AddressChangeBothLegalAndMailingOutofState
          - AddressChangeBothLegalAndMailingSameState
          - AddressChangeLegalOutOfState
          - AddressChangeLegalSameState
          - AddressChangeMailingOutOfState
          - AddressChangeMailingSameState
          - ChannelPartnerAdd
          - ChannelPartnerChange
          - ChannelPartnerRemove
          - CollegeTuitionBenefitAdd
          - CollegeTuitionBenefitRemove
          - Correspondent
          - GOM
          - GracePeriod
          - IDCardDistributionMethod
          - IDCardType
          - EAPAdd
          - EAPRemove
          - IndustrySuffix
          - NatureofBusiness
          - OpenEnrollmentPeriod
          - OptionPackaging
          - PlanholderLegalName
          - RehireProvision
          - RenewalDateOnly
          - RGOCode
          - SalesRepCode
          - TaxIDAdd
          - TaxIDChange
          - TieIns
          - TPA
          - ContractualWording
          - ContributionIndicatorPlanLevel
          - AnniversaryAndRenewalDate
          - AnniversaryDateOnly
          - RatesAternateFundedFeesRate
          - RatesRateGuarantee
          - RatesRateStructure
          - DivisionAddWithNewEmployees
          - DivisionAddMoveExistingEmployees
          - DivisionEdit
          - DivisionTerminate
          - ADPServices
          - AffiliateAdd
          - AffiliateChange
          - AffiliateTerminate
          - BillingChangesDueDate
          - BillingChangesModeOfPayment
          - BillingTypeHomeOfficeBilledtoListBillCombo
          - BillingTypeHomeOfficeBilledtoSelfAdminCombo
          - BillingTypeHomeOfficeBilledtoSelfAdministeredviaClaimFacts
          - BillingTypeHomeOfficeBilledtoSelfAdministeredviaZeus
          - BillingTypeListBillCombotoHomeOfficeBilled
          - BillingTypeListBillCombotoSelfAdminCombo
          - BillingTypeListBillCombotoSelfAdminviaZeus
          - BillingTypeSelfAdminBilledtoHomeOfficeBilled
          - BillingTypeSelfAdminBilledtoListBillCombo
          - BillingTypeSelfAdminBilledtoSelfAdminCombo
          - BillingTypeSelfAdminCombotoHomeOfficeBilled
          - BillingTypeSelfAdminCombotoListBillCombo
          - BillingTypeSelfAdminCombotoSelfAdminviaClaimFacts
          - BillingTypeSelfAdminCombotoSelfAdminviaZeus
          - BillingTypeListBillCombotoSelfAdminviaClaimFacts
          - Classifications
          - DefinitionOfAnEligibleEmployee
          - DependentAgeLimits
          - DependentCoverage
          - HourlyWorkRequirements
          - LeaveAndLayoffProvision
          - ReDeterminationDateForSalaryBasedCoverages
          - ReEnrollment
          - TerminationWording
          - WaitingPeriod
          - EffectiveDateofInforceCoverage
          - RatesRateChanges
          - DomesticPartnership
          - EarningsDefinitionforSalaryBasedCoverages
          - BillingChangesNBPlanEffectiveDate
          - Other
    inline_response_200:
      type: object
      properties:
        transmission_guid:
          type: string
          example: 030c89b1-8732-492b-b69a-2239e14264e5
        status:
          type: string
          example: Success
    Employer_plan_anniversary:
      type: object
      properties:
        anniversary_month:
          type: string
          description: The month of the policy holders anniversary.
          example: "09"
        anniversary_day_of_month:
          type: string
          description: The day of the policy holders anniversary.
          example: "01"
    Employer_contact_information:
      type: object
      properties:
        member_services_phone:
          type: string
          description: Describes the phone number of the contact on file for the policy holder.
          example: "1234567890"
        contact_person:
          type: string
          description: Describes the name of the person on file for the policy holder.
          example: John Smith
        contact_email:
          type: string
          description: Email address of the contact person
          example: John_Smith@ymail.com
    Event_event_type_code:
      type: object
      properties:
        $:
          $ref: '#/components/schemas/EventType'
      description: It describes the things that are happening / taking place that are of importance.
    Event_event_type_reason_code:
      type: object
      properties:
        $:
          $ref: '#/components/schemas/EventTypeReason'
      description: "A cause, explanation, or justification for an action or event."
    PlanBenefit_plan_state_code:
      type: object
      properties:
        state_code:
          $ref: '#/components/schemas/StateProvince'
      description: Plan State code.
    PlanBenefit_benefit_plan_identifier:
      type: object
      properties:
        benefit_plan:
          type: string
          description: Three character coverage code to identify the coverage
          example: DEN
        benefit_provision:
          type: string
          description: Instance of a coverage.
          example: "01"
        benefit_plan_id:
          type: string
          description: Instance id within a coverage instance. Possible values are A thru Z or blank.
          example: A
        benefit_identifier:
          type: string
          description: "Class identifier the benefit belongs to. If found under multiple classes, the identifier starts with 9 followed by 3 digits. For example 9002. The 2 at the end indicates the number of classes the benefit is part of."
          example: "0001"
        benefit_class_identifiers:
          type: array
          items:
            $ref: '#/components/schemas/AssociatedClass'
    PlanBenefit_coverage_dependency:
      type: object
      properties:
        coverage_depended_benefit_plan_identifier:
          type: string
          description: The fields will show if the coverage has a dependency. i.e. Child can't elect life without member elections. Dental and Vision are tied together etc.
          example: Guardian Dental
        coverage_depended_member_benefit_plan_identifier:
          type: string
          description: Provides the member benefit plan identifier that this benefit is depended on.
          example: MOL01
        coverage_depended_on_member_election:
          type: string
          description: Indicates if the coverage is dependent on member coverage.
        coverage_dependency_type:
          type: string
          example: EMPLOYEE
          enum:
          - EMPLOYEE
          - EMPLOYEE_DEPENDENT
          - EMPLOYEE_SPOUSE
          - EMPLOYEE_CHILDREN
          - EMPLOYEE_FAMILY
          - EMPLOYEE_2_DEPENDENT
          - SPOUSE_ONLY
          - SPOUSE_DEPENDENT
          - SPOUSE_CHILDREN
          - CHILD_ONLY
          - VOLUME_MUST_MATCH
    PlanBenefit_dependent_child_age_limit:
      type: object
      properties:
        age_limit:
          type: string
          description: First limiting age before student status is requested upon.
          example: "20"
        student_age_limit:
          type: string
          description: "If student age limit is not specified, it is assumed to be the same as AgeLimit above."
          example: "26"
        student_age_limit_termination_rule:
          type: string
          description: Describes when a dependent who is a full time student covered in this EligibilityGroup should be removed from the enrollment due to hitting the student age limit.
          example: END_OF_MONTH_FOLLOWING_LIMIT_AGE
          enum:
          - END_OF_MONTH_FOLLOWING_LIMIT_AGE
          - END_OF_THE_FOLLOWING_MONTH_AFTER_LIMIT_AGE
          - END_OF_MONTH_FOLLOWING_TERMINATION_RULE
          - END_OF_YEAR_FOLLOWING_LIMIT_AGE
          - LIMIT_AGE
        age_limit_termination_age:
          type: string
          description: Describes when a dependent covered in this EligibilityGroup should be removed from the enrollment due to hitting the age limit.
          example: END_OF_MONTH_FOLLOWING_LIMIT_AGE
          enum:
          - END_OF_MONTH_FOLLOWING_LIMIT_AGE
          - END_OF_THE_FOLLOWING_MONTH_AFTER_LIMIT_AGE
          - END_OF_MONTH_FOLLOWING_TERMINATION_RULE
          - END_OF_YEAR_FOLLOWING_LIMIT_AGE
          - LIMIT_AGE
    PlanBenefit_disability_benefit_std_duration_weeks:
      type: object
      properties:
        sickness_duration_weeks:
          type: string
          description: Sickness duration count in weeks
        accident_duration_weeks:
          type: string
          description: Accident duration count in weeks
      description: Required for STD plans.
    PlanBenefit_disability_benefit_elimination_period:
      type: object
      properties:
        elimination_days_due_to_sickness:
          type: string
          description: Elimination period due to sickness.
        elimination_days_due_to_accident:
          type: string
          description: Elimination period due to an accident.
    PlanBenefit_disability_benefit_ltd_duration_type:
      type: object
      properties:
        sickness_duration_type:
          type: string
          description: Sickess duration type
          example: TO_AGE_65
          enum:
          - TO_AGE_65
          - LIFETIME
          - OTHER
          - TO_AGE_65_ADEA
          - TO_AGE_67_ADEA
          - TO_AGE_70_ADEA
          - TO_AGE_67
          - TO_AGE_70
          - 65_5_70_ADEA
          - FIRST_OF_2_YRS_OR_AGE_70
          - FIRST_OF_5_YRS_OR_AGE_70
          - FIRST_OF_10_YRS_OR_AGE_70
        accident_duration_type:
          type: string
          description: Accident duration type
          example: TO_AGE_65
          enum:
          - TO_AGE_65
          - LIFETIME
          - OTHER
          - TO_AGE_65_ADEA
          - TO_AGE_67_ADEA
          - TO_AGE_70_ADEA
          - TO_AGE_67
          - TO_AGE_70
          - 65_5_70_ADEA
          - FIRST_OF_2_YRS_OR_AGE_70
          - FIRST_OF_5_YRS_OR_AGE_70
          - FIRST_OF_10_YRS_OR_AGE_70
      description: Required for LTD plans
    PlanBenefit_disability_benefit_definition_of_disability:
      type: object
      properties:
        definition:
          type: string
          description: The requirments that must be met in order to be considered disabled. 
          example: OWN_OCC_ANY_OCC_MO_BEN
          enum:
          - OWN_OCC_ANY_OCC_MO_BEN
          - OWN_OCC_ADL_MO_BEN
          - OWN_OCC_EXTENDED_OWN_OCC
          - IMMEDIATE_ANY_OCC
          - ADL_ONLY_BASIC_ABILITY_GUARD
          - EXT_OWN_OCC_SPECIALTY
          - OWN_OCC_ANY_OCC_MO_BEN_OR_DEF
          - OWN_OCC_EXTEND_OWN_OCC_OR_DEF
          - IMMEDIATE_ANY_OCC_OR_DEF
          - EXT_OWN_OCC_SPECIALTY_OR_DEF
          - EXT_OWN_OCC_LEGAL
          - EXT_OWN_OCC_LEGAL_OR_DEF
        months:
          type: string
          description: Months.
          example: "10"
    PlanBenefit_disability_benefit_rehabilitation:
      type: object
      properties:
        rehab_type:
          type: string
          description: The type of rehabilitation. 
          example: MANDATORY
          enum:
          - ENHANCED
          - MANDATORY
        rehab_percentage:
          type: string
          description: Employees entitelement of prior benefit amount.
          example: "19.00"
    PlanBenefit_disability_benefit_survivor:
      type: object
      properties:
        survivor_duration:
          type: string
          description: Number of months survivor benefit is paid .
          example: "5"
        survivor_payment:
          type: string
          description: How the survivor benefit is paid
          example: ESTATE_PAYABLE_LUMP_SUM
          enum:
          - ESTATE_PAYABLE_LUMP_SUM
          - ESTATE_PAYABLE_MONTHLY_PAYOUT
          - ELIGIBLE_SURVIVOR_ONLY_LUMP_SUM
          - ELIGIBLE_SURVIVOR_ONLY_MONTHLY_PAYOUT
        survivor_basis:
          type: string
          description: If the survivor benefit is paid based on net or gross income. 
          example: NET
          enum:
          - NET
          - GROSS
    PlanBenefit_disability_benefit_cola:
      type: object
      properties:
        fixed_percentage:
          type: string
          description: Fixed percentage for cost of living adjustment benefit.
          example: "50.00"
        half_cpi_to_max_percentage:
          type: string
          description: Maximum percentage increase based on consumer price index.
          example: "45.00"
        adjust_ct:
          type: string
          description: Count of adjustments.
          example: ct
        delayed_months:
          type: string
          description: Number of months cost of living adjustment benefit is delayed.
          example: "06.00"
        cola_tied_to_adl:
          type: string
          description: Whether cost of living adjustment benefit is tied to activities of daily living.
          example: "34"
    PlanBenefit_disability_benefit:
      type: object
      properties:
        tax_liability:
          type: string
          description: "Whether the Tax liability is pre, post or variable"
          enum:
          - PRE_TAX
          - POST_TAX
          - VARIABLE
        W2_FICA_reporting:
          type: string
          description: Displays if a W2 is received from Guardian. 
          example: ELIMINATION_PERIOD_IS_WAIVED
          enum:
          - NO_W2_REPORTING
          - MEMBER_RECEIVES_W2_AND_GUARDIAN_PAYS_FICA
          - MEMBER_RECEIVES_W2_AND_NO_FICA_TO_EMPLOYER
          - SUPPRESS_TAX_REPORT_AND_W2_SERVICES
        definition_of_disability:
          $ref: '#/components/schemas/PlanBenefit_disability_benefit_definition_of_disability'
        limitations:
          type: array
          items:
            $ref: '#/components/schemas/disabilityBenefit_limitations'
        rehabilitation:
          $ref: '#/components/schemas/PlanBenefit_disability_benefit_rehabilitation'
        survivor:
          $ref: '#/components/schemas/PlanBenefit_disability_benefit_survivor'
        cola:
          $ref: '#/components/schemas/PlanBenefit_disability_benefit_cola'
        ltd_riders:
          type: array
          items:
            $ref: '#/components/schemas/disabilityBenefit_ltd_riders'
        std_duration_weeks:
          $ref: '#/components/schemas/PlanBenefit_disability_benefit_std_duration_weeks'
        first_day_hospital:
          type: string
          description: Waive elimination period for hospital confinement indicator.
          example: ELIMINATION_PERIOD_IS_WAIVED
          enum:
          - ELIMINATION_PERIOD_IS_WAIVED
          - ELIMINATION_PERIOD_IS_NOT_WAIVED
          - ELIMINATION_PERIOD_IS_WAIVED_FOR_MATERNITY
        elimination_period:
          $ref: '#/components/schemas/PlanBenefit_disability_benefit_elimination_period'
        ltd_duration_type:
          $ref: '#/components/schemas/PlanBenefit_disability_benefit_ltd_duration_type'
        
        

    PlanBenefit_termination_info:
      type: object
      properties:
        termination_effective_date:
          type: string
          example: 12/31/2021
        termination_rule:
          type: string
          example: ON_EMPLOYEE_TERMINATION
          enum:
          - ON_EMPLOYEE_TERMINATION
          - LAST_DAY_OF_MONTH_OF_EMPLOYEE_TERMINATION
          - DETERMINED_AT_ENROLLMENT_LEVEL
          - END_OF_MONTH
          - LAST_DAY_WORKED_FOR_ALL_COVERAGES
          - END_OF_MONTH_FOR_DENTAL_AND_VISION_ALL_OTHER_COVERAGES_LAST_DAY_WORKED
    PlanBenefit_redetermination_date:
      type: object
      properties:
        redetermination_date_one:
          type: string
        redetermination_date_two:
          type: string
        redetermination_date_three:
          type: string
        redetermination_date_four:
          type: string
      description: Refers to calendar date that is used to recalculate the volume of salary based benefits.
    Deductible_individual_diminishing_deductible:
      type: object
      properties:
        Year_2:
          type: string
          example: "20"
        Year_3:
          type: string
          example: "20"
        Year_4:
          type: string
          example: "20"
    AdditionalBenefits_pre_existing_code:
      type: object
      properties:
        lookback:          
          type: string
          description: Look back period for pre-existing
          example: "3"
        limiting_period:
          type: string
          description: Limiting period for pre-existing
          example: "12"
        treatment_free:
          type: string
          description: Treatment free period for pre-existing
          example: "21"
        pre_existing_limitation:
          type: string
          description: Pre-existing definition
          example: WAIVED
          enum:
          - WAIVED
          - SIX_MONTHS_RUNNING
          - EXCLUSION
          - LIMITATION
    AdditionalBenefits_portability:
      type: object
      properties:
        portability_included:
          type: string
          example: "YES"
          enum:
          - "YES"
          - "NO"
          - YES_WITH_EVIDENCE
          - YES_WITHOUT_EVIDENCE
          - YES_WITH_EVIDENCE_INCLUDING_ADD
          - YES_WITHOUT_EVIDENCE_INCLUDING_ADD
          - YES_WITH_EVIDENCE_INCLUDING_VADD
          - YES_WITHOUT_EVIDENCE_INCLUDING_VADD
        up_to_age:
          type: string
          description: Portability up to age
          example: "50"
        port_days_override:
          type: string
          description: Port Days Override. Applicable only for CIM.
          example: "100"
        conversion: 
          type: string
          description: The type of conversion or portability for a benefit.
          enum:
          - PORTABILITY_WITH_EVIDENCE_STANDARD_ENTRY
          - PORTABILITY_WITHOUT_EVIDENCE
          - PORT_WITH_EVIDENCE_INCLUDING_AD&D
          - PORT_WITHOUT_EVIDENCE_INCLUDING_AD&D
          - NO_PORTABILITY
          - GROUP_CONVERSION_TRUST
          - GROUP_CONVERSION_TRUST_WITH_DISABILITY_OPTION
          - INDIVIDUAL_DISABILITY_CONVERSION
    AdditionalBenefits_accident_benefit:
      type: object
      properties:
        benefit_amount_type:
          type: string
          description: "When AD&D benefit exists, this returns AD&D benefit amount."
          enum:
          - ADD_EMPLOYEE_BENEFIT_AMOUNT
          - ADD_SPOUSE_BENEFIT_AMOUNT
          - ADD_CHILD_BENEFIT_AMOUNT
        benefit_amount:
          type: string
          description: Actual amount
          example: "10000"
    AdditionalBenefits_wellbeing:
      type: object
      properties:
        visits:
          type: string
          description: Number of visits allowed
          example: THREE
          enum:
          - THREE
          - FIVE
    Attachment_Format:
      type: object
      properties:
        $:
          $ref: '#/components/schemas/DocumentFormat'
      description: It describes the format of the document.
    EmployerNB_guard_o_matic_information_for_eft:
      type: object
      properties:
        guard_o_matic:
          type: boolean
          description: Guard O Matic Information for EFT
          example: true
        account_number:
          type: string
          description: Account number required requirements - Situational - if when GuardOMatic is true.
          example: "4567895647"
        transit_number:
          type: string
          description: Transit number required requirements - Situational - if when GuardOMatic is true.
          example: ""
        bank_name:
          type: string
          description: Bank Name required requirements - Situational - if when GuardOMatic is true.
          example: ""
    EmployerNB_applied_for_guardian_benefits_before:
      required:
      - applied_guardian_benefits
      type: object
      properties:
        applied_guardian_benefits:
          type: boolean
          description: Describes whether they applied for guardian benefits before.
          example: true
        master_agreement_number:
          type: string
          example: ""
    EmployerNB_workers_compensation:
      type: object
      properties:
        present_carrier_name:
          type: string
          example: ""
        anyone_not_covered:
          type: boolean
          example: true
        list_owner_partner:
          type: string
          example: ""
      description: Required requirements - Situational - if LTD or STD is an elected coverage.
    EmployerNB_cobra_participants:
      type: object
      properties:
        cobra_participants:
          type: boolean
          description: Whether it is Cobra participants.
          example: true
        participant:
          type: array
          items:
            $ref: '#/components/schemas/ParticipantNB'
    EmployerNB_health_related_information:
      type: object
      properties:
        are_any_employees_not_actively_at_work:
          type: string
          description: Is the empolyee not actively at work details.
          example: ""
      description: "Requirements - Situational - Required if STD, LTD or LIFE coverage is elected."
    EmployerNB_master_application_signature_owner:
      required:
      - first_name
      - last_name
      type: object
      properties:
        first_name:
          type: string
          example: Lucent
        last_name:
          type: string
          example: Mary
        contact_email:
          type: string
          example: lucent.mary@glic.com
        member_services_phone:
          type: string
          example: ""
    EmployerNB_master_application_signature:
      required:
      - owner
      - signature
      type: object
      properties:
        signature:
          type: string
          example: ""
        owner:
          $ref: '#/components/schemas/EmployerNB_master_application_signature_owner'
    EmployerNB_employees:
      required:
      - number_of_eligible_employees
      - number_of_employees
      type: object
      properties:
        number_of_employees:
          type: string
          example: "10"
        number_of_eligible_employees:
          type: string
          example: "5"
    EmployerNB_enrollment:
      required:
      - enrollment_end_date
      type: object
      properties:
        enrollment_begin_date:
          type: string
          description: Format of date should be YYYY-MM-DD.
          example: 11-02
        enrollment_end_date:
          type: string
          description: Format of date should be YYYY-MM-DD.
          example: 12-22
    EmployerNB_domestic_partner:
      required:
      - coverage_offered_to_children_of_domestic_partner
      - coverage_offered_to_domestic_partner
      type: object
      properties:
        coverage_offered_to_domestic_partner:
          type: boolean
          example: true
        coverage_offered_to_children_of_domestic_partner:
          type: boolean
          example: true
        plan_sitused_in_california:
          type: string
          description: Requirements - Situational
          example: Registered
          enum:
          - Registered
          - RegisteredAndNonRegistered
        plan_sitused_in_virginia:
          type: string
          description: Requirements - Situational
          example: SameSex
          enum:
          - SameSex
          - OppositeSex
    EmployerNB_dependent_child_age_limit:
      type: object
      properties:
        no_dependent_coverage:
          type: string
          example: ""
        student_age_limit:
          type: string
          description: "If student age limit is not specified, it is assumed to be the same as AgeLimit above."
          example: ""
        age_limit:
          type: string
          description: First limiting age before student status is requested upon.
          example: ""
    EmployerNB_cobra:
      type: object
      properties:
        members_currently_on_cobra:
          type: string
          example: ""
        planholder_administering:
          type: boolean
          example: true
        company_administering:
          type: string
          description: Only needed if PlanholderAdministering is false/null/blank.
          example: ""
    EmployerNB_open_enrollments:
      required:
      - open_enrollment
      type: object
      properties:
        open_enrollment:
          type: boolean
          description: Indicates if the policyholder will have OpenEnrollment.
          example: true
        open_enrollment_from_date:
          type: string
          description: Format should be MM-DD. Requirements - Situational - required If OpenEnrollment is true.
          example: 05-21
        open_enrollment_to_date:
          type: string
          description: Format should be MM-DD. Requirements - Situational - required If OpenEnrollment is true.
          example: 06-25
        effective_date:
          type: string
          description: When coverage will be effective during Open enrollment. Format should be MM-DD. Requirements - Situational - required If OpenEnrollment is true.
          example: 05-21
    CoverageNB_dental_orthodontia:
      type: object
      properties:
        orthodontia_coinsurance_percent:
          type: string
        orthodontia_maximum_amount:
          type: string
    CoverageNB_dental_maximum_rollover:
      type: object
      properties:
        threshold:
          type: string
        rollover_amount:
          type: string
        in_network_only_rollover:
          type: string
        account_limit:
          type: string
    CoverageNB_dental:
      required:
      - contribution
      - product_descriptor
      type: object
      properties:
        product_descriptor:
          type: string
          example: ""
        plan_type:
          type: string
          example: ""
        plan_code:
          type: string
          example: ""
        pponap_number:
          type: string
          example: ""
        dhmo_reside:
          type: array
          items:
            $ref: '#/components/schemas/DHMOResideNB'
        contribution:
          $ref: '#/components/schemas/ContributionNB'
        co_insurance:
          type: array
          items:
            $ref: '#/components/schemas/CoInsuranceNB'
        deductible:
          type: array
          items:
            $ref: '#/components/schemas/DeductibleNB'
        orthodontia:
          $ref: '#/components/schemas/CoverageNB_dental_orthodontia'
        annual_maximum:
          type: string
        maximum_rollover:
          $ref: '#/components/schemas/CoverageNB_dental_maximum_rollover'
        claims_payment_basis:
          type: array
          items:
            $ref: '#/components/schemas/ClaimsPaymentBasisNB'
        rates:
          $ref: '#/components/schemas/RatesNB'
    CoverageNB_vision_service_frequencies:
      type: object
      properties:
        eye_exams:
          type: string
        lenses_benefit:
          type: string
        contact_lenses:
          type: string
        frames:
          type: string
    CoverageNB_vision_frames:
      type: object
      properties:
        retail_max:
          type: string
    CoverageNB_vision:
      required:
      - contribution
      - lock_in_lock_out
      - product_descriptor
      - rates
      type: object
      properties:
        product_descriptor:
          type: string
        plan_type:
          type: string
        plan_network:
          type: string
        lock_in_lock_out:
          type: string
        contributor_type:
          $ref: '#/components/schemas/ContributionNB'
        participation:
          type: string
        co_pay:
          type: string
        service_frequencies:
          $ref: '#/components/schemas/CoverageNB_vision_service_frequencies'
        reimbursement_schedule:
          type: array
          items:
            $ref: '#/components/schemas/ReimbursementScheduleNB'
        frames:
          $ref: '#/components/schemas/CoverageNB_vision_frames'
        rates:
          $ref: '#/components/schemas/RatesNB'
    CoverageNB_long_term_disability:
      required:
      - product_descriptor
      - rates
      type: object
      properties:
        product_descriptor:
          type: string
        coverage_amount_percent:
          type: string
        coverage_amount_max:
          type: string
        maximum_payment_period:
          type: string
        accident_benefits_begin:
          type: string
        illness_benefits_begin:
          type: string
        guarantee_issue:
          type: string
        pre_existing:
          $ref: '#/components/schemas/PreExistingNB'
        premium_waived_if_disabled:
          type: string
        benefit_earnings_definition:
          $ref: '#/components/schemas/EarningsDefinitionNB'
        employees_reside:
          $ref: '#/components/schemas/EmployeesResideNB'
        rates:
          type: array
          items:
            $ref: '#/components/schemas/RatesLTDSTDNB'
    CoverageNB_short_term_disability:
      required:
      - product_descriptor
      - rates
      type: object
      properties:
        product_descriptor:
          type: string
        coverage_amount_percent:
          type: string
        coverage_amount_max:
          type: string
        maximum_payment_period:
          type: string
        accident_benefits_begin:
          type: string
        illness_benefits_begin:
          type: string
        pre_existing:
          $ref: '#/components/schemas/PreExistingNB'
        benefit_earnings_definition:
          $ref: '#/components/schemas/EarningsDefinitionNB'
        w2fica:
          type: string
          enum:
          - NoW2Reporting
          - MemberReceivesW2AndNoFICAToEmployer
        employees_reside:
          $ref: '#/components/schemas/EmployeesResideNB'
        rates:
          type: array
          items:
            $ref: '#/components/schemas/RatesLTDSTDNB'
    CoverageNB_life_age_reductions:
      type: object
      properties:
        age_threshold:
          type: string
        percentage_reduction:
          type: string
    CoverageNB_life_rates:
      type: object
      properties:
        employee:
          type: integer
      description: Rates for life.
    CoverageNB_life:
      required:
      - product_descriptor
      - rates
      type: object
      properties:
        product_descriptor:
          type: string
        employee_benefit:
          type: string
        accidental_death_and_dismemberment:
          type: boolean
        conversion:
          type: boolean
        accelerated_life_benefit:
          type: boolean
        waiver_of_premiums:
          type: boolean
        age_reductions:
          $ref: '#/components/schemas/CoverageNB_life_age_reductions'
        rates:
          $ref: '#/components/schemas/CoverageNB_life_rates'
    CoverageNB_add_rates:
      type: object
      properties:
        employee:
          type: integer
      description: "Rates for ADD. Required to have 3 decimal places for ADD, requirment for entry in Phoenix."
    CoverageNB_add:
      required:
      - rates
      type: object
      properties:
        rates:
          $ref: '#/components/schemas/CoverageNB_add_rates'
    CoverageNB_billing_preferences:
      required:
      - bill_delivery
      - billing_frequency
      - send_bills
      type: object
      properties:
        billing_frequency:
          type: string
          enum:
          - Monthly
          - Quarterly
          - SemiYearly
          - Yearly
        bill_delivery:
          type: string
          enum:
          - Electronic
          - StandardListBill
          - SubtotalBilling
          - Class
        send_bills:
          type: string
          enum:
          - IndividualDivisions
          - MainBillingOffice
    CoverageNB_delivery_of_plan_materials:
      type: object
      properties:
        include_erisa_summary_in_certificate_booklet:
          type: boolean
        administration_kit:
          type: boolean
          description: Requirements - Situational - if when STD has sold.
        administration_kit_mailed_to:
          type: string
          description: Requirements - Situational.
          enum:
          - PlanHolder
          - Broker
        dental_and_vision_id_card:
          type: string
          enum:
          - PlanLevel
          - MemberLevel
        shipped:
          type: string
          enum:
          - MemberHome
    Employer_1_guard_o_matic_information_for_eft:
      type: object
      properties:
        guard_o_matic:
          type: boolean
          description: Guard O Matic Information for EFT
          example: true
        account_number:
          type: string
          description: Account number required requirements - Situational - if when GuardOMatic is true.
          example: "4567895647"
        transit_number:
          type: string
          description: Transit number required requirements - Situational - if when GuardOMatic is true.
          example: ""
        bank_name:
          type: string
          description: Bank Name required requirements - Situational - if when GuardOMatic is true.
          example: ""
    Employer_1_cobra_participants:
      type: object
      properties:
        cobra_participants:
          type: boolean
          description: Whether it is Cobra participants.
          example: true
        participant:
          type: array
          items:
            $ref: '#/components/schemas/Participant'
    Employer_1_applied_for_guardian_benefits_before:
      required:
      - applied_guardian_benefits
      type: object
      properties:
        applied_guardian_benefits:
          type: boolean
          description: Describes whether they applied for guardian benefits before.
          example: true
        master_agreement_number:
          type: string
          example: ""
    Employer_1_workers_compensation:
      type: object
      properties:
        present_carrier_name:
          type: string
          example: ""
        anyone_not_covered:
          type: boolean
          example: true
        list_owner_partner:
          type: string
          example: ""
      description: Required requirements - Situational - if LTD or STD is an elected coverage and have an event for AddCoverage.
    Employer_1_health_related_information:
      type: object
      properties:
        are_any_employees_not_actively_at_work:
          type: string
          description: Is the empolyee not actively at work details.
          example: ""
      description: "Requirements - Situational - Required if STD, LTD or LIFE coverage is elected."
    Employer_1_master_application_signature_owner:
      required:
      - first_name
      - last_name
      type: object
      properties:
        first_name:
          type: string
          example: Lucent
        last_name:
          type: string
          example: Mary
        contact_email:
          type: string
          example: lucent.mary@glic.com
        member_services_phone:
          type: string
          example: ""
    Employer_1_master_application_signature:
      required:
      - owner
      - signature
      type: object
      properties:
        signature:
          type: string
          example: ""
        owner:
          $ref: '#/components/schemas/Employer_1_master_application_signature_owner'
    Employer_1_employees:
      required:
      - number_of_eligible_employees
      - number_of_employees
      type: object
      properties:
        number_of_employees:
          type: string
          example: "10"
        number_of_eligible_employees:
          type: string
          example: "5"
    Employer_1_enrollment:
      required:
      - enrollment_end_date
      type: object
      properties:
        enrollment_begin_date:
          type: string
          description: Format of date should be YYYY-MM-DD.
          example: 11-02
        enrollment_end_date:
          type: string
          description: Format of date should be YYYY-MM-DD.
          example: 12-22
    Employer_1_domestic_partner:
      required:
      - coverage_offered_to_children_of_domestic_partner
      - coverage_offered_to_domestic_partner
      type: object
      properties:
        coverage_offered_to_domestic_partner:
          type: boolean
          example: true
        coverage_offered_to_children_of_domestic_partner:
          type: boolean
          example: true
        plan_sitused_in_california:
          type: string
          description: Requirements - Situational
          example: Registered
          enum:
          - Registered
          - RegisteredAndNonRegistered
        plan_sitused_in_virginia:
          type: string
          description: Requirements - Situational
          example: SameSex
          enum:
          - SameSex
          - OppositeSex
    Employer_1_dependent_child_age_limit:
      type: object
      properties:
        no_dependent_coverage:
          type: string
          example: ""
        student_age_limit:
          type: string
          description: "If student age limit is not specified, it is assumed to be the same as AgeLimit above."
          example: ""
        age_limit:
          type: string
          description: First limiting age before student status is requested upon.
          example: ""
    Employer_1_cobra:
      type: object
      properties:
        members_currently_on_cobra:
          type: string
          example: ""
        planholder_administering:
          type: boolean
          example: true
        company_administering:
          type: string
          description: Only needed if PlanholderAdministering is false/null/blank.
          example: ""
    Employer_1_open_enrollments:
      required:
      - open_enrollment
      type: object
      properties:
        open_enrollment:
          type: boolean
          description: Indicates if the policyholder will have OpenEnrollment.
          example: true
        open_enrollment_from_date:
          type: string
          description: Format should be MM-DD. Requirements - Situational - required If OpenEnrollment is true.
          example: 05-21
        open_enrollment_to_date:
          type: string
          description: Format should be MM-DD. Requirements - Situational - required If OpenEnrollment is true.
          example: 06-25
        effective_date:
          type: string
          description: When coverage will be effective during Open enrollment. Format should be MM-DD. Requirements - Situational - required If OpenEnrollment is true.
          example: 05-21
    Coverage_dental_orthodontia:
      type: object
      properties:
        orthodontia_coinsurance_percent:
          type: string
        orthodontia_maximum_amount:
          type: string
    Coverage_dental_maximum_rollover:
      type: object
      properties:
        threshold:
          type: string
        rollover_amount:
          type: string
        in_network_only_rollover:
          type: string
        account_limit:
          type: string
    Coverage_vision_service_frequencies:
      type: object
      properties:
        eye_exams:
          type: string
        lenses_benefit:
          type: string
        contact_lenses:
          type: string
        frames:
          type: string
    Coverage_vision_frames:
      type: object
      properties:
        retail_max:
          type: string
    Coverage_life_age_reductions:
      type: object
      properties:
        age_threshold:
          type: string
        percentage_reduction:
          type: string
    Coverage_life_rates:
      type: object
      properties:
        employee:
          type: integer
      description: Rates for life.
    Coverage_add_rates:
      type: object
      properties:
        employee:
          type: integer
      description: "Rates for ADD. Required to have 3 decimal places for ADD, requirment for entry in Phoenix."
    Coverage_billing_preferences:
      required:
      - bill_delivery
      - billing_frequency
      - send_bills
      type: object
      properties:
        coverage_event_id:
          type: string
          example: ""
        billing_frequency:
          type: string
          enum:
          - Monthly
          - Quarterly
          - SemiYearly
          - Yearly
        bill_delivery:
          type: string
          enum:
          - Electronic
          - StandardListBill
          - SubtotalBilling
          - Class
        send_bills:
          type: string
          enum:
          - IndividualDivisions
          - MainBillingOffice
    Coverage_delivery_of_plan_materials:
      type: object
      properties:
        coverage_event_id:
          type: string
          example: ""
        include_erisa_summary_in_certificate_booklet:
          type: boolean
          description: Requirements - Always Required.
        administration_kit:
          type: boolean
          description: Requirements - Situational - if STD is elected coverage and have an event for AddCoverage.
        administration_kit_mailed_to:
          type: string
          description: Requirements - Situational.
          enum:
          - PlanHolder
          - Broker
        dental_and_vision_id_card:
          type: string
          description: Requirements - Situational - If Dental or Vision coverage elected.
          enum:
          - PlanLevel
          - MemberLevel
        shipped:
          type: string
          enum:
          - MemberHome
    disabilityBenefit_ltd_riders_rider_guidelines:
      type: object
      properties:
        months:
          type: string
          description: Duration of rider.
          example: "03"
        monthly_max:
          type: string
          description: Monthly maximum of rider.
          example: "12"
        overall_max:
          type: string
          description: Overall maximum of rider.
          example: "3"
        permanent_or_total_disability_months:
          type: string
          description: Number of permanent or total disability months the benefit is avialable.
          example: "4"
      description: Rider Guidelines.
      example: Data
    AdditionalBenefitsLifeBenfit_waiver_of_premium:
      $ref: '#/components/schemas/WaiverOfPremium'
    AdditionalBenefitsLifeBenfit_accelerated_life_benefit:
      $ref: '#/components/schemas/AcceleratedLifeBenefit'

    Transmission_2:
      required:
      - creation_date_time
      - renewal_documents
      - renewal_effective_date
      - schema_version_identifier
      - sender_name
      - transmission_guid
      type: object
      properties:
        transmission_guid:
          type: string
          description: Global Unique identifier created by the originator for this instance of the electronic transmission.
          example: 030c89b1-8732-492b-b69a-2239e14264e5
        sender_name:
          type: string
          description: Name of the company sending electronic benefit records on behalf of a group.
          example: The Guardian Life Insurance Company of America
        creation_date_time:
          type: string
          description: UTC date and time the transmission was created.
          example: 2019-08-23T15:36:40.881
        schema_version_identifier:
          type: string
          description: Identifies the version of the standard that is being adhered to in this data set.
          example: 1.0.0
        renewal_effective_date:
          type: string
          description: Effective date of rate.
          example: 2019-08-23
        renewal_documents:
          type: array
          items:
            $ref: '#/components/schemas/Attachment_1'
    Attachment_1:
      required:
      - data
      - format
      - name
      type: object
      properties:
        name:
          type: string
          description: Name of the document.
          example: Dental renewal rates
        format:
          $ref: '#/components/schemas/DocumentFormat_1'
        type:
          type: string
          description: Category of renewal document.
        data:
          type: string
          description: Document data will be in binary format.
          format: byte
        coverages:
          type: array
          items:
            $ref: '#/components/schemas/CoverageType_1'
    DocumentFormat_1:
      type: string
      description: It describes the format of the document.
      example: PDF
      enum:
      - PDF
      - DOC
      - DOCX
      - TXT
      - XLS
      - XLSX
      - XLSB
      - RNWL
      - TIF
    CoverageType_1:
      type: string
      description: Type of Coverage.
      enum:
      - Dental
      - Vision
      - STD
      - BasicLife
      - LongTerm
      - PaidLeave
      - Critical
      - Accident
      - Cancer
      - HospitalIndemnity
      - VoluntaryLife
      - AbsenceSolutions
      - WellBeing