Authorizationstringrequired
This will be passed as Bearer plus “token” as generated by above token API.
Example:Bearer eykjsfjfjasdasdad
Validate agent details
post
Headers
Body
application/json
Body
application/json
Details required to validate agent
AgentValidationRequest
carrierstringrequired
client code
appStartDatestringrequired
Application start date
Example:2024-02-07
appStatestringrequired
application state
Example:AL
productCodestringrequired
product code
agentsarray[object]
Show Child Parameters
Response
application/json
Response
application/json
Ok
AgentValidationSuccessResponse
statusstring
Example:IGO or NIGO
validationResultarray[object]
Show Child Parameters
post/bpm/newbusiness/v1/agent-validation
Authentication
Headers
Body
{
"carrier": "carrier",
"appStartDate": "2024-02-07",
"appState": "AL",
"productCode": "productCode"
}
application/json
New Business Transactions V2
New Business Orchestration Services Version 2
Create case for New Business
post
Path Parameters
eAppIdstringrequired
Body
application/json
Body
application/json
Required to submit case before submit new business documents / application
CreateCaseRequest
planCodestringrequired
Product code
Example:ABC001
Response
application/json
Response
application/json
Case Created
CaseSuccessResponse
caseIdstring
Example:CA000000536
correlationIdstring
Example:15ea7582-262f-4dfe-8a60-1e8b8e763fd4
eappIdstring
Example:15ea7582-262f-4dfe-8a60-1e8b8e763fd4
post/newbusiness/v2/application/{eAppId}
Authentication
Path Parameters
Body
{
"planCode": "ABC001"
}
application/json
Submit application for New Business
put
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.
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
Headers
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
Headers
Body
{
"caseId": "CA1234567890"
}
application/json