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 Non Financial Transactions API

Non Financial Transactions

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 44 operations across 43 paths, and defines 86 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.

44 operations 43 paths 86 schemas 2 GET1 PATCH34 POST7 PUT

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 Non Financial Transactions 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 44

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

Non Financial Transactions 44

Non Financial Transactions

POST
/policy/v1/transactions/{planCode}/{policyNumber}/multi-agent/validation
Validation multi agent Transaction
validationMultiAgentTransaction1 2 params body → 200400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/Restrict
Submit active restrict transaction
submitActiveRestrictPolicyApi 2 params body → 202400500
GET
/policy/v1/transactions/{planCode}/{policyNumber}/Restrict
Get restriction alerts for a policy
getActiveRestrictAlertsPolicyApi 2 params → 200500
GET
/policy/v1/transactions/{planCode}/{policyNumber}/Restrict/alerts
Get restriction alerts for a policy
getActiveRestrictAlertsV2PolicyApi 2 params → 200500
POST
/bpm/v1/policies/{planCode}/{policyNumber}/{transactionType}/eligibilitycheck
Eligibility Check For Non-Financial Transaction
eligibilitycheckNonFinancialTransaction 3 params → 200400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/bankaccount/eligibilitycheck
Eligibility Check Bank Transaction
eligibilitycheckbankTransaction1 2 params → 200400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/parties/{partyId}/{partyRole}/validation
Party Change request
updatePartyValidation1 4 params body → 202400500
POST
/bpm/v1/policies/{planCode}/{policyNumber}/billingfeaturechange/eligibilitycheck
Eligibility Check Billing Feature Change
billingFeatureChangeEligibilityCheck 2 params → 200400500
POST
/bpm/v1/policies/{planCode}/{policyNumber}/billingfeaturechange/validation
Validate Billing Feature Change
billingFeatureChangeValidation 2 params body → 200400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/freelookcancellation/eligibilitycheck
Freelook cancellation request
freelookcancellationEligibility1 2 params body → 202500
PUT
/policy/v1/transactions/{planCode}/{policyNumber}/parties/{partyId}/address/{addressId}
Address Change Request
updateAddress1 4 params body → 202400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/emailaddress/eligibilitycheck
Eligibility Check Email Address Transaction
eligibilitycheckEmailAddressTransaction1 2 params → 200400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/address/eligibilitycheck
Eligibility Check Address Transaction
eligibilitycheckAddressTransaction1 2 params → 200400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/parties/{partyId}/address
Create new address based on request
addNewAddress1 3 params body → 202400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/emailaddress/{partyId}/validation
Add new Email Address based on request
emailAddressValidation1 5 params body → 202400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/address/{partyId}/validation
Validate Address based on request
addressValidation2 5 params body → 202400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/parties/{partyId}/emailaddress
Create new Emailaddress based on request
emailNewAddress1 3 params body → 202400500
PUT
/policy/v1/transactions/{planCode}/{policyNumber}/parties/{partyId}/emailaddress/{emailId}
Email Address Change Request
updateemailAddress1 4 params body → 202400500
PUT
/policy/v1/transactions/{planCode}/{policyNumber}/parties/{partyId}/emailaddresses
Multiple Email Address Change Request
updateemailAddress3 3 params body → 202400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/parties/{partyId}/phone
Create new Phone Number based on request
addNewPhone1 3 params body → 202400500
PUT
/policy/v1/transactions/{planCode}/{policyNumber}/parties/{partyId}/phone/{phoneId}
Phone Number Change Request
updatePhone1 4 params body → 202400500
PUT
/policy/v1/transactions/{planCode}/{policyNumber}/parties/{partyId}/phones
Multiple Phone Number Change Request
updatePhone2 3 params body → 202400500
PATCH
/policy/v1/transactions/{planCode}/{policyNumber}/parties/{partyId}/identifiers
Identifier change Request
identifierChange1 3 params body → 202400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/parties/{partyId}/bankaccount
Add new Bank Account based on request
addNewBankAccount1 3 params body → 202400500
PUT
/policy/v1/transactions/{planCode}/{policyNumber}/parties/{partyId}/bankaccount/{bankId}
Bank Account Change Request
updateBankAccount1 4 params body → 202400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/communicationpreference/eligibilitycheck
Eligibility Check Communication Preference Transaction
eligibilitycheckCommunicationPreferenceTransaction1 2 params → 200400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/parties/{partyId}/communicationpreference/validation
Validate Communication Preference based on request
validateCommunicationPreference1 3 params body → 202400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/parties/{partyId}/communicationpreference
Update Communication Preference based on request
changeCommunicationPreference1 3 params body → 202400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/parties/{partyId}/partyname
Update Party Name based on request
changePartyName1 3 params body → 202400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/parties/{partyRole}
Party Add request
addParty1 3 params body → 202400500
PUT
/policy/v1/transactions/{planCode}/{policyNumber}/parties/{partyId}/{partyRole}
Party Change request
updateParty1 4 params body → 202400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/parties/{partyRole}/eligibilitycheck
EligibilityCheck For Party Role Transaction
partyRoleeligibilitycheck1 3 params → 200400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/parties/taxwithholding/eligibilitycheck
Eligibility Check Tax Withholding
eligibilitycheckTaxWithholding1 2 params → 200400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/parties/taxwithholding/validation
Validate Tax Withholding
validationTaxWithholding1 2 params body → 200400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/parties/taxwithholding
Submit Tax Withholding Transaction
submitTaxWithholding1 2 params body → 202400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/billingfeaturechange/eligibilitycheck
Eligibility Check Billing Feature Change
billingFeatureChangeEligibilityCheck1 2 params → 200400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/billingfeaturechange/validation
Validate Billing Feature Change
billingFeatureChangeValidation1 2 params body → 200400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/freelookcancellation
Freelook cancellation request
freelookcancellation1 2 params body → 202500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/deliverydatesetup/eligibilitycheck
Eligibility Check to Set Delivery Date
setDeliveryDateEligibilityCheck1 2 params body → 200400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/deliverydatesetup
Set Delivery Date Transaction
setDeliveryDate1 2 params body → 200400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/edeliveryenrollment
EDelivery Enrollment
EDeliveryEnrollment1 2 params body → 200400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/nonforfeiture/eligibilitycheck
Eligibility Check For Non-Forfeiture Transaction
nonForfeitureEligibility1 2 params → 200400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/nonforfeiture/validation
Validation Check For Non-Forfeiture Transaction
nonForfeitureValidation1 2 params body → 200400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/nonforfeiture
Non-Forfeiture Transaction
nonForfeiture1 2 params body → 202500

Schemas 86

The contract defines 86 schemas that model the data the API accepts and returns. The most detailed are Party (33 properties), ActiveRestrictTransactionRequest (16 properties), BillingFeatureChangeRequest (12 properties), Address (11 properties). Each schema is shown below with its type and property counts.

CountryCallingCodes
string
ISO Country calling Code https://en.wikipedia.org/wiki/Listoftelephonecountrycodes
ActiveRestrictSubmitInfo
object
Submission metadata for active restrict requests
3 properties
ActiveRestrictTransactionDocument
object
Document reference in the submit request (common BPM document fields)
8 properties
Identification
object
4 properties
AlienRegistrationIdentifier
TransactionFailureResponse
object
2 properties
DisbursementType
string
The type of amount for withdrawal such as Gross or Net
TaxRateToUse
string
How tax rate should be applied for withholding
EmailChange
object
3 properties 2 required
EDeliveryEnrollmentRequest
object
9 properties 6 required
SsnIdentifier
IdentifierStatus
string
Status of the identifier document
BillingFeatureChangeDocument
object
Supporting document reference for billing feature change
6 properties
TaxWithholdingType
string
PartyNameChange
object
3 properties 2 required
Nonforfeiture
object
9 properties
TaxWithholdingInstructions
object
8 properties 3 required
BillingFeatureChangeRequest
object
Request body for billing feature change validation (POST /bpm/v1/policies/{planCode}/{policyNumber}/billingfeaturechange/validation and policy API alias).
12 properties 2 required
Phone
object
9 properties
ActiveRestrictRestrictedTransactionItem
object
2 properties
AgentChangeDto
object
9 properties
FreeLookCancellation
object
6 properties 3 required
PartyChange
object
5 properties 2 required
StateIdIdentifier
ActiveRestrictTransactionRequest
object
Request body for active restrict (POST /bpm/v1/policies/{planCode}/{policyNumber}/Restrict). Extends the common transaction case request fields with restrictio…
16 properties
PartyRole
string
Party Role
ActiveRestrictDeactivationBlock
object
3 properties
PartyNameChangeRequest
object
1 property
Email
object
4 properties 3 required
PartyChangeRequest
object
2 properties
ActiveRestrictRestrictionItem
object
Single restriction operation in the submit payload
3 properties
BillingFeatureChangeTransactionReason
string
Reason for initiating the billing feature change transaction
FilingStatus
string
FormerName
AddressChange
object
5 properties 3 required
ExternalIdentifier
object
7 properties 4 required
MultiplePhoneChangeRequest
object
4 properties 2 required
Frequency
string
frequency
BeneficiaryAllocation
object
2 properties
BankAccount
object
11 properties
BillingFeatureChangeSignature
object
Signature details for billing feature change
5 properties
AdhocDisbursementParty
object
7 properties 3 required
PhoneChange
object
3 properties 2 required
Party
object
33 properties
ServerErrorResponse
object
4 properties
ActiveRestrictActivationBlock
object
4 properties
ValidationResponse
object
5 properties
ActiveRestrictPolicyAlertDocument
object
Policy-level restriction alert aggregate (GET /bpm/v1/policies/{planCode}/{policyNumber}/Restrict when data exists).
4 properties
IdentifierType
string
Type of identifier document
BankAccountChange
object
3 properties 2 required
PaymentForm
string
Mode of payment
CommunicationPreferenceChangeRequest
object
1 property
TransactionResponse
object
3 properties
BranchAddress
object
9 properties
SignatureDto
object
Signature details for the agent change
6 properties
MultipleEmailChangeRequest
object
4 properties 2 required
SetDeliveryDateRequest
object
2 properties
DisbursementPaymentForm
string
The type of disbursement method such as DTCC,EFT or credit card.Default EFT.
TransactionAcceptedResponse
object
4 properties
MultipleEmail
object
5 properties 4 required
PartyName
object
8 properties
BillingFeatureChangePolicyFeature
object
Billing policy feature details for the change request
4 properties 1 required
IdentifierChangeRequest
object
4 properties 2 required
Identifier
object
6 properties 3 required
ItinIdentifier
BankAccountChangeRequest
object
2 properties
ActiveRestrictAlertEntry
object
One restriction alert lifecycle record in TDS
6 properties
GovernmentIssuedIdentifier
TaxWithholding
object
8 properties
Address
object
11 properties
Country
string
Abbreviated names for countries
PhoneChangeRequest
object
2 properties
State
string
Abbreviated names for states
Error
object
4 properties
AddressChangeRequest
object
2 properties
FreeLookCancellationRequest
object
1 property
ExternalPartyIdentifier
MultiplePhone
object
10 properties 5 required
TaxWithholdingChangeRequest
object
Request body for tax withholding change (POST /bpm/v1/policies/{planCode}/{policyNumber}/parties/taxwithholding and validation). Extends transaction case field…
7 properties 2 required
ActiveRestrictTdsDocumentRef
object
2 properties
SetDeliveryDateEligibilityRequest
object
3 properties
CommunicationPreferenceChange
object
3 properties 2 required
EmailChangeRequest
object
2 properties
DriversLicenseIdentifier
PassportIdentifier
ActiveRestrictPersonRef
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zinnia-non-financial-transactions-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 Details API
AE Profile APIs.io
Zinnia Documents V2 API
AE Profile APIs.io
Zinnia Documents V3 API
AE Profile APIs.io
#Non Financial Transactions
← Back to Z APIs
API Details
ID
zinnia:zinnia-non-financial-transactions-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-non-financial-transactions-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/zinnia-non-financial-transactions-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 Non Financial Transactions 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.