---
title: "IriPolicySummary"
url: "https://developers.zinnia.com/apis/policy-service-0-1-0/versions/8306e031-b41c-452a-a7ed-d73d65602086/schemas/IriPolicySummary"
---

> Full API specification: https://developers.zinnia.com/apis/policy-service-0-1-0/versions/8306e031-b41c-452a-a7ed-d73d65602086.md

# IriPolicySummary

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Policy Service
  version: 0.0.21
servers:
  - url: https://uat.api.zinnia.io
components:
  schemas:
    IriProduct:
      type: object
      properties:
        planName:
          type: string
          description: Marketing/plan name of the product.
          example: Fixed Indexed Annuity Premier
          maxLength: 200
        productType:
          $ref: "#/components/schemas/IriProductType"
        shortName:
          type: string
          description: Short display name of the product.
          example: FIA Premier
          maxLength: 100
        planCode:
          type: string
          description: Carrier-assigned plan code.
          example: FIAPRM01
          pattern: ^[A-Za-z0-9]{1,50}$
      required:
        - planName
        - productType
        - planCode
    IriQualificationType:
      type: string
      description: Tax qualification type.
      enum:
        - Non-Qualified
        - Solo 401k
        - 401k
        - 403b
        - 457 Deferred Compensation
        - Inherited IRA
        - IRA Spousal
        - Educational IRA
        - IRA
        - IRA Rollover
        - IRA Transfer
        - Roth IRA
        - Roth IRA - Inherited
        - SEP IRA
        - SIMPLE IRA
        - Pension Plan
        - Cash Balance Plan-Defined Contributions
        - Solo Defined Benefit
        - Cash Balance Plan-Defined Benefit
        - Profit Sharing Plan
        - Money Purchase Plan
        - SAREP
        - 401g
        - HR10
        - Welfare Benefit Plan
        - Roth 401K
        - Roth 403b
        - Roth 457
    IriPolicyStatus:
      type: string
      description: Policy status.
      enum:
        - PENDINGISSUED
        - ACTIVE
        - LAPSED
        - SURRENDERED
        - TERMINATED
    IriRestrictionReason:
      type: object
      properties:
        category:
          $ref: "#/components/schemas/IriRestrictionCategory"
        subCategory:
          $ref: "#/components/schemas/IriRestrictionSubCategory"
        reason:
          type: string
          description: Human-readable reason for the restriction.
          example: Collateral Assignment
          minLength: 1
          maxLength: 200
        definition:
          type: string
          description: Definition/detail of the restriction.
          example: Collateral assignment on the contract
          minLength: 1
          maxLength: 500
      required:
        - category
        - subCategory
        - reason
        - definition
    IriIssueType:
      type: string
      description: Underwriting/issue type.
      enum:
        - FULLUNDERWRITING
        - SIMPLIFIED
        - GUARANTEED
    IriProductType:
      type: string
      description: Product type.
      enum:
        - FIXED
        - VARIABLE
        - INDEXED
        - IMMEDIATE
        - DEFERRED
    IriRestrictionCategory:
      type: string
      description: Restriction category. Enum values use underscore-delimited tokens.
      enum:
        - PRODUCT_RULE
        - CONTRACT
        - AUTHORIZATION_IDENTITY
        - TRANSACTION
        - ARRANGEMENT
        - PARTY_CONTRACT_DATA
    IriRestrictionSubCategory:
      type: string
      description: Restriction sub-category.
      enum:
        - TRANSFER_NOT_ELIGIBLE
        - STATUS_OR_GLOBAL_RESTRICTION
        - RESTRICTED_TRADES_FLAG
        - AGENT_NOT_AUTHORIZED
        - SHORT_TERM_TRADING_LIMIT
        - ANNUAL_TRANSFER_LIMIT_EXCEEDED
        - ENROLLMENT_CONFLICT
        - CONFLICTING_TRANSACTION_PENDING
        - COLLATERAL_ASSIGNMENT
        - RECENT_OWNER_CHANGE
        - RECENT_ADDRESS_CHANGE
        - LOAN_OUTSTANDING
        - CONFLICTING_RIDER
        - CONFLICTING_ARRANGEMENT
        - PRODUCT_RULES
        - EXCESSIVE_TRADING_RESTRICTION
        - NO_SIGNATURE_ON_FILE
        - INVALID_GOVT_ID
        - WITHDRAWAL_FULL_LIQUIDATION
        - WITHDRAWAL_SPECIFIED_AMOUNT
        - WITHDRAWAL_SPECIFIED_PERCENTAGE
        - WITHDRAWAL_INTEREST_ONLY
        - WITHDRAWAL_RMD
        - WITHDRAWAL_RIDER_FREE_AMOUNT
        - WITHDRAWAL_SURRENDER_FREE_AMOUNT
        - WITHDRAWAL_FUND_SPECIFIC
        - WITHDRAWAL_PRORATA
        - WITHDRAWAL_PRORATA_VARIABLE_FUNDS
        - WITHDRAWAL_SYSTEMATIC
        - DCA_RESTRICTION
        - SWEEP_RESTRICTION
        - REBALANCE_RESTRICTION
        - INVEST_RESTRICTION
        - PRORATA_INVEST_RESTRICTION
        - PRORATA_VARIABLE_FUNDS_INVEST_RESTRICTION
        - FUND_SPECIFIC_INVEST_RESTRICTION
        - WITHDRAWAL_RMD_CARRIER_CALC
    IriPolicySummary:
      type: object
      properties:
        effectiveDate:
          type: string
          description: Policy effective date (yyyy-mm-dd).
          example: 2021-01-15
          format: date
        cusip:
          type: string
          description: CUSIP identifier for the product.
          example: 78462F103
          minLength: 9
          maxLength: 9
          pattern: ^[0-9]{3}[A-Z0-9]{5}[0-9]$
        carrierId:
          type: string
          description: Carrier identifier.
          example: CARR123
          maxLength: 10
        carrierName:
          type: string
          description: Carrier display name.
          example: Contoso Life & Annuity
          maxLength: 200
        policyLastRefreshDateTime:
          type: string
          description: Timestamp the policy data was last refreshed.
          example: 2026-03-06T16:30:00Z
          format: date-time
        product:
          $ref: "#/components/schemas/IriProduct"
        qualificationType:
          $ref: "#/components/schemas/IriQualificationType"
        policyStatus:
          $ref: "#/components/schemas/IriPolicyStatus"
        hasRestriction:
          type: boolean
          description: Whether the policy has one or more active restrictions.
          example: true
        restrictions:
          description: Active restrictions. Required when `hasRestriction` is true.
          type: array
          items:
            $ref: "#/components/schemas/IriRestrictionReason"
        issueType:
          $ref: "#/components/schemas/IriIssueType"
        issueState:
          type: string
          description: Two-letter issue state code.
          example: NC
          pattern: ^[A-Z]{2}$
        currency:
          type: string
          description: ISO 4217 three-letter currency code.
          example: USD
          pattern: ^[A-Z]{3}$
      required:
        - effectiveDate
        - carrierId
        - policyLastRefreshDateTime
        - product
        - policyStatus
        - issueType
        - currency
```