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 Ref Data API is one of 42 APIs that Zinnia publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 2 operations across 2 paths, and defines 7 schemas. It is described by OpenAPI 3.2.0, at version 1.0.8.

Requests are made against 2 base URLs: https://dev.api.zinnia.io, https://qa.api.zinnia.io.

2 operations 2 paths 7 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

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

Paths & Operations 2

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

Ref Data 2

Ref-Data

GET
/bpm/v1/policies/{planCode}/{policyNumber}/refdata
Get PPFA Reference Data by Policy
getRefDataByPolicy 3 params → 200404
GET
/policy/v1/transactions/{planCode}/{policyNumber}/refdata
Get PPFA Reference Data by Policy
getRefDataByPolicy1 3 params → 200404

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are TransactionSubtype (41 properties), PPFAIntegratedDataResponse (35 properties), ViFund (10 properties), ViAmounts (7 properties). Each schema is shown below with its type and property counts.

TransactionSubtype
object
Complete transaction subtype with all arrangement and fund details, enriched with VI 21209 real-time amounts
41 properties
PPFAIntegratedDataResponse
object
35 properties
CodeDisplayName
object
Generic code/displayName object
2 properties
ViAmounts
object
VI-derived amount values for withdrawal rule evaluation. Contains real-time policy values from VI 21209 response.
7 properties
ViFund
object
VI-derived fund information with withdrawal eligibility
10 properties
ErrorResponse
object
2 properties
EffectiveDateDuration
object
Effective date duration with min/max values in days
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zinnia-ref-data-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 Ref Data 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.