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

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

# PolicyHistory

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: Zinnia New Business Annuity API
  version: 0.7.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:
    AddressDetail:
      type: object
      additionalProperties: false
      required:
        - addressType
        - addressLine1
      properties:
        addressType:
          type: string
          description: Type of address
          enum:
            - RESIDENCE
            - BUSINESS
            - POBOX
            - SEASONAL
            - SECONDARY
            - MAILING
        addressLine1:
          type: string
          description: Address Line 1
        addressLine2:
          type: string
          description: Address Line 2
        addressLine3:
          type: string
          description: Address Line 3
        city:
          type: string
          description: City of residence for the prior carrier or policy owner.
        state:
          type: string
          description: state of residence for the prior carrier or policy owner.
        zipCode:
          type: string
          description: ZIP code (5 digits)
        country:
          type: string
          description: Two letter ISO Country Code
    PolicyHistory:
      type: object
      additionalProperties: false
      required:
        - amount
        - carrier
        - previousPolicyNumber
        - exchangeType
        - addressDetail
      properties:
        previousPolicyNumber:
          type: string
          description: Previous policy number in case of Exchange/Replace
        emailId:
          type: string
          description: Company email address
          example: abc@gmail.com
        carrier:
          type: string
          description: Name of the carrier.
        priorCarrierProcessLocation:
          type: string
          description: Processing location used by the prior carrier for the exchanged
            policy.
        useExistingPolicyFunds:
          type: boolean
          description: Indicates whethe existing policy funds can be used or not.
        amount:
          type: number
          description: Premium amount received for Exhange/Replace application.
          format: double
          example: 238500.5
        status:
          type: string
          description: Policy status
          enum:
            - ACTIVE
            - LAPSED
            - TERMINATED
        replacementCoverageAmount:
          type: number
          description: Represents the total amount from the existing policy being replaced.
          format: double
          example: 238500.5
        issueDate:
          type: string
          description: The official date on which the policy is issued and becomes
            effective.
          format: date
        productType:
          type: string
          description: Indicates the category of the insurance product associated with the
            policy
          enum:
            - MUTUALFUND
            - CERTIFICATEOFDEPOSIT
            - BROKERAGE
            - OTHER
            - LIFE
            - ANNUITY
        productSubType:
          type: string
          description: Subtype of the product involved in an exchange or replacement
            transaction.
          enum:
            - DISABILITY
            - FIXEDINDEXANNUITY
            - FIXEDANNUITYPRODUCTS
            - FIXEDIMMEDIATEANNUITY
            - FIXEDUNIVERSALLIFEINSURANCE
            - FIXEDWHOLELIFEINSURANCE
            - INDEXLIFE
            - INDEXVARIABLEANNUITY
            - LONGTERMCARE
            - MARKETVALUEADJUSTMENT
            - MONEYMARKETPRODUCTS
            - OFFSHOREINVESTMENTPRODUCTS
            - PENSIONPLAN
            - REGISTEREDINDEXANNUITY
            - RETIREMENTPLAN
            - TERMLIFE
            - VARIABLEANNUITYPRODUCTS
            - VARIABLEIMMEDIATEANNUITY
            - VARIABLEUNIVERSALLIFEINSURANCE
            - VARIABLEWHOLELIFEINSURANCE
            - DEFERREDINCOMEANNUITY
            - CONTINGENTDEFERREDANNUITY
        exchangeType:
          type: string
          description: Specifies the type of policy exchange or replacement transaction
            being performed.
          enum:
            - EXTERNAL1035
            - INTERNAL1035
            - EXTERNALDIRECTTRANSFER
            - INTERNALDIRECTTRANSFER
            - EXTERNALROLLOVERQUALIFIED
            - INTERNALROLLOVERQUALIFIED
            - EXTERNALROTHROLLOVER
            - INTERNALROTHROLLOVER
            - EXTERNALROTHDIRECTTRANSFER
            - INTERNALROTHDIRECTTRANSFER
            - BENEFITPROCEEDS
            - CASHCONTRIBUTIONS
            - EXTERNAL1035PARTIAL
            - INTERNAL1035PARTIAL
            - EXTERNALDIRECTTRANSFERREPLACEMENT
            - INTERNALDIRECTTRANSFERREPLACEMENT
            - CLIENTINITIATEDTRANSFER
            - BIRTHORADOPTIONREPAYMENT
        taxId:
          type: string
          description: Tax identification number of the prior carrier or contract owner.
          format: AAA-GG-SSSS
        originalCostBasis:
          type: string
          description: Original cost basis of the policy being exchanged or replaced.
        applyRateLock:
          type: string
          description: Indicator specifying whether a rate lock applies to the exchange or
            replacement.
        priorEstTransValue:
          type: number
          description: Estimated transfer value from the prior policy at the time of
            exchange.
        addressDetail:
          $ref: "#/components/schemas/AddressDetail"
        qualificationType:
          type: string
          description: Indicates the tax qualification status of the policy or account.
          enum:
            - Q401K
            - SOLO401K
            - HEALTHREIMBURSEMENT501C9
            - Q457B
            - HR10KEOGH
            - INHERITEDINDIVIDUALRETIREMENTACCOUNT
            - NONQUALIFIEDSTRETCH
            - INHERITEDROTHINDIVIDUALRETIREMENTACCOUNT
            - INDIVIDUALRETIREMENTACCOUNTREGULAR
            - INDIVIDUALRETIREMENTACCOUNTROLLOVER
            - NONQUALIFIED
            - PENSIONPLAN
            - SALARYREDUCTIONSIMPLIFIEDEMPLOYEEPENSION
            - SIMPLIFIEDEMPLOYEEPENSIONINDIVIDUALRETIREMENTACCOUNT
            - INDIVIDUALRETIREMENTACCOUNTSPOUSAL
            - INDIVIDUALRETIREMENTACCOUNTTRANSFER
            - CASHBALANCEPLANDEFINEDCONTRIBUTIONS
            - CASHBALANCEPLANDEFINEDBENEFIT
            - SOLODEFINEDBENEFIT
            - Q403B
            - Q401GFORMERLY403G
            - Q412IPLAN
            - INDIVIDUALRETIREMENTACCOUNTSIMPLE
            - ROTHINDIVIDUALRETIREMENTACCOUNT
            - ROTH401K
            - ROTH403B
            - EDUCATIONALINDIVIDUALRETIREMENTACCOUNT
            - PROFITSHARINGPLAN
            - MONEYPURCHASEPLAN
            - WELFAREBENEFITPLAN419PLAN
            - LONGTERMCARE7702B
            - NOUNITEDSTATESTAXATIONUSEDFOROFFSHOREPRODUCTS
            - Q401A
            - TEXASOPTIONALRETIREMENTPROGRAM
            - TARGETBENEFITPLAN
            - Q403BTRANSFERSONLY
            - ROTH457
            - CUSTODIALINDIVIDUALRETIREMENTACCOUNT
            - CUSTODIALROTHINDIVIDUALRETIREMENTACCOUNT
            - CUSTODIALROLLOVERINDIVIDUALRETIREMENTACCOUNT
            - CONVERTEDROTHINDIVIDUALRETIREMENTACCOUNT
            - CUSTODIALINHERITEDINDIVIDUALRETIREMENTACCOUNT
            - CUSTODIALINHERITEDROTHINDIVIDUALRETIREMENTACCOUNT
            - CUSTODIALSPOUSEINDIVIDUALRETIREMENTACCOUNT
            - CUSTODIALINDIVIDUALRETIREMENTACCOUNTSIMPLIFIEDEMPLOYEEPENSION
            - QUALIFIED
            - UNIFORMGIFTSORTRANSFERSTOMINORACT
            - CONVERTEDINDIVIDUALRETIREMENTACCOUNT
            - CORPORATEPENSION
            - GROUPTAXSHELTEREDANNUITY
            - CORPORATEDEFERREDCOMPENSATION404
            - QN457B
            - CONVERTED
            - SPOUSAL
            - CUSTODIAL
        mecIndicator:
          type: string
          description: Indicates whether the policy is classified as a Modified Endowment
            Contract (MEC) or not Default = False
          enum:
            - YES
            - NO
        internalExcInd:
          type: string
          description: Yes/No indicator that identifies whether the exchange is an
            internal exchange within the same carrier.
          enum:
            - YES
            - NO
        exchangeDate:
          type: string
          description: Date on which the old policy is replaced by the new one.
          format: date
```