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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Zinnia

Zinnia Details API

Get policy details

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 11 operations across 11 paths, and defines 192 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.

11 operations 11 paths 192 schemas 11 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 Details 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 11

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

Details 11

Get policy details

GET
/policy/v1/policies/{planCode}/{policyNumber}/transactions
Get Policy Transactions
Transactions 12 params → 200400404500
GET
/policy/v1/policies/{planCode}/{policyNumber}/transactions/{transactionId}
Get Policy Transaction by ID
TransactionById 11 params → 200400404500
GET
/policy/v1/policies/{planCode}/{policyNumber}/transactions/{externalIdType}/{externalId}
Get Transaction by External Transaction Id
TransactionByExternalTransactionId 4 params → 200400404500
GET
/policy/v1/policies/{planCode}/{policyNumber}/systematicPrograms
Get Policy Systematic Programs
SystematicPrograms 4 params → 200400404500
GET
/policy/v1/policies/{planCode}/{policyNumber}/systematicPrograms/{externalIdType}/{externalId}
Get Systematic Programs by External Transaction Id
SystematicProgramsForExternalTransactionId 6 params → 200400404500
GET
/policy/v1/policies/{planCode}/{policyNumber}/riders
Get Policy Riders
Riders 2 params → 200400404500
GET
/policy/v1/policies/{planCode}/{policyNumber}/parties
Get Policy Parties
Parties 4 params → 200400404500
GET
/policy/v1/policies/{planCode}/{policyNumber}/lpspayload
Get Policy LPS Payload
PolicyIllustrationInformation 2 params → 200400404500
GET
/policy/v1/policies/{planCode}/{policyNumber}/features
Get Policy Features
Features 2 params → 200400404500
GET
/policy/v1/policies/{planCode}/{policyNumber}/distribution
Get Policy Distribution
DistributionOfInvestments 3 params → 200400404500
GET
/policy/v1/policies/{planCode}/{policyNumber}/coverage
Get Policy Coverage
Coverage 2 params → 200400404500

Schemas 192

The contract defines 192 schemas that model the data the API accepts and returns. The most detailed are PolicyPartyResponse (59 properties), Parties (58 properties), Rider (53 properties), Transaction (43 properties). Each schema is shown below with its type and property counts.

ArrangementsMatchSegmentAttributes
object
2 properties 2 required
AdhocExternalIdentifiers
object
2 properties
RiderParticipant
object
2 properties
Insured
object
11 properties
ArrangementsFeeAttributes
object
5 properties 5 required
PolicyFee
object
1 property 1 required
Features
object
4 properties 4 required
AllocationOption
string
DeathClaimTransactionAmounts
object
6 properties
TaxWithholdingInstructions
object
12 properties
PartyStatus
string
Address
object
14 properties
FormerName
object
8 properties
Suppression
object
2 properties
PayoutType
string
LapseProtection
object
1 property 1 required
CoverageLayer
object
27 properties 1 required
State
string
SegmentAttributes
object
11 properties 11 required
DeathBenefit
object
11 properties
TaxWithholding
object
13 properties
ClaimStatus
string
ChargeWaiverIndicator
string
Status
string
RiderType
string
PolicyCoverage
object
19 properties
FundActivity
object
6 properties
PolicyMetricsAttributes
object
8 properties 6 required
Base
object
6 properties 6 required
ArrangementSegment
object
2 properties 2 required
DistributionCode
string
LoanFundValue
object
6 properties
PreferredCommunicationType
string
LoanInterestType
string
RiskClass
string
Transaction
object
43 properties
DeathClaimAdhocParty
object
2 properties
PartyRiderParticipant
object
5 properties
Coverages
object
3 properties 3 required
Participant
object
2 properties 2 required
LapseProtectionAttributes
object
5 properties 5 required
TaxWithHoldingAttributes
object
9 properties 9 required
DeathClaim
object
13 properties
TaxWithheldAmount
object
7 properties
FundSegment
object
24 properties
TransactionChargeType
string
ParticipantAttributes
object
4 properties 3 required
DeathBenefitInterestCalculatedFromDate
string
AccountValueAttributes
object
10 properties 10 required
LapseAssessment
object
1 property 1 required
Arrangements
object
8 properties 8 required
DelegatedExecutionAuthorityType
string
LPSPayloadResponse
object
14 properties 14 required
AccountStatus
string
UnderwritingStatus
string
TaxWithHolding
object
1 property 1 required
AmountType
string
FundAllocationsAttributes
object
5 properties 5 required
CoveragesAttributes
object
33 properties 32 required
Distribution
object
8 properties
DeathClaimAdhocDeathBenefit
object
2 properties
PaymentAttributes
object
5 properties 5 required
Parties
object
58 properties
AccountValue
object
4 properties 4 required
FundDistributionSegment
object
3 properties
FundAllocations
object
1 property 1 required
SurplusDistributionOption
string
This is the Surplus Distribution type it can be PUA, Cash etc.
Reinstatement
object
1 property 1 required
ReinstatementAttributes
object
7 properties 7 required
FundDistribution
object
5 properties
FeatureSubType
string
SystematicProgramParties
object
8 properties
FeatureType
string
ClaimCode
string
Prefix
string
DeathBenefitOptionType
string
CauseOfDeath
string
PolicyFeeAttributes
object
6 properties 5 required
Withdrawal
object
1 property 1 required
ArrangementsFee
object
1 property 1 required
AgentType
string
SuppressionType
string
Specifies the category or type of suppression being applied to a transaction. It indicates what kind of suppression is in effect.
Identification
object
9 properties
ExternalIdentifiers
object
3 properties
TaxRateToUse
string
ArrangementLoanSegment
object
2 properties 2 required
FilingStatus
string
AdhocDisbursementParty
object
8 properties
TrustType
string
SystematicFundAllocation
object
2 properties
Charge
object
4 properties
FeeAttributes
object
5 properties 3 required
TransactionPayor
object
4 properties
PaymentForm
string
RiderCoverageLayer
object
26 properties
Funds
object
2 properties 2 required
DeathClaimAdhocPolicy
object
4 properties
TransactionTaxBasis
object
7 properties
Reason
string
ArrangementLoanSegmentAttributes
object
2 properties 2 required
Phone
object
11 properties
ArrangementSegmentAttributes
object
2 properties 2 required
SubStandardRating
string
Loan
object
10 properties
Payment
object
1 property 1 required
LoanType
string
Frequency
string
MatchSegmentFinancialActivityAttributes
object
2 properties 2 required
CommunicationType
string
PolicyPartyResponse
object
59 properties 5 required
FlatExtra
object
4 properties
ArrangementSourcesAttributes
object
3 properties 3 required
Fund
object
9 properties
CoverageBenefit
object
5 properties
ErrorResponse
object
2 properties
WithdrawalAttributes
object
10 properties 10 required
EntityType
string
DisbursementPaymentForm
string
TestValueAttributes
object
16 properties 15 required
Gender
string
PolicyPartyRoles
object
17 properties
CoverageValueAttributes
object
18 properties 18 required
FundAttributes
object
5 properties 5 required
LoanActivity
object
4 properties
AddressType
string
Contribution
string
PolicyMetrics
object
1 property 1 required
SystematicProgram
object
22 properties 1 required
Country
string
TransactionFundAllocation
object
1 property
SegmentActivity
object
4 properties
FundActivitySegment
object
3 properties
Rate
object
6 properties
MatchSegment
object
12 properties
Segment
object
1 property 1 required
PartyType
string
ArrangementsAttributes
object
28 properties 28 required
EmploymentStatus
string
ProofOfDeathReceived
string
LineOfBusiness
string
BankAccount
object
14 properties
CoverageParticipants
object
6 properties
CoverageValue
object
1 property 1 required
EmailType
string
DisbursementType
string
BankAccountPurpose
string
Outcome
string
Rider
object
53 properties
AccountType
string
ImpairmentDetails
object
2 properties
TransactionPayeeOrBeneficiary
object
10 properties 1 required
TransactionStatus
string
LapseAssessmentAttributes
object
6 properties 5 required
DeathClaimAdhocPolicyDates
object
2 properties
AllocationSurplusDistribution
object
5 properties
LoanActivitySegment
object
6 properties
MatchActivity
object
2 properties
FundAllocation
object
6 properties
TransactionExchange
object
10 properties 1 required
TransactionCharge
object
7 properties
FundAccountType
string
TaxFormType
string
TestValue
object
1 property 1 required
LoanSegment
object
17 properties
RiderCharge
object
2 properties
TaxWithholdingType
string
ArrangementFinancialActivity
object
1 property 1 required
ArrangementsMatchSegment
object
2 properties 2 required
TransactionFeature
object
3 properties
Party
object
5 properties
DeathDetail
object
4 properties
ArrangementLoanSegmentFinancialActivity
object
1 property 1 required
ArrangementLoanSegmentFinancialActivityAttributes
object
2 properties 2 required
ArrangementType
string
ArrangementSource
object
2 properties 2 required
PolicyFeature
object
28 properties
MatchSegmentFinancialActivity
object
1 property 1 required
PhoneType
string
Attributes
object
33 properties 33 required
AdhocTaxWithholdingInstructions
object
14 properties
PayoutInformation
object
1 property
InvestmentType
string
PartyRole
string
ArrangementFinancialActivityAttributes
object
2 properties 2 required
Email
object
6 properties
FeaturesAttributes
object
2 properties 2 required
PowerOfAttorneyAccessLevelType
string
W4P
object
4 properties
BranchAddress
object
9 properties
DeathClaimPayeeOrBeneficiary
object
5 properties 1 required
TransactionAmount
object
29 properties
Fee
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zinnia-details-api-openapi.yml Raw ↑

Other APIs Zinnia publishes across the network.

Zinnia Annuity Health Check API
AE Profile APIs.io
Zinnia Annuity Version 1 API
AE Profile APIs.io
Zinnia Annuity Version 2 API
AE Profile APIs.io
Zinnia Attachment API
AE Profile APIs.io
Zinnia Authorization Status Update API
AE Profile APIs.io
Zinnia Case Instance API
AE Profile APIs.io
Zinnia Client Case API
AE Profile APIs.io
Zinnia Comments API
AE Profile APIs.io
Zinnia Dataset API
AE Profile APIs.io
Zinnia Documents V2 API
AE Profile APIs.io
Zinnia Documents V3 API
AE Profile APIs.io
Zinnia Financial Transactions API
AE Profile APIs.io
#Details
← Back to Z APIs
API Details
ID
zinnia:zinnia-details-api
Base URL
https://qa.api.zinnia.io
Docs
https://developers.zinnia.com/apis/policy-transactions-1-0-2/docs
Provider
Zinnia
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=zinnia-details-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/zinnia-details-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Zinnia Details 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.