New Business - Annuity

Zinnia New Business Annuity API

0.8.0OAS 3.1

New Business — Annuity API surface exposed through Kong. This specification
documents public health check endpoints for application validation, application
processing, payment processing, TOA, eApp, and suitability services, along with
the TOA packet resend request endpoint.

Version History

  • Draft version 0.8.0
    • Added the Resend TOA Packet endpoint (/v1/toa/resend-packet)
  • Draft version 0.7.0
    • Added V3 Annuity application submission endpoint (/v3/new-business/annuity-applications)
    • V3 replaces the flat “role” model with a richer Party model (owner, beneficiary, agent, etc.) and moves bank details from the party to the payment
  • Draft version 0.6.0
    • added ETP endpoints Annuity V1, Annuity V2 and ETP health check
  • Draft version 0.5.0
    • New endpoints — expose /eapp/actuator/health and /suitability/actuator/health publicly through Kong
  • Draft version 0.4.0
    • New endpoint — expose /toa/actuator/health publicly through Kong
  • Draft version 0.3.0
    • New endpoint — expose payment processing health check publicly through Kong
  • Draft version 0.2.0
    • New endpoint — expose application processing health check publicly through Kong
  • Draft version 0.1.0
    • New endpoint — expose application validation health check publicly through Kong
API Base URL
  • Server 1:https://qa.api.zinnia.io

    QA Environment

  • Server 2:https://dev.api.zinnia.io

    DEV Environment

  • Server 3:https://uat.api.zinnia.io

    UAT Environment

  • Server 4:https://api.zinnia.io

    PROD Environment

Security
Auth0 (openIdConnect)
Additional Information
Contact Zinnia New Business Annuity (hitesh.parakh@zinnia.com)

Annuity Version 1

EAPP API Version 1

Submit Annuity Application to Zinnia

Submits an annuity eApp to Zinnia for new business processing.

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

Applications

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

Response

application/json

Accepted

SuccessResponse

statusCodeinteger(int32)

Example:201

timestampstring(date-time)
messagestring

Example:Request Submitted Successfully

post/eApp/v1/applications/annuity

Body

{ "effectiveDate": "2023-12-19", "transmittingCompanyIdentifier": "transmittingCompanyIdentifier", "transmittingCompanyName": "transmittingCompanyName", "receivingCompanyName": "ARCUS", "firmId": "firmId", "agentSubmitDate": "2023-12-19", "planCode": "111", "applicationDate": "2023-12-19", "eAppId": "XXEDJ041120240000000001", "version": "000", "contractState": "NJ", "qualificationFlag": "1", "appIndicator": "E", "telePrivileges": "1", "initialPurchase": { "grossAmount": 238500, "netAmount": 0, "payments": [ { "id": "id", "paymentMethod": "C", "moneySource": "-999", "grossAmount": 238500, "netAmount": 0, "currentAlloc": "Y", "distributorId": "distributorId", "costBasisUnknownInd": false } ] }, "funds": [ { "accCode": "accCode", "amountType": "P", "amount": "amount" } ], "roles": [ { "roleType": "0", "roleOption": "-6", "naturalNameIndicator": "Y", "nameType": "CO", "lastName": "Doe", "dob": "2023-12-19", "sex": "M", "phones": [ { "phoneType": "BF", "countryCode": "countryCode", "areaCode": "areaCode", "number": "number" } ], "addresses": [ { "addressType": "B", "addressLine1": "addressLine1", "city": "city", "state": "AA", "zip": "zip", "country": "AD" } ], "eDelivery": "Y" } ] }
 
application/json