Search
K
New Business - Annuity

Submit Annuity Documents 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

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

Created

SuccessResponse

statusCodeinteger(int32)

Example:201

timestampstring(date-time)
messagestring

Example:Request Submitted Successfully

post/eApp/v1/applications/documents

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

Annuity Version 2

EAPP API Version 2

Submit Annuity Application 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

Details required to submit the eApp to Zinnia for Annuity

Application

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

keynumber

Zinnia Unique idenitifer for a case. [Derived by Zinnia]

Example:1234567

sourceCdstring

Zinnia Identifier for a client.[Derived by Zinnia]

Example:ZIN_ABC

correlationIdstring

Zinnia Unique Identifier for a case.[Derived by Zinnia]. This is not required for Paper Apps , only eApps.

Example:0ca10708-4b53-464c-b745-355c8f6f0edb

zinniaCaseIdstring

Zinnia Unique Identifier for a case.[Derived by Zinnia]. This is required for Paper Apps, not eApps and will be sent via Orion Application.

Example:CA0123456789

transmittingCompanyIdentifierstringrequired

An identifer that represents Transmitting Company which is of 4 char.

Example:1234

transmittingCompanyNamestringrequired

Transmitting Company Name

Example:ABC

receivingCompanyNamestringrequired

Receiving Company Name, Derived by Zinnia based on the set up in Zinnia Systems.

Example:ABC

submitterNSCCIdstring

The NSCC assigned membership ID for the firm initiating the transactions.Only applicable for DTCC cases.

Example:0075

submitterNSCCNamestring

Name of the Submitter (Settling Firm).Only applicable for DTCC cases.

Example:LPL

asidstring

Identifier assigned by a clearing firm/service provider to a firm that clears business through them.Only applicable for DTCC cases.

Example:0075

asidNamestring

Name of associated firm.Only applicable for DTCC cases.

Example:LPL

firmExternalIdstring

External ID in MCS [Zinnia Commission System] that belongs to the Firm. firmExternalId or firmTaxId or firmNPN is mandatory.

Example:Q01530

firmTaxIdstring

9 digit Tax ID in MCS [Zinnia Commission System] that belongs to the Firm. firmExternalId or firmTaxId or firmNPN is mandatory.

Match pattern:\d{9}

>= 9 characters<= 9 characters

Example:123456789

firmNPNstring

NPN in MCS [Zinnia Commission System] that belongs to the Firm. firmExternalId or firmTaxId or firmNPN is mandatory.

Example:294128

agentSubmitDatestring(date)required

Agent submit date (with pattern “yyyy-mm-dd”).

Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})

Example:2023-12-19

applicationSignedCountystring

Application Signed County, Only for Florida if required by Business Processing System for running rules.

Example:Dade

planCodestringrequired

Product code assigned by Zinnia Admin system

Example:111

applicationDatestring(date)required

Application Signed Date (with pattern “yyyy-mm-dd”).

Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})

Example:2023-12-19

policyDatestring(date)

Client Agreement Date/Issue Date (with pattern “yyyy-mm-dd”).

Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})

Example:2023-12-19

solicitationDatestring(date)

The date in which the Agent first proposes to the client the use of an insurance product, which may or may not be in response to an engagement/planning process. (with pattern “yyyy-mm-dd”).

Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})

Example:2023-12-19

quoteStartDatestring(date)

The start (run) date of the illustration or quote (with pattern “yyyy-mm-dd”).

Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})

Example:2023-12-19

quoteIdstring

The ID for the illustration or quote.

Example:12345

ownerSignedDatestring(date)

This date represents when the natural owner electronically signed the application and any supporting documentation. (with pattern “yyyy-mm-dd”).

Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})

Example:2023-12-19

jointOwnerSignedDatestring(date)

This date represents when the joint owner electronically signed the application and any supporting documentation. (with pattern “yyyy-mm-dd”).

Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})

Example:2023-12-19

annuitantSignedDatestring(date)

This date represents when the Annuitant electronically signed the application and any supporting documentation. (with pattern “yyyy-mm-dd”).

Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})

Example:2023-12-19

jointAnnuitantSignedDatestring(date)

This date represents when the joint Annuitant electronically signed the application and any supporting documentation. (with pattern “yyyy-mm-dd”).

Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})

Example:2023-12-19

trusteeSignedDatestring(date)

This date represents when the trustee/representative electronically signed the application and any supporting documentation. (with pattern “yyyy-mm-dd”).

Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})

Example:2023-12-19

beneficiarySignedDatestring(date)

This date represents when the Beneficiary electronically signed the application and any supporting documentation. (with pattern “yyyy-mm-dd”).

Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})

Example:2023-12-19

spouseSignedDatestring(date)

This date represents when the Spouse electronically signed the application and any supporting documentation. (with pattern “yyyy-mm-dd”).

Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})

Example:2023-12-19

igoDatestring(date)

Stores the IGO date. It is mandatory when contract have trust Date (with pattern “yyyy-mm-dd”).

Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})

Example:2023-12-19

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.

>= 25 characters

Example:XXXXEDJ041120240000000001

versionstringrequired

Version for that case - 3 digits, incremental if same case if submitted more than once in case of errors.

Example:000

contractNbrstring

Unique number of the policy.

Example:000

contractStatestringrequired

Contract State. State code

Allowed values:AAAEAKALAPARAZCACOCTDCDEFLGAHIIAIDILINKSKYLAMAMDMEMIMNMOMSMTNCNDNENHNJNMNVNYOHOKORPARISCSDTNTXUTVAVTWAWIWVWY

Example:NJ

solicitationStatestring

Solicitation State. State code

Allowed values:AAAEAKALAPARAZCACOCTDCDEFLGAHIIAIDILINKSKYLAMAMDMEMIMNMOMSMTNCNDNENHNJNMNVNYOHOKORPARISCSDTNTXUTVAVTWAWIWVWY

Example:NJ

qualificationFlagstringrequired

Qualification Codes

Allowed values:IRAREGIRASPSLIRAROLLNONQUALROTHIRAIRASIMPLE403B401K401A457BPENPLNHR10KEOGHINHERITIRANONQUALSTRPLNINHERITROTHIRA401GROTH401KROTH403BEDUIRAPROFSHRPLNMONEYPURCHPENSPLNTARGTBENFTPLNCUSTIRACUSTROTHIRACUSTROLLIRAQUALIFIED401SCHEDA412EROTHIRACONVCORPDEFERCOMPCORPPENSCUSTINHERITIRACUSTINHERITROTHIRACUSTSARSEPIRACUSTSIMPLEIRACUSTSPOUSALIRACUSTIRASEPCUSTQLACIRADEFAULTGROUPTSAIRASEPNON457DEFCOMPIRAQLACUGMAUTMAVULNQ

Example:IRAREG

custodialstring

Describes whether the case is custodial or not

Allowed values:YESNO

Example:YES

appIndicatorstringrequired

To determine whether the request is via eApp or Paper App

Allowed values:ELECTPAPER

Example:ELECT

suitabilityAppIndicatorstringrequired

To determine whether the Suitability request is via eApp or Paper App. Select NA if Suitability is not being done via Zinnia.

Allowed values:NAELECTPAPER

Example:ELECT

ofacIndicatorstringrequired

To determine whether the OFAC request is being sent electronically to Zinnia. Select NO if OFAC is not being done via Zinnia electronically.

Allowed values:NOYES

Example:YES

commissionOptionstring

Commission Options will be provided by Zinnia for the respective Product

Example:A

binNbrstring

Brokerage Identification Number

Example:ABC0DF

telePrivilegesstring

Tele privileges value

Allowed values:NONEALLEXCONLYQTONLYOWNONLYAGTONLYDIARYNT

Example:NONE

signatureMethodstringrequired

signatureMethod

Allowed values:NONEVOICESIGNPADWETSIGBIOCLICKTHRU

Example:NONE

documentControlNumberstring

documentControlNumber is an NSCC data point, Will be derived by Zinnia.

Example:1000ABC00000000000

totalAttachmentCountintegerrequired

totalAttachmentCount expected in Attachment payload

Example:1

fileInceptionTimestring(date-time)required

Time when the case is received within ETP

Example:2025-06-26T00:00:00.000Z

policyValuesobject
Show Child Parameters
initialPurchaseobjectrequired
Show Child Parameters
fundsarray[object]required

funds that sums upto 100%

>= 1 items

Show Child Parameters
featuresarray[object]

feature for any feature/rider selected by user

>= 0 items

Show Child Parameters
rolesarray[object]required

roles that sums every role option to 100%

>= 1 items

Show Child Parameters
specialProgramsarray[object]

specialPrograms if any recurring transaction needs to be set up

>= 0 items

Show Child Parameters
payoutsarray[object]

payouts if it needs to be set up for the policy

Show Child Parameters
errorsarray[string]

Derived by Zinnia

Example:Error 1

Response

application/json

Accepted

SuccessResponse

statusCodeinteger(int32)

Example:201

timestampstring(date-time)
messagestring

Example:Request Submitted Successfully

post/eApp/v2/applications/annuity

Body

{ "effectiveDate": "2023-12-19", "transmittingCompanyIdentifier": "1234", "transmittingCompanyName": "ABC", "receivingCompanyName": "ABC", "agentSubmitDate": "2023-12-19", "planCode": "111", "applicationDate": "2023-12-19", "appId": "XXXXEDJ041120240000000001", "version": "000", "contractState": "NJ", "qualificationFlag": "IRAREG", "appIndicator": "ELECT", "suitabilityAppIndicator": "ELECT", "ofacIndicator": "YES", "signatureMethod": "NONE", "totalAttachmentCount": 1, "fileInceptionTime": "2025-06-26T00:00:00.000Z", "initialPurchase": { "grossAmount": 238500.5, "netAmount": 100.5, "payments": [ { "id": "payment_1", "paymentMethod": "CHK", "grossAmount": 238500.5, "netAmount": 0, "currentAlloc": "YES" } ] }, "funds": [ { "fundCode": "XXX000", "amountType": "PCT", "amount": 50.55 } ], "roles": [ { "roleType": "OWN", "rolePercentage": "100", "nameType": "IND", "lastName": "Doe", "dob": "2023-12-19", "sex": "MALE", "citizenshipCountry": "AD", "phones": [ { "phoneType": "BUS", "country": "AD", "areaCode": "404", "number": "1234567890 or 1234567" } ], "addresses": [ { "addressType": "BUS", "addressLine1": "100 ABC Street", "city": "Topeka", "state": "KS", "zip": "66601", "country": "US" } ], "eDelivery": "YES" } ] }
 
application/json

Submit Annuity Documents 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

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

Accepted

SuccessResponse

statusCodeinteger(int32)

Example:201

timestampstring(date-time)
messagestring

Example:Request Submitted Successfully

post/eApp/v2/applications/documents

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

SuccessResponse

object
statusCodeinteger(int32)

Example:201

timestampstring(date-time)
messagestring

Example:Request Submitted Successfully

Example