Zinnia Policy Service API

Central policy record service for the life and annuity policy lifecycle - policy detail retrieval by plan code and policy number, policy version history with filtering and pagination, one-time premium quoting, fund and party data, and DTCC/ACORD-aligned reference identifiers.

Operations 16

GET /policy/v1/policies/{planCode}/{policyNumber}/versions Get policy versions #
GET /policy/v1/policies/{planCode}/{policyNumber}/versions/{version} Get Policy By Version #
GET /policy/v1/policies/{planCode}/{policyNumber}/transactions Get Policy Transactions #
GET /policy/v1/policies/{planCode}/{policyNumber}/transactions/{transactionId} Get Policy Transaction by ID #
GET /policy/v1/policies/{planCode}/{policyNumber}/transactions/{externalIdType}/{externalId} Get Transaction by External Transaction Id #
GET /policy/v1/policies/{planCode}/{policyNumber}/systematicPrograms Get Policy Systematic Programs #
GET /policy/v1/policies/{planCode}/{policyNumber}/systematicPrograms/{externalIdType}/{externalId} Get Systematic Programs by External Transaction Id #
GET /policy/v1/policies/{planCode}/{policyNumber}/riders Get Policy Riders #
GET /policy/v1/policies/{planCode}/{policyNumber}/parties Get Policy Parties #
GET /policy/v1/policies/{planCode}/{policyNumber}/lpspayload Get Policy LPS Payload #
GET /policy/v1/policies/{planCode}/{policyNumber}/features Get Policy Features #
GET /policy/v1/policies/{planCode}/{policyNumber}/distribution Get Policy Distribution #
GET /policy/v1/policies/{planCode}/{policyNumber}/coverage Get Policy Coverage #
GET /policy/v1/policies/{planCode}/{policyNumber} Get Policy Details #
POST /policy/v1/policies/{planCode}/{policyNumber}/metrics Policy Metrics #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/zinnia-policy-service-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

zinnia-policy-service-openapi.yml Raw ↑
openapi: 3.0.0
paths:
  /policy/v1/policies/search:
    post:
      operationId: Policy Search
      summary: Search Policies
      parameters:
      - name: sortBy
        required: false
        in: query
        description: field to sort by
        schema:
          type: string
      - name: sortOrder
        required: false
        in: query
        description: order to sort (asc or desc)
        schema:
          type: string
      - name: limit
        required: false
        in: query
        description: number of results to limit to
        schema:
          type: number
      - name: offset
        required: false
        in: query
        description: index to start page search at
        schema:
          type: number
      requestBody:
        required: true
        description: Optional search criteria, none, some, or all criteria can be used. Values cannot be null.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PolicySearchRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PolicySearchResponse'
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PolicySearchResponse'
      security:
      - Auth0: []
      tags:
      - Search
  /policy/v1/policies/{planCode}/{policyNumber}/versions:
    get:
      operationId: Policy Versions
      x-scopes: read:policy
      summary: Get policy versions
      parameters:
      - name: planCode
        required: true
        in: path
        schema:
          type: string
      - name: policyNumber
        required: true
        in: path
        schema:
          type: string
      - name: limit
        required: false
        in: query
        schema:
          type: integer
      - name: transactionType
        required: false
        in: query
        description: Specifies the type of transaction being performed, such as Premium Payment, Loan Repayment, Anniversary
          etc
        schema:
          enum:
          - Activation
          - AddOwner
          - AddressChange
          - AgentChange
          - AnnuitantChange
          - Anniversary
          - AnnualPolicyRefreshAndRecalculation
          - AssigneeChange
          - BankAccountChange
          - BeneficiaryChange
          - CalendarProcessing
          - CancelNoPremium
          - ClaimPayout
          - CommunicationPreferenceChange
          - ConversionActivation
          - CostOfInsurance
          - CoverageCharge
          - CoverageCredit
          - DeathClaim
          - DeliveryDateSetup
          - Disbursement
          - EmailChange
          - ExistingPartyNameChange
          - ExpenseCharge
          - FaceAmountChange
          - FaceAmountDecrease
          - FaceAmountIncrease
          - FeatureChange
          - ForceOut
          - FreeLookExpiration
          - FreeLookCancellation
          - FullSurrender
          - FundAllocationsChange
          - FundTransfer
          - GrantorChange
          - PaymentInitialPremium
          - IdentifierChange
          - InitialPremium
          - InterestCredit
          - InterestCreditLoan
          - InterestCreditMatch
          - InterestLoan
          - Issuance
          - Lapse
          - LapseAssessment
          - LoanAnniversaryTrueUp
          - LoanRepaymentOneTime
          - MatchBonusVesting
          - MultipleBeneficiaryChange
          - MultipleEmailChange
          - MultiplePayeeChange
          - MultipleAgentChange
          - MultipleOwnerChange
          - MultipleAnnuitantChange
          - MultiplePhoneNumberChange
          - NewLoan
          - NotificationOfDeathClaim
          - OneTimePremium
          - OwnerChange
          - PartialWithdrawalOneTime
          - PolicyDetailsChange
          - PayeeChange
          - PaymentExpiration
          - PaymentLoanRepaymentOneTime
          - PaymentOneTimePremium
          - PaymentSystematicLoanRepayment
          - PayorChange
          - PhoneNumberChange
          - RateRenewal
          - RemoveOwner
          - Rescission
          - PowerOfAttorneyChange
          - PreferredMailingAddressChange
          - Reinstatement
          - ReinstatementApproved
          - Reissuance
          - RequiredMinimumDistributionOneTime
          - SubsequentPayment
          - SubsequentPremium
          - Sweep
          - SystematicLoanRepayment
          - SystematicLoanRepaymentSetup
          - SystematicPartialWithdrawal
          - SystematicPartialWithdrawalSetup
          - SystematicRequiredMinimumDistribution
          - SystematicRequiredMinimumDistributionSetup
          - SystematicPaymentSetup
          - SystematicAnnuityPayout
          - SystematicAnnuityPayoutSetup
          - SystematicProgramUpdate
          - TPDChange
          - TrusteeChange
          - UnitExpenseCharge
          - ValueAdjustment
          - YearBeginningRefreshAndRecalculation
          - WithdrawnApplication
          - DollarCostAverage
          - ProcessingDate
          - ServiceCharge
          - TransferCharge
          - RiderAddition
          - Annuitization
          - AnnuityBenefitReduction
          - Reclassification
          - FlatExtraChange
          - Commutation
          - Dividend
          - DividendFeatureCharge
          - MarketTimerFee
          - InterimAnnualProcessing
          - HardshipWithdrawal
          - HardshipEnd
          - ResetBenefitAmounts
          - GuaranteedAccumulationBenefitPeriodEnd
          - GainLossChargeBack
          - SpousalContinuation
          - PeriodicCharge
          - DeathBenefitLockIn
          - RatchetLockIn
          - GrowthDeathBenefitLockIn
          - DateOfDeath
          - BenefitAmountAutoAdjustment
          - NotificationOfRiderClaimStart
          - LongTermCareBenefitStartStop
          - DailyRatchet
          - AnnuitizationAnniversary
          - DeclineFeeChange
          - GuaranteedWithdrawalBenefitPaymentLockIn
          - ExcessInterestCredit
          - LongTermCareWithdrawal
          - GuaranteedWithdrawalBenefitInterestAdjustment
          - InvestmentAdvisorFee
          - PayoutAmountChange
          - AdditionalBenefitStart
          - AdditionalBenefitEnd
          - RiderActivationAnniversary
          - AdditionalBenefitRenew
          - QualifiedPlanChange
          - AdvanceAnnuityPayment
          - PartialCommutation
          - GuaranteedIndexRates
          - BailoutRenewal
          - NonLifeAnnuitization
          - AdditionalBenefitReCertification
          - CostBasisReceived
          - FreeWithdrawalRecalculation
          - YearEndGain
          - LongTermCareCertificationDate
          - QuarterlyProcessing
          - BenefitBaseAdjustment
          - RiderBenefitBaseLockIn
          - GuaranteedDeathBenefitRollUpRenew
          - GuaranteedWithdrawalBenefitRollUpRenew
          - RiderCharge
          - LongTermCareFeeStartStop
          - LongTermCareAssessmentCharge
          - RoleBirthday
          - PendingUnclaimedProperty
          - PendingPartialUnclaimedProperty
          - LiquidatedUnclaimedProperty
          - SystematicRiderClaimWithdrawalSetup
          - SystematicRiderClaimWithdrawal
          - TaxWithholdingChange
          - MultipleTrusteeChange
          - MultiplePowerOfAttorneyChange
          - OtherInterestedPartyChange
          - MultipleAuthorizedSignatoryChange
          - AuthorizedSignatoryChange
          - ExchangeCompanyChange
          - BillingFeatureChange
          - GWBPhaseChange
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PolicyEvent'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Unexpected error occured, please check server logs
      security:
      - Auth0: []
      tags:
      - Overview
  /policy/v1/policies/{planCode}/{policyNumber}/versions/{version}:
    get:
      operationId: Policy By Version
      summary: Get Policy By Version
      parameters:
      - name: planCode
        required: true
        in: path
        schema:
          type: string
      - name: policyNumber
        required: true
        in: path
        schema:
          type: string
      - name: version
        required: true
        in: path
        schema:
          type: integer
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Policy'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Unexpected error occured, please check server logs
      security:
      - Auth0: []
      tags:
      - Overview
  /policy/v1/policies/{planCode}/{policyNumber}/transactions:
    get:
      operationId: Transactions
      summary: Get Policy Transactions
      parameters:
      - name: planCode
        required: true
        in: path
        schema:
          type: string
      - name: policyNumber
        required: true
        in: path
        schema:
          type: string
      - name: reverseInitiatorOnly
        required: false
        in: query
        schema:
          type: boolean
      - name: status
        required: false
        in: query
        schema:
          type: array
          items:
            type: string
      - name: endDate
        required: false
        in: query
        schema:
          type: string
      - name: startDate
        required: false
        in: query
        schema:
          type: string
      - name: limit
        required: false
        in: query
        schema:
          type: integer
      - name: offset
        required: false
        in: query
        schema:
          type: integer
      - name: sortField
        required: false
        in: query
        schema:
          enum:
          - EFFECTIVEDATE
          - PROCESSDATE
          - REVERSALDATE
          type: string
      - name: sortOrder
        required: false
        in: query
        schema:
          enum:
          - ASC
          - DESC
          type: string
      - name: version
        required: false
        in: query
        schema:
          type: integer
      - name: transactionTypes
        required: false
        in: query
        description: Specifies the type of transaction being performed, such as Premium Payment, Loan Repayment, Anniversary
          etc
        schema:
          type: array
          items:
            type: string
            enum:
            - Activation
            - AddOwner
            - AddressChange
            - AgentChange
            - AnnuitantChange
            - Anniversary
            - AnnualPolicyRefreshAndRecalculation
            - AssigneeChange
            - BankAccountChange
            - BeneficiaryChange
            - CalendarProcessing
            - CancelNoPremium
            - ClaimPayout
            - CommunicationPreferenceChange
            - ConversionActivation
            - CostOfInsurance
            - CoverageCharge
            - CoverageCredit
            - DeathClaim
            - DeliveryDateSetup
            - Disbursement
            - EmailChange
            - ExistingPartyNameChange
            - ExpenseCharge
            - FaceAmountChange
            - FaceAmountDecrease
            - FaceAmountIncrease
            - FeatureChange
            - ForceOut
            - FreeLookExpiration
            - FreeLookCancellation
            - FullSurrender
            - FundAllocationsChange
            - FundTransfer
            - GrantorChange
            - PaymentInitialPremium
            - IdentifierChange
            - InitialPremium
            - InterestCredit
            - InterestCreditLoan
            - InterestCreditMatch
            - InterestLoan
            - Issuance
            - Lapse
            - LapseAssessment
            - LoanAnniversaryTrueUp
            - LoanRepaymentOneTime
            - MatchBonusVesting
            - MultipleBeneficiaryChange
            - MultipleEmailChange
            - MultiplePayeeChange
            - MultipleAgentChange
            - MultipleOwnerChange
            - MultipleAnnuitantChange
            - MultiplePhoneNumberChange
            - NewLoan
            - NotificationOfDeathClaim
            - OneTimePremium
            - OwnerChange
            - PartialWithdrawalOneTime
            - PolicyDetailsChange
            - PayeeChange
            - PaymentExpiration
            - PaymentLoanRepaymentOneTime
            - PaymentOneTimePremium
            - PaymentSystematicLoanRepayment
            - PayorChange
            - PhoneNumberChange
            - RateRenewal
            - RemoveOwner
            - Rescission
            - PowerOfAttorneyChange
            - PreferredMailingAddressChange
            - Reinstatement
            - ReinstatementApproved
            - Reissuance
            - RequiredMinimumDistributionOneTime
            - SubsequentPayment
            - SubsequentPremium
            - Sweep
            - SystematicLoanRepayment
            - SystematicLoanRepaymentSetup
            - SystematicPartialWithdrawal
            - SystematicPartialWithdrawalSetup
            - SystematicRequiredMinimumDistribution
            - SystematicRequiredMinimumDistributionSetup
            - SystematicPaymentSetup
            - SystematicAnnuityPayout
            - SystematicAnnuityPayoutSetup
            - SystematicProgramUpdate
            - TPDChange
            - TrusteeChange
            - UnitExpenseCharge
            - ValueAdjustment
            - YearBeginningRefreshAndRecalculation
            - WithdrawnApplication
            - DollarCostAverage
            - ProcessingDate
            - ServiceCharge
            - TransferCharge
            - RiderAddition
            - Annuitization
            - AnnuityBenefitReduction
            - Reclassification
            - FlatExtraChange
            - Commutation
            - Dividend
            - DividendFeatureCharge
            - MarketTimerFee
            - InterimAnnualProcessing
            - HardshipWithdrawal
            - HardshipEnd
            - ResetBenefitAmounts
            - GuaranteedAccumulationBenefitPeriodEnd
            - GainLossChargeBack
            - SpousalContinuation
            - PeriodicCharge
            - DeathBenefitLockIn
            - RatchetLockIn
            - GrowthDeathBenefitLockIn
            - DateOfDeath
            - BenefitAmountAutoAdjustment
            - NotificationOfRiderClaimStart
            - LongTermCareBenefitStartStop
            - DailyRatchet
            - AnnuitizationAnniversary
            - DeclineFeeChange
            - GuaranteedWithdrawalBenefitPaymentLockIn
            - ExcessInterestCredit
            - LongTermCareWithdrawal
            - GuaranteedWithdrawalBenefitInterestAdjustment
            - InvestmentAdvisorFee
            - PayoutAmountChange
            - AdditionalBenefitStart
            - AdditionalBenefitEnd
            - RiderActivationAnniversary
            - AdditionalBenefitRenew
            - QualifiedPlanChange
            - AdvanceAnnuityPayment
            - PartialCommutation
            - GuaranteedIndexRates
            - BailoutRenewal
            - NonLifeAnnuitization
            - AdditionalBenefitReCertification
            - CostBasisReceived
            - FreeWithdrawalRecalculation
            - YearEndGain
            - LongTermCareCertificationDate
            - QuarterlyProcessing
            - BenefitBaseAdjustment
            - RiderBenefitBaseLockIn
            - GuaranteedDeathBenefitRollUpRenew
            - GuaranteedWithdrawalBenefitRollUpRenew
            - RiderCharge
            - LongTermCareFeeStartStop
            - LongTermCareAssessmentCharge
            - RoleBirthday
            - PendingUnclaimedProperty
            - PendingPartialUnclaimedProperty
            - LiquidatedUnclaimedProperty
            - SystematicRiderClaimWithdrawalSetup
            - SystematicRiderClaimWithdrawal
            - TaxWithholdingChange
            - MultipleTrusteeChange
            - MultiplePowerOfAttorneyChange
            - OtherInterestedPartyChange
            - MultipleAuthorizedSignatoryChange
            - AuthorizedSignatoryChange
            - ExchangeCompanyChange
            - BillingFeatureChange
            - GWBPhaseChange
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Transaction'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Unexpected error occured, please check server logs
      security:
      - Auth0: []
      tags:
      - Details
  /policy/v1/policies/{planCode}/{policyNumber}/transactions/{transactionId}:
    get:
      operationId: Transaction By Id
      summary: Get Policy Transaction by ID
      parameters:
      - name: planCode
        required: true
        in: path
        schema:
          type: string
      - name: policyNumber
        required: true
        in: path
        schema:
          type: string
      - name: transactionId
        required: true
        in: path
        schema:
          type: string
      - name: status
        required: false
        in: query
        schema:
          type: array
          items:
            type: string
      - name: endDate
        required: false
        in: query
        schema:
          type: string
      - name: startDate
        required: false
        in: query
        schema:
          type: string
      - name: limit
        required: false
        in: query
        schema:
          type: number
      - name: offset
        required: false
        in: query
        schema:
          type: number
      - name: sortOrder
        required: false
        in: query
        schema:
          type: string
      - name: version
        required: false
        in: query
        schema:
          type: number
      - name: transactionType
        required: false
        in: query
        description: Specifies the type of transaction being performed, such as Premium Payment, Loan Repayment, Anniversary
          etc
        schema:
          enum:
          - Activation
          - AddOwner
          - AddressChange
          - AgentChange
          - AnnuitantChange
          - Anniversary
          - AnnualPolicyRefreshAndRecalculation
          - AssigneeChange
          - BankAccountChange
          - BeneficiaryChange
          - CalendarProcessing
          - CancelNoPremium
          - ClaimPayout
          - CommunicationPreferenceChange
          - ConversionActivation
          - CostOfInsurance
          - CoverageCharge
          - CoverageCredit
          - DeathClaim
          - DeliveryDateSetup
          - Disbursement
          - EmailChange
          - ExistingPartyNameChange
          - ExpenseCharge
          - FaceAmountChange
          - FaceAmountDecrease
          - FaceAmountIncrease
          - FeatureChange
          - ForceOut
          - FreeLookExpiration
          - FreeLookCancellation
          - FullSurrender
          - FundAllocationsChange
          - FundTransfer
          - GrantorChange
          - PaymentInitialPremium
          - IdentifierChange
          - InitialPremium
          - InterestCredit
          - InterestCreditLoan
          - InterestCreditMatch
          - InterestLoan
          - Issuance
          - Lapse
          - LapseAssessment
          - LoanAnniversaryTrueUp
          - LoanRepaymentOneTime
          - MatchBonusVesting
          - MultipleBeneficiaryChange
          - MultipleEmailChange
          - MultiplePayeeChange
          - MultipleAgentChange
          - MultipleOwnerChange
          - MultipleAnnuitantChange
          - MultiplePhoneNumberChange
          - NewLoan
          - NotificationOfDeathClaim
          - OneTimePremium
          - OwnerChange
          - PartialWithdrawalOneTime
          - PolicyDetailsChange
          - PayeeChange
          - PaymentExpiration
          - PaymentLoanRepaymentOneTime
          - PaymentOneTimePremium
          - PaymentSystematicLoanRepayment
          - PayorChange
          - PhoneNumberChange
          - RateRenewal
          - RemoveOwner
          - Rescission
          - PowerOfAttorneyChange
          - PreferredMailingAddressChange
          - Reinstatement
          - ReinstatementApproved
          - Reissuance
          - RequiredMinimumDistributionOneTime
          - SubsequentPayment
          - SubsequentPremium
          - Sweep
          - SystematicLoanRepayment
          - SystematicLoanRepaymentSetup
          - SystematicPartialWithdrawal
          - SystematicPartialWithdrawalSetup
          - SystematicRequiredMinimumDistribution
          - SystematicRequiredMinimumDistributionSetup
          - SystematicPaymentSetup
          - SystematicAnnuityPayout
          - SystematicAnnuityPayoutSetup
          - SystematicProgramUpdate
          - TPDChange
          - TrusteeChange
          - UnitExpenseCharge
          - ValueAdjustment
          - YearBeginningRefreshAndRecalculation
          - WithdrawnApplication
          - DollarCostAverage
          - ProcessingDate
          - ServiceCharge
          - TransferCharge
          - RiderAddition
          - Annuitization
          - AnnuityBenefitReduction
          - Reclassification
          - FlatExtraChange
          - Commutation
          - Dividend
          - DividendFeatureCharge
          - MarketTimerFee
          - InterimAnnualProcessing
          - HardshipWithdrawal
          - HardshipEnd
          - ResetBenefitAmounts
          - GuaranteedAccumulationBenefitPeriodEnd
          - GainLossChargeBack
          - SpousalContinuation
          - PeriodicCharge
          - DeathBenefitLockIn
          - RatchetLockIn
          - GrowthDeathBenefitLockIn
          - DateOfDeath
          - BenefitAmountAutoAdjustment
          - NotificationOfRiderClaimStart
          - LongTermCareBenefitStartStop
          - DailyRatchet
          - AnnuitizationAnniversary
          - DeclineFeeChange
          - GuaranteedWithdrawalBenefitPaymentLockIn
          - ExcessInterestCredit
          - LongTermCareWithdrawal
          - GuaranteedWithdrawalBenefitInterestAdjustment
          - InvestmentAdvisorFee
          - PayoutAmountChange
          - AdditionalBenefitStart
          - AdditionalBenefitEnd
          - RiderActivationAnniversary
          - AdditionalBenefitRenew
          - QualifiedPlanChange
          - AdvanceAnnuityPayment
          - PartialCommutation
          - GuaranteedIndexRates
          - BailoutRenewal
          - NonLifeAnnuitization
          - AdditionalBenefitReCertification
          - CostBasisReceived
          - FreeWithdrawalRecalculation
          - YearEndGain
          - LongTermCareCertificationDate
          - QuarterlyProcessing
          - BenefitBaseAdjustment
          - RiderBenefitBaseLockIn
          - GuaranteedDeathBenefitRollUpRenew
          - GuaranteedWithdrawalBenefitRollUpRenew
          - RiderCharge
          - LongTermCareFeeStartStop
          - LongTermCareAssessmentCharge
          - RoleBirthday
          - PendingUnclaimedProperty
          - PendingPartialUnclaimedProperty
          - LiquidatedUnclaimedProperty
          - SystematicRiderClaimWithdrawalSetup
          - SystematicRiderClaimWithdrawal
          - TaxWithholdingChange
          - MultipleTrusteeChange
          - MultiplePowerOfAttorneyChange
          - OtherInterestedPartyChange
          - MultipleAuthorizedSignatoryChange
          - AuthorizedSignatoryChange
          - ExchangeCompanyChange
          - BillingFeatureChange
          - GWBPhaseChange
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Transaction'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Unexpected error occured, please check server logs
      security:
      - Auth0: []
      tags:
      - Details
  /policy/v1/policies/{planCode}/{policyNumber}/transactions/{externalIdType}/{externalId}:
    get:
      operationId: Transaction by External Transaction Id
      summary: Get Transaction by External Transaction Id
      parameters:
      - name: planCode
        required: true
        in: path
        schema:
          type: string
      - name: policyNumber
        required: true
        in: path
        schema:
          type: string
      - name: externalId
        required: true
        in: path
        schema:
          type: string
      - name: externalIdType
        required: true
        in: path
        schema:
          enum:
          - ExternalTransactionId
          - ReferenceNumber
          - ExternalArrangementId
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Transaction'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Unexpected error occured, please check server logs
      security:
      - Auth0: []
      tags:
      - Details
  /policy/v1/policies/{planCode}/{policyNumber}/systematicPrograms:
    get:
      operationId: Systematic Programs
      summary: Get Policy Systematic Programs
      parameters:
      - name: referenceId
        required: false
        in: query
        schema:
          type: string
      - name: referenceType
        required: false
        in: query
        schema:
          enum:
          - PartyId
          - BankId
          - AddressId
          type: string
      - name: planCode
        required: true
        in: path
        schema:
          type: string
      - name: policyNumber
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SystematicProgram'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Unexpected error occured, please check server logs
      security:
      - Auth0: []
      tags:
      - Details
  /policy/v1/policies/{planCode}/{policyNumber}/systematicPrograms/{externalIdType}/{externalId}:
    get:
      operationId: Systematic Programs for External Transaction Id
      summary: Get Systematic Programs by External Transaction Id
      parameters:
      - name: referenceId
        required: false
        in: query
        schema:
          type: string
      - name: referenceType
        required: false
        in: query
        schema:
          enum:
          - PartyId
          - BankId
          - AddressId
          type: string
      - name: planCode
        required: true
        in: path
        schema:
          type: string
      - name: policyNumber
        required: true
        in: path
        schema:
          type: string
      - name: externalId
        required: true
        in: path
        schema:
          type: string
      - name: externalIdType
        required: true
        in: path
        schema:
          enum:
          - ExternalTransactionId
          - ReferenceNumber
          - ExternalArrangementId
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SystematicProgram'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Unexpected error occured, please check server logs
      security:
      - Auth0: []
      tags:
      - Details
  /policy/v1/policies/{planCode}/{policyNumber}/riders:
    get:
      operationId: Riders
      summary: Get Policy Riders
      parameters:
      - name: planCode
        required: true
        in: path
        schema:
          type: string
      - name: policyNumber
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Rider'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Unexpected error occured, please check server logs
      security:
      - Auth0: []
      tags:
      - Details
  /policy/v1/policies/{planCode}/{policyNumber}/parties:
    get:
      operationId: Parties
      summary: Get Policy Parties
      parameters:
      - name: partyRole
        required: false
        in: query
        schema:
          enum:
          - Owner
          - JointOwner
          - Annuitant
          - JointAnnuitant
          - Payee
          - Payor
          - ThirdPartyDesignee
          - PrimaryBeneficiary
          - ContingentBeneficiary
          - Grantor
          - Trustee
          - PowerOfAttorney
          type: string
      - name: partyId
        required: false
        in: query
        schema:
          type: string
      - name: planCode
        required: true
        in: path
        schema:
          type: string
      - name: policyNumber
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
         

# --- truncated at 32 KB (782 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zinnia/refs/heads/main/openapi/zinnia-policy-service-openapi.yml