# Zinnia Policy Transactions API

**Canonical:** https://apis.io/apis/zinnia/zinnia-policy-transactions-api/  
**Provider:** Zinnia — https://apis.io/providers/zinnia/  
**Base URL:** https://qa.api.zinnia.io  
**Documentation:** https://developers.zinnia.com/apis/policy-transactions-1-0-2/docs

Zinnia Policy Transactions API is one of 10 APIs that [Zinnia](https://apis.io/providers/zinnia/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Insurance, Annuities, Policy Administration, and Financial-Services. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

Enterprise API for enforcing policy transactions and validations across the in-force annuity and life book - financial and non-financial transaction management, policy party management, systematic program management and eligibility/validation pre-checks. 102 operations across eligibility check, validation and submit triples for withdrawals, surrenders, loans, fund transfers, premiums, RMDs, reinstatement, free-look cancellation, party and address/bank/phone/email changes.

## Operations (60 of 102)

| Method | Path | Summary |
|---|---|---|
| GET | `/bpm/actuator/health` | Zahara BPM Health Check |
| POST | `/policy/v1/transactions/{planCode}/{policyNumber}/multi-agent/validation` | Validation multi agent Transaction |
| POST | `/policy/v1/transactions/{planCode}/{policyNumber}/Restrict` | Submit active restrict transaction |
| GET | `/policy/v1/transactions/{planCode}/{policyNumber}/Restrict` | Get restriction alerts for a policy |
| GET | `/policy/v1/transactions/{planCode}/{policyNumber}/Restrict/alerts` | Get restriction alerts for a policy |
| POST | `/bpm/v1/policies/{planCode}/{policyNumber}/basecoverageupdate/eligibilitycheck` | base coverage update |
| POST | `/bpm/v1/policies/{planCode}/{policyNumber}/{transactionType}/eligibilitycheck` | Eligibility Check For Non-Financial Transaction |
| POST | `/policy/v1/transactions/{planCode}/{policyNumber}/bankaccount/eligibilitycheck` | Eligibility Check Bank Transaction |
| POST | `/policy/v1/transactions/{planCode}/{policyNumber}/parties/{partyId}/{partyRole}/validation` | Party Change request |
| POST | `/bpm/v1/policies/{planCode}/{policyNumber}/billingfeaturechange/eligibilitycheck` | Eligibility Check Billing Feature Change |
| POST | `/bpm/v1/policies/{planCode}/{policyNumber}/billingfeaturechange/validation` | Validate Billing Feature Change |
| POST | `/policy/v1/transactions/{planCode}/{policyNumber}/freelookcancellation/validation` | Validation Freelook Cancellation Transaction |
| POST | `/policy/v1/transactions/case` | Create case for transaction |
| PUT | `/policy/v1/cases/{caseId}/cancel` | Cancel a case |
| POST | `/policy/v1/transactions/{planCode}/{policyNumber}/freelookcancellation/eligibilitycheck` | Freelook cancellation request |
| POST | `/bpm/v1/policies/{planCode}/{policyNumber}/initialdeathclaim/eligibilitycheck` | Initial Death Claim Eligibility Check |
| POST | `/bpm/v1/policies/{planCode}/{policyNumber}/initialdeathclaim/validation` | Initial Death Claim Validation |
| POST | `/bpm/v1/policies/{planCode}/{policyNumber}/initialdeathclaim` | Submit Initial Death Claim Transaction |
| PUT | `/bpm/v1/policies/{planCode}/{policyNumber}/authorization/status` | Receives policyholder authorization status from MPV and updates the status |
| GET | `/bpm/v1/policies/withdrawals/transactionstore/entities/{transactionId}` | Secure API to get TransactionData by transactionId |
| GET | `/bpm/v1/policies/{clientCode}/{planCode}/{transactionName}/paymentforms` | Get supported configurations for a transaction |
| GET | `/bpm/v1/policies/{clientCode}/{planCode}/{transactionName}/prevalidationreference` | Get supported configurations for a transaction |
| GET | `/policy/v1/transactions/{clientCode}/{planCode}/{transactionName}/prevalidationreference` | Get supported configurations for a transaction |
| POST | `/policy/v1/transactions/{planCode}/{policyNumber}/onetimepremium/validation` | Validation OneTime Premium Transaction |
| POST | `/policy/v1/transactions/{planCode}/{policyNumber}/onetimepremium` | Submit OneTime Premium Transaction |
| POST | `/policy/v1/transactions/{planCode}/{policyNumber}/onetimepremium/eligibilitycheck` | Eligibility Check OneTime Premium Transaction |
| POST | `/policy/v1/transactions/{planCode}/{policyNumber}/onetimermd/validation` | Validation OneTime RMD Transaction |
| POST | `/policy/v1/transactions/{planCode}/{policyNumber}/onetimermd` | Submit OneTime RMD Transaction |
| POST | `/policy/v1/transactions/{planCode}/{policyNumber}/onetimermd/eligibilitycheck` | Eligibility Check OneTime RMD Transaction |
| POST | `/policy/v1/transactions/{planCode}/{policyNumber}/reinstatement/eligibilitycheck` | Eligibility Check Reinstatement Request |
| POST | `/policy/v1/transactions/{planCode}/{policyNumber}/reinstatement` | Submit reinstatement transaction request |
| POST | `/policy/v1/transactions/{planCode}/{policyNumber}/systematicprograms/quote` | Systematic Program Quote Request |
| POST | `/policy/v1/transactions/{planCode}/{policyNumber}/systematicprograms/{arrangementId}/validation` | Validate Systematic Program Update Transaction |
| PUT | `/policy/v1/transactions/{planCode}/{policyNumber}/systematicprograms/{arrangementId}` | Submit Systematic Program Update Transaction |
| POST | `/policy/v1/transactions/{planCode}/{policyNumber}/systematicprograms/{arrangementId}/eligibilitycheck` | EligibilityCheck Systematic Program Update Transaction |
| PUT | `/policy/v1/transactions/{planCode}/{policyNumber}/parties/{partyId}/address/{addressId}` | Address Change Request |
| POST | `/policy/v1/transactions/{planCode}/{policyNumber}/emailaddress/eligibilitycheck` | Eligibility Check Email Address Transaction |
| POST | `/policy/v1/transactions/{planCode}/{policyNumber}/address/eligibilitycheck` | Eligibility Check Address Transaction |
| POST | `/policy/v1/transactions/{planCode}/{policyNumber}/parties/{partyId}/address` | Create new address based on request |
| POST | `/policy/v1/transactions/{planCode}/{policyNumber}/emailaddress/{partyId}/validation` | Add new Email Address based on request |
| POST | `/policy/v1/transactions/{planCode}/{policyNumber}/address/{partyId}/validation` | Validate Address based on request |
| POST | `/policy/v1/transactions/{planCode}/{policyNumber}/parties/{partyId}/emailaddress` | Create new Emailaddress based on request |
| PUT | `/policy/v1/transactions/{planCode}/{policyNumber}/parties/{partyId}/emailaddress/{emailId}` | Email Address Change Request |
| PUT | `/policy/v1/transactions/{planCode}/{policyNumber}/parties/{partyId}/emailaddresses` | Multiple Email Address Change Request |
| POST | `/policy/v1/transactions/{planCode}/{policyNumber}/parties/{partyId}/phone` | Create new Phone Number based on request |
| PUT | `/policy/v1/transactions/{planCode}/{policyNumber}/parties/{partyId}/phone/{phoneId}` | Phone Number Change Request |
| PUT | `/policy/v1/transactions/{planCode}/{policyNumber}/parties/{partyId}/phones` | Multiple Phone Number Change Request |
| PATCH | `/policy/v1/transactions/{planCode}/{policyNumber}/parties/{partyId}/identifiers` | Identifier change Request |
| POST | `/policy/v1/transactions/{planCode}/{policyNumber}/parties/{partyId}/bankaccount` | Add new Bank Account based on request |
| PUT | `/policy/v1/transactions/{planCode}/{policyNumber}/parties/{partyId}/bankaccount/{bankId}` | Bank Account Change Request |
| POST | `/policy/v1/transactions/{planCode}/{policyNumber}/communicationpreference/eligibilitycheck` | Eligibility Check Communication Preference Transaction |
| POST | `/policy/v1/transactions/{planCode}/{policyNumber}/parties/{partyId}/communicationpreference/validation` | Validate Communication Preference based on request |
| POST | `/policy/v1/transactions/{planCode}/{policyNumber}/parties/{partyId}/communicationpreference` | Update Communication Preference based on request |
| POST | `/policy/v1/transactions/{planCode}/{policyNumber}/parties/{partyId}/partyname` | Update Party Name based on request |
| POST | `/policy/v1/transactions/{planCode}/{policyNumber}/parties/{partyRole}` | Party Add request |
| PUT | `/policy/v1/transactions/{planCode}/{policyNumber}/parties/{partyId}/{partyRole}` | Party Change request |
| POST | `/policy/v1/transactions/{planCode}/{policyNumber}/parties/{partyRole}/eligibilitycheck` | EligibilityCheck For Party Role Transaction |
| POST | `/policy/v1/transactions/{planCode}/{policyNumber}/parties/taxwithholding/eligibilitycheck` | Eligibility Check Tax Withholding |
| POST | `/policy/v1/transactions/{planCode}/{policyNumber}/parties/taxwithholding/validation` | Validate Tax Withholding |
| POST | `/policy/v1/transactions/{planCode}/{policyNumber}/parties/taxwithholding` | Submit Tax Withholding Transaction |

…and 42 more operations. They are listed in full on the page.

## Machine-readable artifacts (5)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/zinnia/refs/heads/main/openapi/zinnia-policy-transactions-openapi.yml
- **Documentation** — https://developers.zinnia.com/apis/policy-transactions-1-0-2/docs
- **APIReference** — https://developers.zinnia.com/apis/policy-transactions-1-0-2/docs
- **Overlay** — https://raw.githubusercontent.com/api-evangelist/zinnia/refs/heads/main/overlays/zinnia-policy-transactions-overlay.yaml
- **APIsJSON** — https://raw.githubusercontent.com/api-evangelist/zinnia/refs/heads/main/apis.yml

## Other Zinnia APIs (9)

- [Zinnia Policy Service API](https://apis.io/apis/zinnia/zinnia-policy-service-api/)
- [Zinnia Market Connect Order Entry API](https://apis.io/apis/zinnia/zinnia-market-connect-order-entry-api/)
- [Zinnia Illustration Generation API](https://apis.io/apis/zinnia/zinnia-illustration-generation-api/)
- [Zinnia Enterprise Documents API](https://apis.io/apis/zinnia/zinnia-enterprise-documents-api/)
- [Zinnia New Business API](https://apis.io/apis/zinnia/zinnia-new-business-api/)
- [Zinnia New Business Annuity API](https://apis.io/apis/zinnia/zinnia-new-business-annuity-api/)
- [Zinnia Product Service API](https://apis.io/apis/zinnia/zinnia-product-service-api/)
- [Zinnia Case Management API](https://apis.io/apis/zinnia/zinnia-case-management-api/)
- [Zinnia Illustration Client Cases API](https://apis.io/apis/zinnia/zinnia-illustration-client-cases-api/)

## Tags

Insurance, Annuities, Policy Administration, Financial-Services

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/zinnia/zinnia-policy-transactions-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/zinnia/.
