--- title: "IriPolicyRider" url: "https://developers.zinnia.com/apis/policy-service-0-1-0/versions/8306e031-b41c-452a-a7ed-d73d65602086/schemas/IriPolicyRider" --- > Full API specification: https://developers.zinnia.com/apis/policy-service-0-1-0/versions/8306e031-b41c-452a-a7ed-d73d65602086.md # IriPolicyRider ## OpenAPI definition ```yaml openapi: 3.0.0 info: title: Policy Service version: 0.0.21 servers: - url: https://uat.api.zinnia.io components: schemas: IriRiderType: type: string description: Classification of the rider. enum: - BASE - RIDER - INTEGRATED_RIDER - BENEFIT_RIDER - INCOME_RIDER - DEATH_BENEFIT_RIDER - LTC_RIDER - GMWB_RIDER - GMDB_RIDER - GMAB_RIDER - CHARGE_RIDER - DISCOUNT - BASE_INCREASE - RIDER_INCREASE - OTHER - UNKNOWN IriUnderwritingStatus: type: string description: Underwriting decision for the rider. enum: - APPROVED - DECLINED IriRiderStatus: type: string description: Current status of the rider. enum: - ACTIVE - TERMINATED - PENDING - SUSPENDED IriPayoutOption: type: string description: Single or Joint payout option for the rider. enum: - SINGLE - JOINT IriRiderParticipant: type: object properties: insuredAgeAtIssue: type: integer description: The age of the insured at the time the rider was issued. example: 50 format: int32 minimum: 0 maximum: 150 taxId: type: string description: Tax identification number (SSN/TIN) for the rider participant. example: "123456789" minLength: 9 maxLength: 9 pattern: ^[0-9]{9}$ required: - taxId IriRiderCharge: type: object properties: riderExerciseCharge: type: number description: One-time rider charge applied upon rider activation/exercise. example: 0 format: double minimum: 0 maximum: 9999999999.99 riderExerciseChargeRate: type: number description: The rate or percentage applied to calculate the charge for exercising the rider. example: 0 format: double minimum: 0 maximum: 9999999999.99 IriLivesType: type: string description: Indicates whether the rider covers single, joint, or multiple lives. enum: - SINGLE - JOINT - MULTIPLE - UNKNOWN IriPolicyRider: type: object properties: timestamp: type: string format: date-time description: Create or update timestamp of the rider record. example: 2026-03-06T12:00:00Z riderType: $ref: "#/components/schemas/IriRiderType" riderName: type: string description: The specific name of the rider as designated by the carrier. example: Guaranteed Lifetime Withdrawal Benefit maxLength: 200 isRiderElected: type: boolean description: Whether the policyholder has formally elected to include the rider on the policy. example: true riderCode: type: string description: A unique identifier or alphanumeric code assigned to the rider. example: GLWB pattern: ^[A-Za-z0-9._-]{1,100}$ underwritingStatus: $ref: "#/components/schemas/IriUnderwritingStatus" effectiveDate: type: string format: date description: Date on which the rider is selected and becomes effective on the policy. example: 2022-01-15 exerciseDate: type: string format: date description: The date the policyholder elects to use or activate the rider benefit. example: 2023-01-01 terminationDate: type: string format: date description: The date on which the rider coverage ends or is terminated. example: 2023-01-01 riderPaymentDate: type: string format: date description: The date the benefit payout under the rider is to be disbursed. example: 2023-01-01 status: $ref: "#/components/schemas/IriRiderStatus" coverageId: type: string description: A unique identifier assigned to the rider coverage within an insurance coverage or policy layer. example: Rider_GLWB pattern: ^[A-Za-z0-9._-]{1,100}$ amount: type: number description: The total benefit amount the rider provides. example: 250000 minimum: 0 maximum: 9999999999.99 annualBenefitAmount: type: number description: The maximum benefit amount of the benefit base the policyholder can withdraw each year. example: 0 format: double minimum: 0 maximum: 9999999999.99 riderBenefitAmount: type: number description: The maximum guaranteed amount available under the annuity rider over the life of the contract/rider. example: 0 format: double minimum: 0 maximum: 9999999999.99 riderBenefitPercent: type: number description: The fixed percentage applied to the rider benefit amount to calculate the annual guaranteed benefit amount. example: 100 format: double minimum: 0 maximum: 100 multipleOf: 0.01 remainingBenefit: type: number format: double description: The remaining benefit amount for the rider, incremented by premiums and adjusted by withdrawals. example: 10.51 minimum: 0 maximum: 9999999999.99 totalBenefit: type: number format: double description: The total guaranteed value the contract owner is entitled to under the rider. example: 5.17 minimum: 0 maximum: 9999999999.99 annualBenefitLimit: type: number format: double description: The total amount that can be withdrawn as a benefit of this rider in any given policy year. example: 3.43 minimum: 0 maximum: 9999999999.99 benefitPercent: type: number format: double description: Percentage of the benefit base that will be available for withdrawal each year. example: 1.23 minimum: 0 maximum: 100 multipleOf: 0.01 payoutOption: $ref: "#/components/schemas/IriPayoutOption" maximumChronicIllnessBenefitPercentage: type: number description: The highest percentage of the death benefit or face amount that can be taken for chronic illness coverage. example: 2.5 maximumPeriodicPaymentPeriod: type: integer description: The maximum duration, in months, over which payments can be made under the rider. example: 60 format: int32 riderParticipants: description: Participants (insureds) covered under the rider. type: array items: $ref: "#/components/schemas/IriRiderParticipant" charge: $ref: "#/components/schemas/IriRiderCharge" isAdditionalBenefitUsedUp: type: boolean description: Indicates whether the additional benefit under the rider has been used up. riderSubType: type: string description: Further classification of the rider sub-type. pattern: ^[A-Za-z0-9._ -]{1,100}$ maxLength: 100 livesType: $ref: "#/components/schemas/IriLivesType" isParticipantIrrevocable: type: boolean description: Whether the rider participant designation is irrevocable. additionalRiderClassification: type: string description: Additional classification detail for the rider. pattern: ^[A-Za-z0-9._ -]{1,100}$ maxLength: 100 riderFreeAmt: type: number description: Free-of-charge amount available under the rider. minimum: 0 maximum: 9999999999.99 participantRoleCode: type: string description: Role code of the rider participant. pattern: ^[A-Za-z0-9._ -]{1,100}$ maxLength: 100 ```