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 New Business Transactions V2 API

New Business Orchestration Services Version 2

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

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

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

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

5 operations 2 paths 172 schemas 1 GET1 PATCH2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

Zinnia New Business Transactions V2 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 5

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

New Business Transactions V2 5

New Business Orchestration Services Version 2

POST
/newbusiness/v2/application/{eAppId}
Create case for New Business
postNewbusinessV2ApplicationByEAppId 1 param body → 201400401403500
PUT
/newbusiness/v2/application/{eAppId}
Submit application for New Business
submitPolicyDetails 2 params body → 202400401403404500
PATCH
/newbusiness/v2/application/{eAppId}
Update application for New Business
updateEApp 2 params body → 202400401403404500
GET
/newbusiness/v2/application/{eAppId}
Get New Business application
GetEApp 2 params → 202400401403404500
POST
/newbusiness/v2/application/{eAppId}/document
Submit documents for New Business
postNewbusinessV2ApplicationByEAppIdDocument 1 param body → 201400401403500

Schemas 172

The contract defines 172 schemas that model the data the API accepts and returns. The most detailed are illustrationDetailsPatch (30 properties), NonReplacement (20 properties), ReplacementPatch (20 properties), Replacement (20 properties). Each schema is shown below with its type and property counts.

illustrationDetailsPatch
object
30 properties
CountryCallingCodes
string
ISO Country calling Code https://en.wikipedia.org/wiki/Listoftelephonecountrycodes
PersonalInformationPrimaryResponse
object
10 properties
PolicySubmissionRequest
object
6 properties 7 required
PersonalInformationPrimaryPatch
object
11 properties
ResourceNotFoundResponse
object
3 properties
PolicySubmissionResponse
object
4 properties 2 required
ZinniaIllustration
object
3 properties 2 required
PersonalInformationOwner
object
11 properties 5 required
NonReplacement
object
20 properties 6 required
PolicySubmissionUpdate
object
6 properties 1 required
Payor
object
11 properties 5 required
PersonalInformationPayeePatch
object
11 properties
AlienRegistrationIdentifier
PersonalInformationAuthorizedSignerPatch
object
11 properties
OtherInterestedPartyResponse
object
9 properties
CustomIdentifier
object
2 properties
PolicyPatch
object
14 properties
FlatExtraPatchTemporary
object
4 properties
InsuranceHistoryAddressDetail
object
9 properties 6 required
PersonalInformationInsuredPatch
object
10 properties
PayeeResponse
object
10 properties
OwnerResponse
object
10 properties
EinIdentifierResponse
SsnIdentifier
Replacement
object
20 properties 17 required
InsuredResponse
object
14 properties
DocumentSuccessResponse
object
4 properties 4 required
PersonalInformationPayor
object
11 properties 2 required
BirthState
string
Only applicable for US born party
IdentifierStatus
string
Status of the identifier document
PersonalInformationPrimary
object
11 properties 2 required
PassportIdentifierPatch
GovernmentIssuedIdentifierPatch
ItinIdentifierResponse
PhoneNumber
object
8 properties 5 required
EinIdentifierPatch
Insured
object
14 properties 6 required
SignatureV2
object
3 properties 2 required
PersonalInformationAgent
object
11 properties 2 required
OtherInterestedParty
object
9 properties 4 required
DriversLicenseIdentifierPatch
TrustDetailsResponse
object
5 properties
ApplicationResponse
object
6 properties
EmploymentPatch
object
5 properties
RiderDetailPatch
object
7 properties
AddressPatch
object
10 properties
PassportIdentifierResponse
CoveragePatch
object
7 properties
StateIdIdentifierPatch
AlienRegistrationIdentifierResponse
ItinIdentifierPatch
StateIdIdentifier
PersonalInformationOwnerPatch
object
11 properties
AgentV2Patch
object
11 properties
AuthorizedSignatoryResponse
object
10 properties
EinIdentifier
Grantor
object
11 properties 6 required
OrganizationDetails
object
5 properties 2 required
PaymentV2Patch
object
11 properties
EmailPatch
object
3 properties
ReplacementPatch
object
20 properties
PersonalInformationGrantorPatch
object
11 properties
Email
object
3 properties 3 required
AuthorizedSignatoryPatch
object
10 properties
PersonalInformationTrusteePatch
object
11 properties
PersonalInformationAgentResponse
object
10 properties
AgentV2Response
object
11 properties
CoverageInsuredPatch
object
12 properties
CreateCaseRequest
object
1 property 2 required
OrganizationDetailsResponse
object
5 properties
PersonalInformationOtherInterestedParty
object
11 properties 2 required
RelationshipPatch
object
2 properties
PersonalInformationOtherInterestedPartyResponse
object
10 properties
Conversion
object
15 properties 3 required
PayorResponse
object
11 properties
AgentV2
object
11 properties 8 required
OtherInterestedPartyPatch
object
9 properties
ExternalIdentifier
object
5 properties 3 required
DocumentRequest
object
9 properties 10 required
PartyPatch
array
All the party role should be explicitly send in the party object.
PhoneNumberPatch
object
8 properties
RiderDetail
object
7 properties 3 required
PersonalInformationCoverageInsuredPatch
object
11 properties
PersonalInformationAuthorizedSigner
object
11 properties 2 required
PersonalInformationAgentPatch
object
11 properties
Party
array
All the party role should be explicitly send in the party object.
SsnIdentifierPatch
PartyResponse
array
All the party role should be explicitly send in the party object.
AuthorizedSignatory
object
10 properties 5 required
Trustee
object
11 properties 6 required
GrantorResponse
object
11 properties
PaymentAddress
object
9 properties
ServerErrorResponse
object
2 properties
AccessDeniedResponse
object
2 properties
TrustDetailsPatch
object
5 properties
FlatExtraPermanent
object
4 properties 2 required
Owner
object
10 properties 8 required
UnderwritingReviewPatch
object
12 properties
StateIdIdentifierResponse
GrantorPatch
object
11 properties
ValidationResponse
object
4 properties
OrganizationDetailsPatch
object
5 properties
ExternalIllustration
object
4 properties 2 required
IdentifierType
string
Type of identifier document
TrusteeResponse
object
11 properties
RiderInsuredResponse
object
12 properties
PayeePatch
object
10 properties
PersonalInformationThirdPartyResponse
object
10 properties
PersonalInformationThirdParty
object
11 properties 2 required
UnderwritingReview
object
12 properties 5 required
BankInformationV2
object
8 properties
BeneficiaryResponse
object
10 properties
SignatureV2Patch
object
3 properties
CountryV2
string
ISO Country Code https://en.wikipedia.org/wiki/ListofISO3166countrycodes
CaseSuccessResponse
object
3 properties
Payee
object
10 properties 5 required
ZinniaIllustrationPatch
object
3 properties
CoverageInsured
object
12 properties 6 required
PaymentAddressPatch
object
9 properties
ThirdPartyDesigneePatch
object
9 properties
Relationship
object
2 properties
PersonalInformationPayee
object
11 properties 2 required
PersonalInformationOtherInterestedPartyPatch
object
11 properties
Policy
object
14 properties 9 required
PayorPatch
object
11 properties
ThirdPartyDesigneeResponse
object
9 properties
PersonalInformationInsured
object
10 properties 5 required
Coverage
object
7 properties 2 required
OwnerPatch
object
10 properties
Application
object
7 properties 4 required
DriversLicenseIdentifierResponse
PersonalInformationGrantor
object
11 properties 2 required
PersonalInformationTrustee
object
11 properties 2 required
PaymentV2
object
11 properties 7 required
IdentifierPatch
object
4 properties
ZinniaIllustrationResponse
object
3 properties
TrusteePatch
object
11 properties
ApplicationPatch
object
8 properties
FlatExtraTemporary
object
4 properties 4 required
ExternalIdentifierPatch
object
5 properties
PersonalInformationOwnerResponse
object
10 properties
Identifier
object
4 properties 2 required
PersonalInformationThirdPartyPatch
object
11 properties
ItinIdentifier
GovernmentIssuedIdentifier
ExternalPartyIdentifierResponse
Address
object
10 properties 7 required
BankInformationV2Patch
object
8 properties
Employment
object
5 properties 2 required
State
string
Abbreviated names for states
BeneficiaryPatch
object
12 properties
FlatExtraPatchPermanent
object
4 properties
Beneficiary
object
12 properties 6 required
PersonalInformationPayorPatch
object
11 properties
SsnIdentifierResponse
ExternalPartyIdentifierPatch
ExternalPartyIdentifier
NonReplacementPatch
object
20 properties 6 required
Riders
object
2 properties
InsuredPatch
object
14 properties
AlienRegistrationIdentifierPatch
PersonalInformationCoverageInsured
object
11 properties 4 required
TrustDetails
object
5 properties 4 required
ExclusionReview
object
2 properties
ThirdPartyDesignee
object
9 properties 4 required
ConversionPatch
object
15 properties
DriversLicenseIdentifier
PassportIdentifier
NonforfeitureOption
ExternalIllustrationResponse
object
4 properties
ExternalIllustrationPatch
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zinnia-new-business-transactions-v2-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 New Business Transactions V2 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.