--- title: "IriPolicyValue" url: "https://developers.zinnia.com/apis/policy-service-0-1-0/versions/8306e031-b41c-452a-a7ed-d73d65602086/schemas/IriPolicyValue" --- > Full API specification: https://developers.zinnia.com/apis/policy-service-0-1-0/versions/8306e031-b41c-452a-a7ed-d73d65602086.md # IriPolicyValue ## OpenAPI definition ```yaml openapi: 3.0.0 info: title: Policy Service version: 0.0.21 servers: - url: https://uat.api.zinnia.io components: schemas: IriAccountDesignation: type: string description: Account designation / role type. enum: - INDIVIDUAL - JOINT - TRUST - CUSTODIAL - OTHER IriPayoutType: type: string description: Payout / product type. enum: - DEFERRED - IMMEDIATE - ANNUITIZED - ACCUMULATION - UNKNOWN IriAccountValues: type: object properties: beginningAccountValue: type: number description: Total cash value of the policy/annuity at the beginning of each transaction (loaned + unloaned). example: 161.82 minimum: 0 maximum: 9999999999.99 endingAccountValue: type: number description: Total cash value of the policy/annuity (loaned + unloaned) as of the last processed transaction. example: 161.82 minimum: 0 maximum: 9999999999.99 minimumRequiredAccountValue: type: number description: Lowest account value that must be maintained to keep the contract active. May be 0 for some products. example: 0 minimum: 0 maximum: 9999999999.99 unloanedPortionOfAccountValue: type: number description: Portion of the total account value that is not affected by policy loans. example: 161.82 minimum: 0 maximum: 9999999999.99 loanedPortionOfAccountValue: type: number description: Amount of the account value used as collateral for a policy loan. example: 0 minimum: 0 maximum: 9999999999.99 surrenderValue: type: number description: Amount paid to the policyholder upon voluntary surrender, after charges, loans, and fees. example: 161.82 minimum: 0 maximum: 9999999999.99 surrenderValueWithoutMarketValueAdjustment: type: number description: Surrender value without market value adjustment included. example: 161.82 minimum: 0 maximum: 9999999999.99 guaranteedCashSurrenderValueFixed: type: number description: Minimum cash value guaranteed on surrender regardless of market conditions (fixed). example: 161.82 minimum: 0 maximum: 9999999999.99 guaranteedCashSurrenderValueIndexed: type: number description: Indexed amount guaranteed on surrender. Only required for Annuity FIA products. example: 161.82 minimum: 0 maximum: 9999999999.99 interestEarned: type: number description: Interest credited to the policy/annuity based on the accumulated account value. example: 12.34 minimum: 0 maximum: 9999999999.99 totalNetWithdrawalSinceIssue: type: number description: Running total of all net withdrawals since policy issuance. example: 0 minimum: 0 maximum: 9999999999.99 totalGainWithdrawnSinceIssue: type: number description: Total of all earnings withdrawn since policy issue. example: 0 minimum: 0 maximum: 9999999999.99 required: - endingAccountValue IriLoanValues: type: object properties: totalLoanBalance: type: number description: Outstanding loan amount including principal, accrued interest, and unpaid loan charges. example: 0 minimum: 0 maximum: 9999999999.99 totalLoanPrincipal: type: number description: Original amount borrowed against the cash value, excluding accrued interest or charges. example: 0 minimum: 0 maximum: 9999999999.99 loanPayoffAmount: type: number description: Total amount required to fully repay the policy loan, including accrued interest and adjustments. example: 0 minimum: 0 maximum: 9999999999.99 maximumLoanAmount: type: number description: Highest amount that can be borrowed against the cash value. example: 0 minimum: 0 maximum: 9999999999.99 minimumLoanAmount: type: number description: Smallest amount that can be borrowed against the cash value. example: 0 minimum: 0 maximum: 9999999999.99 totalLoanAccruedInterest: type: number description: Interest accrued on the policy loan within the current year. example: 0 minimum: 0 maximum: 9999999999.99 lastLoanInterestDueDate: type: string description: Last policy anniversary date when loan interest was due on an outstanding loan (yyyy-mm-dd). example: 2023-01-01 format: date totalNumberOfLoan: type: number description: Total count of policy loans taken over the life of the policy. example: 0 minimum: 0 totalYearToDateLoanTaken: type: number description: Total amount of policy loans taken within the current calendar or policy year. example: 0 minimum: 0 maximum: 9999999999.99 IriWithdrawalValues: type: object properties: totalWithdrawalAmount: type: number description: Cumulative amount of funds withdrawn since policy inception. example: 0 minimum: 0 maximum: 9999999999.99 freeWithdrawalAmount: type: number description: Maximum amount that can be withdrawn in a contract year without a surrender charge. example: 10000 minimum: 0 maximum: 9999999999.99 yearToDateFreeWithdrawalAmount: type: number description: Amount withdrawn so far in the current contract year within the free withdrawal limit. example: 0 minimum: 0 maximum: 9999999999.99 minimumWithdrawalAmount: type: number description: Smallest amount that can be withdrawn in a single transaction. example: 0 minimum: 0 maximum: 9999999999.99 maximumWithdrawalAmount: type: number description: Highest amount that can be withdrawn in a single transaction or policy year. example: 0 minimum: 0 maximum: 9999999999.99 freeAvailableAmount: type: number description: Remaining free withdrawal amount available. example: 0 minimum: 0 maximum: 9999999999.99 required: - yearToDateFreeWithdrawalAmount IriMarketValueAdjustment: type: object properties: isMarketValueAdjusted: type: boolean description: Whether a market value adjustment applies to the policy. example: false IriRmdInfo: type: object properties: rmdTaxYear: type: number description: Tax year the required minimum distribution applies to. example: 2026 minimum: 1900 maximum: 2100 totalRMDAmountRemaining: type: number description: Total required minimum distribution amount remaining. example: 0 minimum: 0 maximum: 9999999999.99 IriAuthorization: type: object properties: businessMethods: type: array items: $ref: "#/components/schemas/IriBusinessMethod" authorizationEntities: type: array items: $ref: "#/components/schemas/IriAuthorizationEntity" authorizationTransaction: $ref: "#/components/schemas/IriAuthorizationTransaction" required: - businessMethods - authorizationEntities - authorizationTransaction IriBusinessMethod: type: string description: Business methods available for authorization. enum: - mail - electronic - fax - phone - voiceResponseUnit - internet IriAuthorizationEntity: type: object properties: authorizationEntity: type: string description: Name of the authorized entity. example: Contoso Advisors maxLength: 100 isAllAgentsAuthorized: type: boolean description: Whether all agents are authorized for the entity. example: true IriAuthorizationTransaction: type: object properties: administrativeTransactions: type: array items: $ref: "#/components/schemas/IriAdministrativeTransaction" isAuthorizationSignatureRequired: type: boolean description: Whether an authorization signature is required. example: false required: - administrativeTransactions IriAdministrativeTransaction: type: string description: Administrative transactions the caller is authorized for. enum: - fundTransfer - withdrawal - arrangementAdministration - allTransactions IriPolicyValue: type: object properties: valuesAsOfDate: type: string description: Date the values are reported as of (yyyy-mm-dd). example: 2026-03-31 format: date accountDesignation: $ref: "#/components/schemas/IriAccountDesignation" jurisdiction: type: string description: Two-letter jurisdiction code. example: NC pattern: ^[A-Z]{2}$ sponsoringPlanSeparationDate: type: string description: Sponsoring plan separation date (yyyy-mm-dd). example: 2026-01-01 format: date payoutType: $ref: "#/components/schemas/IriPayoutType" totalDepositITD: type: number description: Total deposit inception-to-date. example: 0 minimum: 0 maximum: 9999999999.99 surrenderChargeFreeDate: type: string description: Date surrender charges no longer apply (yyyy-mm-dd). example: 2031-01-01 format: date digitalPaymentTypeCode: type: string description: Digital payment type code. example: ACH pattern: ^[A-Za-z0-9._-]{1,100}$ digitalPaymentTypeDescription: type: string description: Digital payment type description. example: Automated Clearing House maxLength: 100 accountValues: $ref: "#/components/schemas/IriAccountValues" loanValues: $ref: "#/components/schemas/IriLoanValues" withdrawalValues: $ref: "#/components/schemas/IriWithdrawalValues" marketValueAdjustment: $ref: "#/components/schemas/IriMarketValueAdjustment" rmdInfo: $ref: "#/components/schemas/IriRmdInfo" authorization: $ref: "#/components/schemas/IriAuthorization" required: - valuesAsOfDate - accountValues ```