New Business - Annuity
Submit Annuity Documents to Zinnia
Submits documents associated with an annuity eApp to Zinnia.
post
Headers
Authorizationstringrequired
This will be passed as Bearer plus “token” as generated by above token API.
Example:Bearer eykjsfjfjasdasdad
Body
application/json
Body
application/json
Details required to submit the eApp to Zinnia for Annuity
DocumentInformation
appIdstringrequired
Unique Identifier against an e-App application. First 4 letters represent the receiving company, next 3 letters represent the firm, next 8 positions represent the date eApp is submitted, next 10 positions represents the sequential number of the eApps from the eApp instance. For Orion - Accept integers upto 15 digits
Example:XXXXEDJ041120240000000001
versionstringrequired
Version for that case - 3 digits, incremental if same case if submitted more than once in case of errors. For Orion - Accept integers upto 15 digits
Example:000
effectiveDatestring(date)required
e-App submitted date to Zinnia (with pattern “yyyy-mm-dd”).
Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})
Example:2023-12-19
totalDocumentCountnumberrequired
Example:1
documentDetailsarray[object]required
Show Child Parameters
Response
application/json
Response
application/json
Accepted
SuccessResponse
statusCodeinteger(int32)
Example:201
timestampstring(date-time)
messagestring
Example:Request Submitted Successfully
post/eApp/v2/applications/documents
Authentication
Headers
Body
{
"appId": "XXXXEDJ041120240000000001",
"version": "000",
"effectiveDate": "2023-12-19",
"totalDocumentCount": 1,
"documentDetails": [
{
"documentId": "0ca10708-4b53-464c-b745-355c8f6f0edb",
"binaryData": "SGVsbG8gV29ybGQ=",
"formId": "FR2279",
"formName": "Fixed Annuity Order Entry Cover Sheet",
"documentCategory": "NB Supporting Document",
"documentFileType": "pdf"
}
]
}
application/json
New Business Annuity
New Business Annuity Application Submission API Version 3
Submit Annuity Application to Zinnia
Submits an annuity new business case to Zinnia for processing.
post
Headers
Authorizationstringrequired
This will be passed as Bearer plus “token” as generated by above token API.
Example:Bearer eykjsfjfjasdasdad
Body
application/json
Body
application/json
Details required to submit the Annuity new business case to Zinnia
CasePayload
* Additional properties are NOT allowed.
caseIdstring
Zinnia Unique Identifier for a case.[Derived by Zinnia]. This is required for Paper Apps, not eApps and will be sent via Orion Application.
correlationIdstring(uuid)
Zinnia Unique Identifier for a case.[Derived by Zinnia]. This is not required for Paper Apps , only eApps.
Example:0ca10708-4b53-464c-b745-355c8f6f0edb
applicationobjectrequired
Show Child Parameters
illustrationsobject
* Additional properties are NOT allowed.
Show Child Parameters
policyobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
parties
Any Ofarrayrequired
All the party role should be explicitly send in the party object.
Insuredobject
Show Child Parameters
Response
application/json
Response
application/json
Accepted
SuccessResponseV3
statusCodeinteger(int32)
Example:202
timestampstring(date-time)
messagestring
Example:Request Submitted Successfully
post/new-business/v1/eapp
Authentication
Headers
Body
{
"caseId": "CA0123456789",
"correlationId": "0ca10708-4b53-464c-b745-355c8f6f0edb",
"application": {
"key": "435232",
"appId": "XXXXEDJ041120240000000001",
"vendorAppId": "XXXXEDJ041120240000000001",
"versionNumber": "000",
"qlacIndicator": "YES",
"dateQualifiers": {
"applicationDate": "2025-10-22",
"initialSubmitDate": "2025-10-22",
"applicationReceivedDate": "2023-12-19",
"clientAgreementDate": "2023-12-19",
"agentSubmitDate": "2023-12-19",
"ownerSignedDate": "2023-12-19",
"jointOwnerSignedDate": "2023-12-19",
"annuitantSignedDate": "2023-12-19",
"jointAnnuitantSignedDate": "2023-12-19",
"trusteeSignedDate": "2023-12-19",
"primaryAgentSignedDate": "2023-12-19",
"beneficiarySignedDate": "2023-12-19",
"spouseSignedDate": "2023-12-19"
},
"submissionType": "ELECTRONIC",
"customerOtherProductsAnswer": "YES",
"applicationSignedCounty": "Dade",
"submitterNsccId": "6407",
"submitterNsccName": "ADVISOR EXCEL",
"associatedFirmId": "1234",
"associatedFirmName": "LPL",
"vendorId": "1234",
"vendorName": "FIRELIGHT",
"carrierName": "USAA",
"firmExternalId": "Q01530",
"firmTaxId": "123456789",
"firmNPN": "294128",
"replacementIndicator": true,
"qualificationType": "Q401K",
"custodial": "YES",
"commissionOption": "STD",
"brokerageIdentificationNumber": "12345",
"suitabilityAppIndicator": "YES",
"attachment": [
{
"signatureMethod": "SIGNATUREPAD",
"documentControlNumber": "14124235235",
"totalAttachmentCount": "2"
}
]
},
"illustrations": {
"solicitationState": "AA",
"solicitationDate": "2025-10-22",
"quoteStartDate": "2025-10-22",
"quoteEndDate": "2025-10-22",
"quoteId": "525262"
},
"policy": {
"policyNumber": "76488683213",
"planCode": "IU0101",
"productCusip": "43241124",
"productType": "ANNUITY",
"policyStatus": "PENDING",
"policyEffectiveDate": "2025-10-22",
"issueState": "TN",
"issueCountry": "US",
"initialPurchase": {
"grossAmount": 43546,
"netAmount": 22334,
"payment": [
{
"paymentId": "1",
"referenceNumber": "13486821",
"netAmount": "43546.00",
"grossAmount": "22334.00",
"method": "CREDITCARD",
"withdrawalIndicator": "FULL",
"partialWithdrawType": "SPECIFIEDAMOUNTWITHDRAWAL",
"surrenderingDateInstruction": "UPONRECEIPT",
"frequency": "DAILY",
"paymentDate": "2025-05-27",
"draftDate": "2025-05-27",
"externalTransactionId": "A12345",
"externalArrangementId": "B45678",
"automaticPayment": true,
"premType": "DIRECTROLLOVER",
"currentAlloc": "YES",
"waivePremium": "0",
"distributorId": "12344",
"party": [
"5f8f2f5c-6c3b-4e3b-8f2f-5c6c3b4e3b8f"
],
"taxInfo": {
"currentContribAmount": 22334,
"priorContribAmount": 22334,
"taxYear": "2025",
"totalBasis": 0,
"pretefraBasis": 0,
"posttefraBasis": 0,
"post88Amount": 22334
},
"policyHistory": {
"previousPolicyNumber": "55852164",
"emailId": "abc@gmail.com",
"carrier": "New York Life",
"useExistingPolicyFunds": true,
"amount": 22334,
"status": "ACTIVE",
"replacementCoverageAmount": 22334,
"issueDate": "2025-08-29",
"productType": "ANNUITY",
"productSubType": "DISABILITY",
"exchangeType": "EXTERNAL1035",
"taxId": "AAA-GG-SSSS",
"originalCostBasis": "1000",
"applyRateLock": "YES",
"priorEstTransValue": 0,
"priorCarrierProcessLocation": "ABC123DEF4",
"addressDetail": {
"addressType": "MAILING",
"addressLine1": "123 Main St",
"addressLine2": "Apt 4B",
"addressLine3": "Near Apollo",
"city": "Topeka",
"state": "TN",
"zipCode": "66675",
"country": "US"
},
"qualificationType": "INDIVIDUALRETIREMENTACCOUNTREGULAR",
"mecIndicator": "NO",
"internalExcInd": "YES",
"exchangeDate": "2025-10-17"
},
"bankInformation": {
"bankId": "456456465",
"nameOnAccount": "abc",
"accountStatus": "Active",
"accountNumber": "****2456",
"routingNumber": "789167934",
"accountType": "SAVINGS",
"ibaNumber": "123456789",
"abaNumber": "123456789",
"bankName": "XYZ Branch",
"address": {
"addressType": "RESIDENCE",
"addressLine1": "123 Main St",
"addressLine2": "Apt 4B",
"addressLine3": "Near Apollo",
"city": "San Francisco",
"state": "AL",
"zipCode": "94105",
"zipCodeExt": "4465",
"country": "US"
}
}
}
]
},
"feature": [
{
"featureCode": "ABC0000000",
"featureName": "Auto Payment",
"featureStartDate": "2023-12-19",
"featureProcessDay": "FIRST",
"featureDuration": "30",
"featureDurationType": "DAYS",
"featureFrequency": "WEEKLY",
"featureValue": "22334.00",
"featureValueType": "AMOUNT",
"taxWithholdingIndicator": "YES",
"taxFilingStatus": "MARRIED",
"withholding": {
"withAmount": 22334,
"withAmountDesc": "EXTRASTEP4C",
"withAmountType": "PERCENTAGE",
"withAuthority": "FEDERAL"
},
"fund": [
{
"srcFundCode": "ABC000",
"srcFundAllocAmt": 50,
"srcFundAllocPercent": 50,
"srcTargetFundCode": "ABC000",
"srcTargetFundAllocAmt": 50,
"srcTargetFundAllocPercent": 50
}
],
"payment": [
{
"amountType": "PERCENTAGE",
"amount": 22334,
"method": "CREDITCARD",
"grossNetInd": "NET",
"accountType": "CHECKING",
"abaNumber": "123456789",
"bankName": "ABC Bank",
"accountNumber": "1000000000",
"payeeContractEntRelationPtr": "124124"
}
],
"payouts": {
"payoutOption": "LIFEONLY",
"livesType": "Single",
"primarySurvivorAdjType": "string",
"primarySurvivorAdjPct": "100",
"jointSurvivorAdjType": "string",
"jointSurvivorAdjPct": "100",
"annuityFrequencyCode": "MONTHLY",
"certainPeriodQualifier": "ANNUAL",
"certainPeriod": "1",
"payoutStartDate": "2023-12-19",
"fixedPaymentAmount": "1000"
}
}
],
"fundDetails": [
{
"fundType": "FIXED",
"fundCode": "GDGE123",
"fundName": "Fixed Account",
"allocationType": "PERCENTAGE",
"allocationTypeValue": "238500.50"
}
]
},
"parties": [
{
"partyType": "INDIVIDUAL",
"personalInformation": {
"firstName": "Aura",
"middleName": "Smith",
"lastName": "Monroe",
"fullName": "Edward Jones",
"prefix": "DR.",
"suffix": "Sr",
"dateOfBirth": "2000-02-02",
"gender": "FEMALE",
"birthSex": "FEMALE",
"birthState": "AL",
"birthCountry": "US",
"citizenCountry": "US"
},
"partyId": "3f2504e0-4f89-11d3-9a0c-0305e82c3301",
"partyCommunication": "EMAIL",
"eDelivery": "YES",
"partyRole": "INSURED",
"signatures": [
{
"date": "2026-07-01",
"city": "Sacramento",
"state": "CA"
}
],
"partyPercentage": "50.00",
"contractEntRelationPtr": "124124",
"revocabilityCode": "IRREVOCABLE",
"benedistribOption": "EQUAL",
"decedentDob": "2023-12-19",
"trustDate": "2023-12-19",
"dod": "2023-12-19",
"authType": "ASSETALLOCATION",
"authMode": "PHONE",
"relationship": "FATHER",
"identifiers": [
{
"type": "SSN",
"value": "123456789"
}
],
"address": {
"preferredAddressId": "33f206dc-71f4-485f-ad85-5fd25b4fad5f",
"addresses": [
{
"addressId": "c6de7205-8f10-4e09-8321-a1f6159790e3",
"addressType": "RESIDENCE",
"addressLine1": "19 RED RIVER CT",
"addressLine2": "Apt 4B",
"city": "SACRAMENTO",
"state": "AL",
"zipCode": "95831",
"zipCodeExt": "4465",
"country": "US",
"foreignAddressInd": "YES"
}
]
},
"phoneNumber": {
"preferredPhoneId": "07f1828e-1cd0-4333-a6c5-360beffce75a",
"phoneNumbers": [
{
"phoneId": "07f1828e-1cd0-4333-a6c5-360beffce75a",
"type": "MOBILE",
"countryCode": "1",
"areaCode": "234",
"dialNumber": "5678900",
"extension": "1234",
"bestTime": "Morning",
"timezone": "EST",
"zip": "10100",
"zipSuffix": "1010"
}
]
},
"email": {
"preferredEmailId": "61dd39a5-0b9f-48a8-9a56-e4eca6186c05",
"emails": [
{
"id": "61dd39a5-0b9f-48a8-9a56-e4eca6186c05",
"type": "PERSONAL",
"emailAddress": "rishal.srivastava@zinnia.com"
}
]
}
}
]
}
application/json
Annuity Health Check
EAPP API Health Check and Annuity (Annuity app validation, app processing, payment processing, TOA, eApp, and suitability) services Health check
Application Validation Health Check
Returns the health status of the application validation service
get
Response
application/json
Response
application/json
Application is healthy
statusstring
Allowed values:UPDOWN
Example:UP
get/appvalidation/actuator/health
Authentication
application/json