How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zinnia Overview API

Get policy overview

Zinnia Overview API is one of 42 APIs that Zinnia publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Overview. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 3 operations across 3 paths, and defines 122 schemas. It is described by OpenAPI 3.2.0, at version 0.0.21.

Requests are made against a single base URL, https://api.zinnia.io.

3 operations 3 paths 122 schemas 3 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.0.21
Base URL
https://qa.api.zinnia.io
Authentication
OpenID Connect
Resource Areas
1

Authentication & Security 1

Zinnia Overview API declares 1 security scheme for authenticating requests. It supports OpenID Connect (Auth0) discovered at https://login.zinnia.com/.well-known/openid-configuration.

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.

Overview 3

Get policy overview

GET
/policy/v1/policies/{planCode}/{policyNumber}/versions
Get policy versions
PolicyVersions 4 params → 200400404500
GET
/policy/v1/policies/{planCode}/{policyNumber}/versions/{version}
Get Policy By Version
PolicyByVersion 3 params → 200400404500
GET
/policy/v1/policies/{planCode}/{policyNumber}
Get Policy Details
PolicyOverview 6 params → 200400404500

Schemas 122

The contract defines 122 schemas that model the data the API accepts and returns. The most detailed are Parties (58 properties), Rider (53 properties), Policy (51 properties), AccountValues (37 properties). Each schema is shown below with its type and property counts.

RiderParticipant
object
2 properties
Insured
object
11 properties
AllocationOption
string
PartyStatus
string
Address
object
14 properties
FormerName
object
8 properties
CoverageLayer
object
27 properties 1 required
State
string
DeathBenefit
object
11 properties
TaxWithholding
object
13 properties
ClaimStatus
string
Status
string
RiderType
string
PolicyCoverage
object
19 properties
Base
object
6 properties 6 required
PolicyChargeType
string
MarketValueAdjustment
object
8 properties
PreferredCommunicationType
string
LoanInterestType
string
RiskClass
string
ModifiedEndowmentContract
object
11 properties
PolicyDates
object
24 properties
HoldingForm
string
PartyRiderParticipant
object
5 properties
PolicySnapshotSurplusDistribution
object
3 properties
PolicyStatus
string
FundSegment
object
24 properties
RestrictStatus
string
DelegatedExecutionAuthorityType
string
AccountStatus
string
UnderwritingStatus
string
AmountType
string
PolicyEvent
object
4 properties
Distribution
object
8 properties
TrackerType
string
Parties
object
58 properties
TestValues
object
2 properties
FundDistributionSegment
object
3 properties
DefinitionOfLifeInsurance
string
SurplusDistributionOption
string
This is the Surplus Distribution type it can be PUA, Cash etc.
FundDistribution
object
5 properties
SystematicProgramParties
object
8 properties
FeatureType
string
Currency
string
GuidelinePremium
object
8 properties
Prefix
string
DeathBenefitOptionType
string
CauseOfDeath
string
AgentType
string
Identification
object
9 properties
TaxRateToUse
string
FilingStatus
string
TrustType
string
SystematicFundAllocation
object
2 properties
PaymentForm
string
RiderCoverageLayer
object
26 properties
IssueType
string
Reason
string
RequiredMinimumDistributionCalculationOption
string
AccountValues
object
37 properties
Phone
object
11 properties
SubStandardRating
string
LoanType
string
Frequency
string
CommunicationType
string
ProductType
string
FlatExtra
object
4 properties
PolicySummary
object
18 properties
Fund
object
9 properties
EntityType
string
ErrorResponse
object
2 properties
LoanInterestMethod
string
Gender
string
Policy
object
51 properties
PolicyPartyRoles
object
17 properties
RequiredMinimumDistribution
object
8 properties
AddressType
string
Contribution
string
SystematicProgram
object
22 properties 1 required
Country
string
Rate
object
6 properties
MatchSegment
object
12 properties
PartyType
string
CostBasis
object
6 properties
EmploymentStatus
string
LoanValues
object
13 properties
ProofOfDeathReceived
string
BankAccount
object
14 properties
PolicyContractState
object
4 properties
CoverageParticipants
object
6 properties
EmailType
string
BankAccountPurpose
string
DisbursementType
string
AccountType
string
Rider
object
53 properties
ImpairmentDetails
object
2 properties
AllocationSurplusDistribution
object
5 properties
FundAllocation
object
6 properties
DistributionType
string
FundAccountType
string
FixedCostPeriodUnit
string
The unit of measure for the Fixed Cost Period. YEARS indicates the period is measured in policy years from the policy start date. AGE indicates the period is m…
Product
object
12 properties
TaxFormType
string
LoanSegment
object
17 properties
TaxWithholdingType
string
RiderCharge
object
2 properties
PolicyCharges
object
7 properties
Party
object
5 properties
DeathDetail
object
4 properties
CommissionOption
string
LoanRepaymentType
string
PartyRoles
object
5 properties
ArrangementType
string
PolicyFeature
object
28 properties
PhoneType
string
InvestmentType
string
PartyRole
string
Email
object
6 properties
PowerOfAttorneyAccessLevelType
string
W4P
object
4 properties
BranchAddress
object
9 properties
WithdrawalValues
object
13 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zinnia-overview-api-openapi.yml Raw ↑

Other APIs Zinnia publishes across the network.

Zinnia Annuity Health Check API
Zinnia Annuity Version 1 API
Zinnia Annuity Version 2 API
Zinnia Attachment API
Zinnia Authorization Status Update API
Zinnia Case Instance API
Zinnia Client Case API
Zinnia Comments API
Zinnia Dataset API
Zinnia Details API
Zinnia Documents V2 API
Zinnia Documents V3 API
Where this information came from

This is an independent, third-party profile of Zinnia Overview API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.