---
title: "Options for IUL"
url: "https://developers.zinnia.com/apis/illustration-3-0-8/versions/b96a49c1-73c5-46d3-8968-fe603081d524/schemas/Options-IUL"
---

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

# Options for IUL

Options for the illustration request.

## 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:
    Options-Base:
      title: Options
      description: Fundamental Options schema. Some products may have product-specific
        Options.
      type: object
      required:
        - revisedIllustration
        - solveFor
        - paymentMode
      properties:
        revisedIllustration:
          type: boolean
          description: Whether the illustration is revised
          example: true
        solveFor:
          type: string
          description: Solve for
          example: PREMIUM
          enum:
            - PREMIUM
            - FACE
            - NO_SOLVE
        fixedCostPeriod:
          type: number
          description: Fixed cost period
          example: 10
          deprecated: true
        fixedCostPeriodOption:
          type: number
          format: integer
          description: The fixed cost period in YEARS or at AGE depending on the value of
            fixedCostPeriodUnit
          example: 65
        fixedCostPeriodUnit:
          type: string
          description: The Unit that the number in fixedCostPeriodOption represents
          example: AGE
          enum:
            - AGE
            - YEARS
        paymentMode:
          $ref: "#/components/schemas/Frequency"
        discountIndicator:
          type: string
          description: Discount indicator
          example: MULTIPRODUCT
          enum:
            - MULTIPRODUCT
            - NON
        paymentMethod:
          type: string
          description: Payment method
          example: DTCC
          enum:
            - DTCC
            - CREDITCARD
            - ACH
            - CHECK
            - EXCHANGE
            - WIRE
        premiumDuration:
          type: number
          format: integer
          description: Premium duration
          example: 10
        premiumDurationOption:
          type: string
          description: Premium duration option
          example: YEARS
          enum:
            - AGE
            - YEARS
            - MATURITY
        faceAmount:
          $ref: "#/components/schemas/Schedule-FaceAmount"
        premium:
          $ref: "#/components/schemas/Schedule-Premium"
        targetCashValueOption:
          type: string
          description: Target cash value option
          example: SPECIFY_AMOUNT
          enum:
            - SPECIFY_AMOUNT
            - ENDOWMENT
        targetCashValueAtOption:
          type: string
          enum:
            - AGE
            - YEAR
          description: Whether to use targetCashValueAge or targetCashValueYear
          example: AGE
        targetCashValueAge:
          type: number
          format: integer
          description: If target cash value should be at an age, use this. If it should be
            at a year, use targetCashValueYear. targetCashValueAtOption
            determines which is used.
          example: 10
        targetCashValueYear:
          type: number
          format: integer
          description: If target cash value should be at a year, use this. If it should be
            at an age, use targetCashValueAge. targetCashValueAtOption
            determines which is used.
          example: 10
        targetCashValueAmount:
          type: number
          format: double
          description: Target cash value amount
          example: 10000
    IUL-Shared-Options:
      title: IUL Shared Options
      description: Options shared between IUL and HIT products
      type: object
      properties:
        doli:
          type: string
          description: DOLI
          example: GPT
          enum:
            - GPT
            - CVAT
        deathBenefitOption:
          $ref: "#/components/schemas/Schedule-DBO"
        dumpInAmount:
          type: number
          format: double
          description: Dump in amount
          example: 5432.62
        juvenileReclassification:
          description: Indicates that a rating class change will occur for a juvenile upon
            reaching adulthood
          type: boolean
          example: true
        preventModifiedEndowmentContract:
          type: boolean
          example: true
          description: Whether the selected solve should attempt to prevent this policy
            from being a MEC
        illustrationBasis:
          type: string
          enum:
            - CURRENT
            - ASSUMED
            - GUARANTEED
          example: CURRENT
          description: Which scenario's premium to use as the basis for the other scenarios
      required:
        - doli
    Frequency:
      type: string
      description: Frequency
      example: DAILY
      enum:
        - DAILY
        - EVERYTWOWEEKS
        - MONTHLY
        - SEMIANNUAL
        - QUARTERLY
        - ANNUAL
        - SINGLEPAYMENT
    Schedule-FaceAmount:
      title: Face Amount Schedule
      allOf:
        - $ref: "#/components/schemas/Schedule-Base"
      properties:
        sequence:
          items:
            title: Face Amount Schedule Entry
            properties:
              value:
                example: 250000
                oneOf:
                  - type: number
                    format: double
                  - title: Face Amount Option
                    type: string
                    enum:
                      - SOLVE_FOR_TARGET_CASH_VALUE
                      - MINIMUM_NON_MEC
            required:
              - value
    Schedule-Premium:
      title: Premium Schedule
      allOf:
        - $ref: "#/components/schemas/Schedule-Base"
      properties:
        sequence:
          items:
            title: Premium Schedule Entry
            properties:
              value:
                example: 25000
                oneOf:
                  - type: number
                    format: double
                  - title: Premium Option
                    type: string
                    enum:
                      - SOLVE_FOR_TARGET_CASH_VALUE
                      - MINIMUM_PREMIUM
                      - TARGET_PREMIUM
                      - GUIDELINE_MAXIMUM_PREMIUM
                      - GUIDELINE_LEVEL_PREMIUM
                      - LEVEL_NON_MEC
            required:
              - value
    Schedule-DBO:
      title: Death Benefit Option Schedule
      allOf:
        - $ref: "#/components/schemas/Schedule-Base"
      properties:
        sequence:
          items:
            title: Death Benefit Option Schedule Entry
            properties:
              value:
                example: LEVEL
                oneOf:
                  - title: Death Benefit Option
                    type: string
                    enum:
                      - LEVEL
                      - INCREASING
                      - RETURN_OF_PREMIUM
          required:
            - value
    Schedule-Base:
      title: Generic Schedule
      description: Represents a value that changes with time. The value is assumed to
        change annually and be tied to a duration unless otherwise specified via
        the Frequency and Basis properties
      type: object
      properties:
        frequency:
          $ref: "#/components/schemas/Frequency"
        basis:
          description: Specifies how to interpret the from and through properties for each
            entry.
          type: string
          example: AGE
          enum:
            - AGE
            - DURATION
            - RETIREMENT
        sequence:
          description: Collection of entries describing the changes in value over time
          type: array
          items:
            title: Schedule Entry
            description: Represents a limited time period for which a value is constant.
            type: object
            properties:
              from:
                description: starting point for the value, inclusive
                type: integer
                minimum: 1
                example: 1
              through:
                description: ending point for the value, inclusive
                type: integer
                minimum: 1
                example: 10
            required:
              - from
              - through
          minItems: 1
      required:
        - sequence
    Options-IUL:
      title: Options for IUL
      type: object
      description: Options for the illustration request.
      allOf:
        - $ref: "#/components/schemas/Options-Base"
        - $ref: "#/components/schemas/IUL-Shared-Options"
```