eAppIdstringrequired
Submit application for New Business
put
Path Parameters
Headers
Authorizationstringrequired
This will be passed as Bearer plus “token” as generated by above token API.
Example:Bearer eykjsfjfjasdasdad
Body
application/json
Body
application/json
Details required to be submitted for Policy generation.
PolicySubmissionRequest
caseIdstringrequired
Case identifier for the policy submission
Match pattern:^CA\d{10}$
Example:CA1234567890
applicationobjectrequired
Show Child Parameters
illustrations
One Ofrequired
ZinniaIllustrationobject
Show Child Parameters
policyobjectrequired
Show Child Parameters
parties
Any Ofarrayrequired
All the party role should be explicitly send in the party object.
Insuredobject
Show Child Parameters
underwritingobjectrequired
Show Child Parameters
Response
application/json
Response
application/json
Accepted
PolicySubmissionResponse
statusstringrequired
Status of the submission
Allowed values:ACCEPTEDPROCESSINGCOMPLETEDFAILED
Example:ACCEPTED
timestampstring(date-time)required
Date and time in ISO-8601 format (YYYY-MM-DDTHH:mm:ss.sssZ)
Match pattern:^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]+)?(Z|[+-][0-9]{2}:[0-9]{2})$
Example:2022-01-01T00:00:00.000Z
messagestring
Example:Request submitted successfully
errorsarray[string]
put/newbusiness/v2/application/{eAppId}
Authentication
Path Parameters
Body
{
"caseId": "CA1234567890",
"application": {
"startDate": "2022-01-01",
"submissionType": "ELECTRONIC"
},
"illustrations": {
"source": "ZINNIA",
"illustrationId": "Q12345"
},
"policy": {
"planCode": "TL0101",
"productType": "INDEXEDUNIVERSALLIFE",
"policyStatus": "ISSUED",
"issueState": "CA",
"issueCountry": "US",
"coverage": {
"faceAmount": 250000,
"plannedPremiumAmount": 2500
},
"payment": {
"referenceNumber": "5f2e0c1a-6b3d-4d3f-8b7f-3f7b6d5e4c3a",
"method": "ACH",
"frequency": "MONTHLY",
"amount": 250000,
"automaticPayment": true,
"draftDate": "2023-01-01",
"paymentDate": "2023-01-01"
}
},
"parties": [
{
"partyId": "2ad51ecf-9923-437f-a6f0-70968e464cdb",
"partyRole": "INSURED",
"partyType": "INDIVIDUAL",
"personalInformation": {
"firstName": "John",
"lastName": "Doe",
"dateOfBirth": "1990-01-01",
"birthSex": "MALE",
"birthCountry": "US"
},
"address": {}
}
],
"underwriting": {
"decision": "APPROVED",
"underwritingRiskClass": "ULTRANONTOBACCO",
"decisionRiskClass": "ULTRANONTOBACCO",
"approvedFaceAmount": 250000,
"approvedFaceAmountMaximum": 250000
}
}
application/json
Update application for New Business
patch
Path Parameters
eAppIdstringrequired
Headers
Authorizationstringrequired
This will be passed as Bearer plus “token” as generated by above token API.
Example:Bearer eykjsfjfjasdasdad
Body
application/json
Body
application/json
Details required to be submitted for Policy generation.
PolicySubmissionUpdate
caseIdstringrequired
Case identifier for the policy submission
Match pattern:^CA\d{10}$
Example:CA1234567890
applicationobject
Show Child Parameters
illustrations
One OfZinniaIllustrationPatchobject
Show Child Parameters
policyobject
Show Child Parameters
parties
Any Ofarray
All the party role should be explicitly send in the party object.
InsuredPatchobject
Show Child Parameters
underwritingobject
Show Child Parameters
Response
application/json
Response
application/json
Accepted
PolicySubmissionResponse
statusstringrequired
Status of the submission
Allowed values:ACCEPTEDPROCESSINGCOMPLETEDFAILED
Example:ACCEPTED
timestampstring(date-time)required
Date and time in ISO-8601 format (YYYY-MM-DDTHH:mm:ss.sssZ)
Match pattern:^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]+)?(Z|[+-][0-9]{2}:[0-9]{2})$
Example:2022-01-01T00:00:00.000Z
messagestring
Example:Request submitted successfully
errorsarray[string]
patch/newbusiness/v2/application/{eAppId}
Authentication
Path Parameters
Body
{
"caseId": "CA1234567890"
}
application/json
Get New Business application
get
Path Parameters
eAppIdstringrequired
Headers
Authorizationstringrequired
This will be passed as Bearer plus “token” as generated by above token API.
Example:Bearer eykjsfjfjasdasdad
Response
application/json
Response
application/json
Accepted
ApplicationResponse
caseIdstring
Case identifier for the policy submission
Example:CA1234567890
applicationobject
Show Child Parameters
illustrations
One OfZinniaIllustrationResponseobject
Show Child Parameters
policyobject
Show Child Parameters
parties
Any Ofarray
All the party role should be explicitly send in the party object.
OwnerResponseobject
Show Child Parameters
underwritingobject
Show Child Parameters
get/newbusiness/v2/application/{eAppId}
Authentication
Path Parameters
application/json
Submit documents for New Business
post
Path Parameters
eAppIdstringrequired
Body
application/json
Body
application/json
Required to submit documents before submit new business application
DocumentRequest
caseIdstringrequired
Zinnia Live case
Example:CA0000005656
externalDocumentIdstring
Unique number assigned to given document by the source system
binaryDatastring(base64)required
Base 64 encoded binary stream
formNumbernumber
Unique Number for a form
Example:123456
documentTypestringrequired
Allowed values:NB_STATE_REPLACEMENTNB_CONVERSIONNB_APPLICATIONCOST_DISCLOSURENON_CONTRACTUALAGENT_REPORTACCELERATED_BENEFIT_RIDERSURRENDER_COMPARISIONCONSENT_PAPERLESSTERMS_OF_USETERMS_CONDITIONSCHARITY_ELECTION_FORMSAUTHORIZATION_FORMSHIPPAHIV_CONSENT_FORM_ALL_STATEAMENDMENTDISCLOSURESNB_STATE_REPLACEMENT_NOTICETRUSTEE_STATEMENTTERMS_OF_USENOTICE_AND_CONSENTPRIVACY_POLICYGLBA_PRIVACY_NOTICEFCRAMIB_PRE_NOTICEID_VERIFICATION_NOTICEHIPAAACCELERATED_BENEFIT_RIDERBUYER_GUIDEILLUSTRATIONSUITABILITYAPPLICATIONSIGNED_APPLICATIONREPLACEMENTS_ACKNOWLEDGEMENT1035_EXCHANGE_SURRENDEREVIDENCE_DOCUMENTAMENDMENTELECTRONIC_FUNDS_TRANSFERSUPPLEMENTAL_APPLICATIONCONFORMING_ILLUSTRATIONSIGNED_ILLUSTRATIONOVERFLOW_ADDITIONAL_INFORMATION
Example:TERMS_OF_USE
categorystringrequired
Category of the document as per OnBase system
Allowed values:NEW_BUSINESS
Example:NEW_BUSINESS
fileNamestringrequired
Source File Name
Example:E0001_Signed_Application.PDF, E0002 Unsigned Application.PDF
displayNamestringrequired
Source File Name
Example:Signed_Application.PDF, Unsigned Application.PDF
fileTypestringrequired
Type of file
Allowed values:pdf
Response
application/json
Response
application/json
Document Persisted
DocumentSuccessResponse
caseIdstringrequired
Example:CA000000536
correlationIdstringrequired
Example:15ea7582-262f-4dfe-8a60-1e8b8e763fd4
eappIdstringrequired
Example:15ea7582-262f-4dfe-8a60-1e8b8e763fd4
documentIdstringrequired
Example:67334f4882c412621f9ab7cc
post/newbusiness/v2/application/{eAppId}/document
Authentication
Path Parameters
Body
{
"caseId": "CA0000005656",
"binaryData": "binaryData",
"documentType": "TERMS_OF_USE",
"category": "NEW_BUSINESS",
"fileName": "E0001_Signed_Application.PDF, E0002 Unsigned Application.PDF",
"displayName": "Signed_Application.PDF, Unsigned Application.PDF",
"fileType": "pdf"
}
application/json
IdentifierInstance
objectidentifierstring
Example:eAppId
valuestring
Example:15ea7582-262f-4dfe-8a60-1e8b8e763fd4
Example