Search
K
New Business - Life

Zinnia New Business API.

0.9.4OAS 3.1

Enterprise API for New Business. This API provides a comprehensive
interface for - Policy Validation - Agent Validation - LexusNexis Validation
for SSN - TPP Integration - Zahara Integration

Version History

  • Draft version 0.6.0
    • Impacted Endpoints- Submit application, Update application, Get NB application
      • Moved insuranceHistory from parties to application block.
      • Renamed insuranceHistory to policyHistory.
      • Added conversion as new type inside policyHistory.
    • Impacted Endpoints- Submit documents
      • Added new enum values in documentType(NB_STATE_REPLACEMENT, NB_CONVERSION)
  • Draft version 0.7.0
    • Impacted Endpoints- Submit application, Update application, Get NB application
      • Typo fix in Enum : UnderwritingRiskClass & DecisionRiskClass.
  • Draft version 0.8.0
    • Impacted Endpoints- Submit application, Update application, Get NB application
      • Typo fix in Enum : Grantor role enum updated
      • Updated missing key in party object-> Beneficiary-> birthSex
  • Draft version 0.9.0
    • Impacted Endpoints- Upload Document API
      • Changed formNumber datatype from number to string
  • Draft version 0.9.1
    • Impacted Endpoints- All endpoints of everly client
      • Updated the documentype supported enum
  • Draft version 0.9.2
    • New Endpoint- Expose Health Check Endpoints Publicly Through Kong For New Business - Life
  • Draft version 0.9.3
    • New Endpoint- Expose Interim Status Update Endpoint On Kong - Life
  • Draft version 0.9.4
    • New Endpoint- Expose Case Export Endpoint On Kong - Life
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 (hitesh.parakh@zinnia.com)

New Business Transactions V1

New Business Orchestration Services Version 1

Policy Decision Processing

post

Body

application/json

Details require to proceed further with tpp decision

PolicyDecisionRequest

eappIdstringrequired

Unique application Id geenrated by the UI. Each application would have unique identifier

Example:15ea7582-262f-4dfe-8a60-1e8b8e763fd4

caseIdstringrequired

Zinnia Live case

Example:CA0000005656

correlationIdstring

Unique process identifier to track the all linked processed against one single application. This is an optional

Example:2ad51ecf-9923-437f-a6f0-70968e464cdb

carrierstring

Example:CarrierName1

customerIdstring

We get the customer Id as part of application request to support older products.

Example:0017b0000102A1UAAU

idpUserIdstring

Example:abc

appStartDatestring(date-time)

Date (with pattern “yyyy-MM-dd’T’HH:mm:ss’Z’”). Application start date

actionTypestring

To update the application, actionType would be - Update

Allowed values:CreateUpdateSubmit

Example:Update

policyStatusstring

Status of the policy. It should be - Issued in order to issue the policy

Allowed values:Applied ForApprovedSubmitted to UnderwritingPendingDeclinedQuotedRisk Not AcceptableProposedCounter OfferNot TakenIssue PendingIssuedClosedActiveLapsedCancelled Not TakenLapse PendingCancelled FreeLookCancelledOffer AcceptedDeath Claim PendingDeath Claim PaidExpiredMaturedSurrenderedRescissionDeath Claim ApprovedSuspended ActiveSuspended Not Active

Example:Issued

appSubmissionTypestring

Submission method of the application

Allowed values:InternetElectronicHandwritten

Example:Electronic

policyHoldingFormstring

Holding Form. It should always be Individual.

Allowed values:Individual

Example:Individual

policyHoldingStatusstring

Holding Status

Allowed values:ProposedActive

Example:Proposed

consentIndstring

Consent Indicator Value. Whether the user has provided the consent for this policy or not. This value is used by the underwriting system.

Allowed values:YesNo

appStatestring

State Code

Allowed values:ALAKAZARCACOCTDCDEFLGAHIIDILINIAKSKYLAMEMDMAMIMNMSMOMTNENVNHNJNMNYNCNDOHOKORPARISCSDTNTXUTVTVAWAWVWIWYGUPR

Example:AL

consentIndStatestring

Consented state value

Allowed values:ALAKAZARCACOCTDCDEFLGAHIIDILINIAKSKYLAMEMDMAMIMNMSMOMTNENVNHNJNMNYNCNDOHOKORPARISCSDTNTXUTVTVAWAWVWIWY

consentSubmissionTypestring

Consented submission method of the application

Allowed values:InternetElectronicHandwritten

Example:Electronic

appFormNumberstring

Form number if applicable. The number assigned on the application form.

Example:ICC20 ABC 104_08-20

appVersionNumberstring

Form version number if applicable

Example:ICC20 ABC 104_08-20

pageLastVisitedIdstring

User Id who has accessed this page last time.

appLastUpdatedstring(date-time)

Date (with pattern “yyyy-MM-dd’T’HH:mm:ss’Z’”). Application last update date.

appExpirationDatestring(date-time)

Date (with pattern “yyyy-MM-dd’T’HH:mm:ss’Z’”). Application expiration date

marketingOptIndstring

Marketing Indicator flag used by the distributor to capture the sale scope.

Allowed values:YesNo

agreeToTermsIndstring

Agreed to terms and condition or not.

Allowed values:YesNo

replacementIndicatorstring

Flag to dertermine whether this is replacement application or not.

Allowed values:YesNoUnknown

pageIdstring

Page Identifier

Example:5f45f7b34a3eea021f2fef1c

overrideDecisionFlagboolean

Flag to dertermine override decisions. In case of true Override results is required.

overrideResultsobject
Show Child Parameters
quoteobject
Show Child Parameters
payloadobject
Show Child Parameters

Response

application/json

Created

SuccessResponse

statusCodeinteger(int32)

Example:201

timestampstring(date-time)
messagestring

Example:Request Submitted Successfully

post/bpm/newbusiness/v1/policy-decision

Body

{ "eappId": "15ea7582-262f-4dfe-8a60-1e8b8e763fd4", "caseId": "CA0000005656" }
 
application/json

Evidence Request

post

Body

application/json

Additional evidence requested from TPP to PG.

TppEvidenceRequest

TXLifeobjectrequired
Show Child Parameters
AppliesToPartyIDstring
ReqIdstring

Response

application/json

Case Created

SuccessResponse

statusCodeinteger(int32)

Example:201

timestampstring(date-time)
messagestring

Example:Request Submitted Successfully

post/bpm/newbusiness/v1/evidence-request

Body

{ "TXLife": { "TXLifeRequest": { "TransRefGUID": "TransRefGUID", "OLifE": {} } } }
 
application/json

Submit interim status update

post

Body

application/json

Details required to submit interim status to PG

InterimStatusUpdateRequest

eappIdstringrequired

Unique application Id generated by the UI. Each application would have unique identifier

Example:15ea7582-262f-4dfe-8a60-1e8b8e763fd4

caseIdstringrequired

Zinnia Live case

Example:CA0000005656

policyNumberstring

Policy Number

Example:AB00000001

uwCaseIdstring

Underwriter caseId

Example:UW0000005656

carrierstring

Client Code

Example:CL0000001

policyStatusstring

Status of Policy

Example:Policy Status

underwritingobject
Show Child Parameters

Response

application/json

Case Created

SuccessResponse

statusCodeinteger(int32)

Example:201

timestampstring(date-time)
messagestring

Example:Request Submitted Successfully

post/bpm/newbusiness/v1/interim-status-update

Body

{ "eappId": "15ea7582-262f-4dfe-8a60-1e8b8e763fd4", "caseId": "CA0000005656" }
 
application/json