---
title: "Coverages"
url: "https://developers.zinnia.com/apis/illustration-3-0-8/versions/b96a49c1-73c5-46d3-8968-fe603081d524/schemas/Coverage-Collection-V4"
---

> Full API specification: https://developers.zinnia.com/apis/illustration-3-0-8/versions/b96a49c1-73c5-46d3-8968-fe603081d524.md

# Coverages

A collection of benefits

## OpenAPI definition

```yaml
openapi: 3.0.1
info:
  title: Illustration Generation
  version: 3.5.3
servers:
  - url: https://dev.api.zinnia.io
    description: Development
components:
  schemas:
    Participant-Collection-V4:
      title: Participants
      description: A collection of unique participants
      type: array
      items:
        title: Participant
        description: An entity with a stake in a policy
        type: object
        properties:
          issueAge:
            type: number
            format: integer
            description: Issue age
            example: 30
          participantId:
            type: string
            description: Participant id (UUID)
            example: 2ad51ecf-9923-437f-a6f0-70968e464cdb
          underwritingClass:
            type: string
            description: Underwriting class
            example: ULTRANONTOBACCO
            enum:
              - ULTRANONTOBACCO
              - ELITENONTOBACCO
              - PREFERREDNONTOBACCO
              - STANDARDNONTOBACCO
              - STANDARDTOBACCO
              - STANDARDAGGREGATE
              - SUBSTANDARDNONTOBACCO
              - SUBSTANDARDTOBACCO
              - STANDARDPLUSNONTOBACCO
              - PREFERREDTOBACCO
              - STANDARDCONVERSIONNONTOBACCO
              - STANDARDCONVERSIONTOBACCO
              - STANDARDPLUSBLEND
              - STANDARDPLUSTOBACCO
              - STANDARDBLEND
              - SUBSTANDARDBLEND
              - PREFERREDSELECTNONTOBACCO
              - PREFERREDSELECTBLEND
              - PREFERREDSELECTTOBACCO
              - PREFERREDBLEND
          subStandardRating:
            type: string
            description: Substandard rating
            example: TABLEA
            enum:
              - TABLEA
              - TABLEB
              - TABLEC
              - TABLED
              - TABLEE
              - TABLEF
              - TABLEG
              - TABLEH
              - TABLEI
              - TABLEJ
              - TABLEK
              - TABLEL
              - TABLEM
              - TABLEN
              - TABLEO
              - TABLEP
              - NONETABLE
          flatExtra:
            type: array
            description: Flat extra
            items:
              $ref: "#/components/schemas/Flat-Extra"
        required:
          - issueAge
          - participantId
      uniqueItems: true
    Flat-Extra:
      title: Flat Extra
      type: object
      properties:
        type:
          type: string
          description: Type of flat extra
          example: PERMANENT
          enum:
            - PERMANENT
            - TEMPORARY
        amount:
          type: number
          format: double
          description: Amount
          example: 1000
        duration:
          type: number
          format: integer
          description: Duration
          example: 12
        durationType:
          type: string
          description: Duration type
          example: YEARS
          enum:
            - YEARS
            - MONTHS
        startDate:
          type: string
          format: date
          pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2})
          description: Date (with pattern "yyyy-mm-dd")
          example: 2025-05-13
    Coverage-Collection-V4:
      title: Coverages
      description: A collection of benefits
      type: array
      items:
        title: Coverage
        description: A benefit conferred to a group of one or more participants
        type: object
        properties:
          coverageId:
            type: string
            description: Coverage id
            example: BASE_COVERAGE
            enum:
              - BASE_COVERAGE
              - Rider_ABRTRM
              - Rider_CTR
              - Rider_ABRCHR
              - Rider_ADR
              - Rider_WPR
              - Rider_CGR
              - Rider_GIBR
              - Rider_OPR
              - Rider_OWDR
              - Rider_WDR
              - Rider_NHR
              - Rider_ABRCRI
              - Rider_OWP
          riderYears:
            type: number
            format: integer
            example: 10
            description: Rider years
          currentAmount:
            type: number
            format: double
            example: 1000
            description: Current amount
          participants:
            $ref: "#/components/schemas/Participant-Collection-V4"
        required:
          - coverageId
```