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

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

# IriRestrictionReason

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Policy Service
  version: 0.0.21
servers:
  - url: https://uat.api.zinnia.io
components:
  schemas:
    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
    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
```