Search
K
New Business - Annuity

ResourceNotFoundResponse

object
statusCodeinteger(int32)

Example:404

timestampstring(date-time)
errorIdstring

Example:a4a57ed0-2c1b-4922-9959-3b85dd8a96d3

messagestring

Example:Resource not found

errorarray[string]

Example:Resource not found for provided input

Example

AccessDeniedResponse

object
statusCodeinteger(int32)

Example:403

timestampinteger(int64)

Example:1681395423438

errorIdstring

Example:0286d47a-7ad9-499c-8ca0-8f6634d236a3

messagestring

Example:User is not authorized for the carrier : ABC

Example

ServerErrorResponse

object
statusCodeinteger(int32)

Example:500

timestampinteger(int64)

Example:1681395423438

errorIdstring

Example:0286d47a-7ad9-499c-8ca0-8f6634d236a3

messagestring

Example:Failed to process request

Example

Applications

object
effectiveDatestring(date)required

Date (with pattern “yyyy-mm-dd”). e-App submitted date to Zinnia.

Example:2023-12-19

transmittingCompanyIdentifierstringrequired

An identifer that represents Transmitting Company

transmittingCompanyNamestringrequired

Transmitting Company Name

receivingCompanyNamestringrequired

Receiving Company Name

Example:ARCUS

firmIdstringrequired

External ID in MCS that belongs to the Firm

agentSubmitDatestring(date)required

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

Example:2023-12-19

applicationSignedCountystring

Application Signed County

planCodestringrequired

Product code assigned by Zinnia Admin system

Example:111

statusCodestring

Application Status code derived at Zinnia

Example:App Entry

applicationDatestring(date)required

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

Example:2023-12-19

policyDatestring(date)

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

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”).

Example:2023-12-19

illustration/QuoteStartDatestring(date)

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

Example:2023-12-19

ownerSignedDatestring(date)

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

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”).

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”).

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”).

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”).

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”).

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”).

Example:2023-12-19

igoDatestring(date)

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

Example:2023-12-19

eAppIdstringrequired

Unique Identifier against an e-App application. First two 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.

Example:XXEDJ041120240000000001

versionstringrequired

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

Example:000

contractStatestringrequired

Contract State. 2 Digit state code

Example:NJ

qualificationFlagstringrequired

Qualification Codes

Allowed values:123456789111314161718192021222324252627282930313233343536373839404156575859

appIndicatorstringrequired

To determine whether the request is via eApp or Paper App

Allowed values:EP

commissionOptionstring

Commission Options will be provided by Zinnia for the respective Product

Example:A

imoFlagstring

imoFlag Derived at Zinnia

Allowed values:YesNo

binNbrstring

Brokerage Identification Number

rothYearstring

Roth year - Derived by Zinnia

Example:2024

telePrivilegesstringrequired

Tele privileges value

Allowed values:123456

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

funds that sums upto 100% or the total dollar values sums to the grossAmount

>= 1 items

Show Child Parameters
featuresarray[object]

feature for any feature/rider selected by user

>= 1 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

>= 1 items

Show Child Parameters
payoutsarray[object]

payouts if it needs to be set up for the policy

Show Child Parameters
Example

PolicyValue

object
fedMaritalStatusstringrequired

Fed marital status

Allowed values:-99912

fedMaritalAllowancestringrequired

Fed marital status allowance

Example:3

withholdingarray[object]
Show Child Parameters
fedRatestring

Federal rate - Derived by Zinnia

Example:1

stateMaritalStatusstringrequired

State Marital Status

Allowed values:-99912

stateMaritalAllowancestringrequired

State marital status allowance

Example:1

stateRatestring

State rate - Derived by Zinnia

Example:1

contribTypestring

Contribution type

Allowed values:0123456789

mktSegmentstringrequired

Market Segment Code

Allowed values:01234567891011121314151617181920212223

specMktSegmentstring

Spec Market segment

Example:1

bMarkRatestring

Example:3.5

deliveryMethodstring

Delivery method derived by Zinnia

Allowed values:FaxEmailMail

Example