Search
K
New Business - Life

Zinnia New Business API.

0.8.0OAS 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
API Base URL
  • Server 1:https://qa.api.zinnia.io

    QA Environment

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

    DEV Environment

Security
Auth0 (openIdConnect)

New Business Transactions V1

New Business Orchestration Services Version 1

Create Underwriting Case

post

Body

application/json

Details required to initiate the underwriting process and initial validation

ApplicationData

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

correlationIdstringrequired

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

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

carrierstringrequired

Example:CarrierName_1

customerIdstringrequired

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

Example:0017b0000102A1UAAU

idpUserIdstring

Need to update idp user id description

Example:abc

appStartDatestring(date-time)required

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

actionTypestringrequired

To create the application, actionType would be - Create

Allowed values:CreateUpdateSubmit

Example:Create

policyStatusstringrequired

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

appSubmissionTypestringrequired

Submission method of the application

Allowed values:InternetElectronicHandwritten

Example:Electronic

policyHoldingFormstringrequired

Holding Form. It should always be Individual.

Allowed values:Individual

Example:Individual

policyHoldingStatusstring

Holding Status

Allowed values:ProposedActive

Example:Proposed

consentIndstringrequired

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

appStatestringrequired

State Code

Allowed values:ALAKAZARCACOCTDCDEFLGAHIIDILINIAKSKYLAMEMDMAMIMNMSMOMTNENVNHNJNMNYNCNDOHOKORPARISCSDTNTXUTVTVAWAWVWIWYGUPR

Example:AL

consentIndStatestringrequired

Consented state value

Allowed values:ALAKAZARCACOCTDCDEFLGAHIIDILINIAKSKYLAMEMDMAMIMNMSMOMTNENVNHNJNMNYNCNDOHOKORPARISCSDTNTXUTVTVAWAWVWIWY

consentSubmissionTypestringrequired

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

quoteobject
Show Child Parameters
payloadobject
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/application-validation

Body

{
  "eappId": "15ea7582-262f-4dfe-8a60-1e8b8e763fd4",
  "caseId": "CA0000005656",
  "correlationId": "2ad51ecf-9923-437f-a6f0-70968e464cdb",
  "carrier": "CarrierName_1",
  "customerId": "0017b0000102A1UAAU",
  "appStartDate": "appStartDate",
  "actionType": "Create",
  "policyStatus": "Issued",
  "appSubmissionType": "Electronic",
  "policyHoldingForm": "Individual",
  "consentInd": "Yes",
  "appState": "AL",
  "consentIndState": "AL",
  "consentSubmissionType": "Electronic"
}
{ "eappId": "15ea7582-262f-4dfe-8a60-1e8b8e763fd4", "caseId": "CA0000005656", "correlationId": "2ad51ecf-9923-437f-a6f0-70968e464cdb", "carrier": "CarrierName_1", "customerId": "0017b0000102A1UAAU", "appStartDate": "appStartDate", "actionType": "Create", "policyStatus": "Issued", "appSubmissionType": "Electronic", "policyHoldingForm": "Individual", "consentInd": "Yes", "appState": "AL", "consentIndState": "AL", "consentSubmissionType": "Electronic" }
  
curl --request POST \
  --url https://qa.api.zinnia.io/bpm/newbusiness/v1/application-validation \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "eappId": "15ea7582-262f-4dfe-8a60-1e8b8e763fd4",
  "caseId": "CA0000005656",
  "correlationId": "2ad51ecf-9923-437f-a6f0-70968e464cdb",
  "carrier": "CarrierName_1",
  "customerId": "0017b0000102A1UAAU",
  "appStartDate": "appStartDate",
  "actionType": "Create",
  "policyStatus": "Issued",
  "appSubmissionType": "Electronic",
  "policyHoldingForm": "Individual",
  "consentInd": "Yes",
  "appState": "AL",
  "consentIndState": "AL",
  "consentSubmissionType": "Electronic"
}'
application/json
{
  "statusCode": 201,
  "timestamp": "timestamp",
  "message": "Request Submitted Successfully"
}