---
title: "PolicyValue"
url: "https://developers.zinnia.com/apis/new-business-annuity/versions/45a989ab-c3aa-4f85-8f67-f05c41747ed7/schemas/PolicyValue"
---

> Full API specification: https://developers.zinnia.com/apis/new-business-annuity/versions/45a989ab-c3aa-4f85-8f67-f05c41747ed7.md

# PolicyValue

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: Zinnia New Business Annuity API
  version: 0.6.0
servers:
  - url: https://qa.api.zinnia.io
    description: QA Environment
  - url: https://dev.api.zinnia.io
    description: DEV Environment
  - url: https://uat.api.zinnia.io
    description: UAT Environment
  - url: https://api.zinnia.io
    description: PROD Environment
components:
  schemas:
    Withholdings:
      type: object
      required:
        - withholdingAmount
        - withholdingAmountQualifer
        - withholdingAuthority
      properties:
        withholdingAmount:
          type: string
          description: The amount to be withheld if withholding is selected
          example: "0"
        withholdingAmountQualifer:
          type: string
          description: Qualifies the withholding amount. Either as dollars or a percentage
          enum:
            - D
            - P
        withholdingAmountType:
          type: string
          description: This will be used to indicate the type of withholding information
            for this instance of the Withholding Amount.  This is in reference
            to the IRS W-4P and W-4R tax withholding forms
          enum:
            - A
            - B
            - C
            - D
            - E
            - F
            - G
            - H
        withholdingAuthority:
          type: string
          description: Defines the withholding authority for which is being withheld
          enum:
            - State
            - Federal
    PolicyValue:
      type: object
      required:
        - fedMaritalStatus
        - fedMaritalAllowance
        - stateMaritalStatus
        - stateMaritalAllowance
        - mktSegment
      properties:
        fedMaritalStatus:
          type: string
          enum:
            - "-999"
            - "1"
            - "2"
          description: Fed marital status
        fedMaritalAllowance:
          type: string
          description: Fed marital status allowance
          example: "3"
        withholding:
          type: array
          items:
            $ref: "#/components/schemas/Withholdings"
        fedRate:
          type: string
          description: Federal rate - Derived by Zinnia
          example: "1"
        stateMaritalStatus:
          type: string
          description: State Marital Status
          enum:
            - "-999"
            - "1"
            - "2"
        stateMaritalAllowance:
          type: string
          description: State marital status allowance
          example: "1"
        stateRate:
          type: string
          description: State rate - Derived by Zinnia
          example: "1"
        contribType:
          type: string
          enum:
            - "0"
            - "1"
            - "2"
            - "3"
            - "4"
            - "5"
            - "6"
            - "7"
            - "8"
            - "9"
          description: Contribution type
        mktSegment:
          type: string
          enum:
            - "0"
            - "1"
            - "2"
            - "3"
            - "4"
            - "5"
            - "6"
            - "7"
            - "8"
            - "9"
            - "10"
            - "11"
            - "12"
            - "13"
            - "14"
            - "15"
            - "16"
            - "17"
            - "18"
            - "19"
            - "20"
            - "21"
            - "22"
            - "23"
          description: Market Segment Code
        specMktSegment:
          type: string
          description: Spec Market segment
          example: "1"
        bMarkRate:
          type: string
          example: "3.5"
        deliveryMethod:
          type: string
          enum:
            - Fax
            - Email
            - Mail
          description: Delivery method derived by Zinnia
```