Life new business API covering application intake, requirement and case orchestration, party and agent validation, and DTCC-referenced downstream handoff for the Zinnia life new business platform.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/zinnia-new-business-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.1.0
info:
title: Zinnia New Business API.
description: "Enterprise API for New Business. This API provides a comprehensive\ninterface for - Policy Validation - Agent\
\ Validation - LexusNexis Validation\nfor SSN - TPP Integration - Zahara Integration<br>\n**Version History**\n* Draft\
\ version 0.6.0<br>\n - Impacted Endpoints- Submit application, Update application, Get NB application<br>\n * Moved\
\ insuranceHistory from parties to application block.<br>\n * Renamed insuranceHistory to policyHistory.<br>\n *\
\ Added conversion as new type inside policyHistory.<br>\n - Impacted Endpoints- Submit documents<br>\n * Added new\
\ enum values in documentType(NB_STATE_REPLACEMENT, NB_CONVERSION)\n* Draft version 0.7.0<br>\n - Impacted Endpoints-\
\ Submit application, Update application, Get NB application<br>\n * Typo fix in Enum : UnderwritingRiskClass & DecisionRiskClass.<br>\n\
* Draft version 0.8.0<br>\n - Impacted Endpoints- Submit application, Update application, Get NB application<br>\n \
\ * Typo fix in Enum : Grantor role enum updated<br>\n * Updated missing key in party object-> Beneficiary-> birthSex<br>\n\
* Draft version 0.9.0<br>\n - Impacted Endpoints- Upload Document API<br>\n * Changed formNumber datatype from number\
\ to string<br>\n* Draft version 0.9.1<br>\n - Impacted Endpoints- All endpoints of everly client<br>\n * Updated\
\ the documentype supported enum<br>\n* Draft version 0.9.2<br>\n - New Endpoint- Expose Health Check Endpoints Publicly\
\ Through Kong For New Business - Life<br>\n* Draft version 0.9.3<br>\n - New Endpoint- Expose Interim Status Update\
\ Endpoint On Kong - Life<br>\n* Draft version 0.9.4<br>\n - New Endpoint- Expose Case Export Endpoint On Kong - Life<br>\n\
* Draft version 0.9.5<br>\n - Added replacementLtcIndicator to all Everly Workflows<br>\n* Draft version 0.9.6<br>\n\
\ - Introduced new enum to support Whole Life products<br>\n* Draft version 0.9.7<br>\n - Introduced new enum to support\
\ Everly T65 products<br>\n"
version: 0.9.8
contact:
name: Zinnia New Business Life
email: hitesh.parakh@zinnia.com
x-changelog:
- date: '2025-07-14'
change: CMW-30141 - Added EIN Identifier and additional enums in Suffix
- date: '2025-07-15'
change: CMW-30141 - Added additional enums in entity type
- date: '2025-08-01'
change: CMW-30429 - Added new enum values in documentType(NB_STATE_REPLACEMENT, NB_CONVERSION)
- date: '2025-08-01'
change: CMW-29832 - Changed insuredHistory to policyHistory and updated the hierarchy of the policyHistory
- date: '2025-09-25'
change: CMW-29118 - Updated missing key in Beneficiary Role (birthSex)
- date: '2025-11-18'
change: CMW-32740 - Update BPM API to Support Additional File Types (JPEG, JPG, PNG)
- date: '2025-11-27'
change: CMW-32606 - Expose Health Check Endpoint Publicly Through Kong for New Business - Life
- date: '2025-11-29'
change: CMW-32446 - Expose Interim Status Update Endpoint On Kong - Life
- date: '2025-12-08'
change: CMW-33682 - Expose Case Export Endpoint On Kong - Life
- date: '2026-02-18'
change: CMW-35259 - Added replacementLtcIndicator to all Everly Workflows
- date: '2026-04-20'
change: ZNBA-209 - Introduced new enum to support Whole Life products
servers:
- url: https://qa.api.zinnia.io
description: QA Environment
- url: https://dev.api.zinnia.io
description: DEV Environment
- url: https://uat.api.zinnia.io
description: UAT Environment
- url: https://api.zinnia.io
description: PROD Environment
tags:
- name: New Business Transactions V1
description: New Business Orchestration Services Version 1
- name: New Business Transactions V2
description: New Business Orchestration Services Version 2
paths:
/bpm/newbusiness/v1/policy-decision:
post:
x-internal: true
tags:
- New Business Transactions V1
summary: Policy Decision Processing
operationId: submitPolicyDecisionPayload
requestBody:
description: Details require to proceed further with tpp decision
content:
application/json:
schema:
$ref: '#/components/schemas/PolicyDecisionRequest'
required: true
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessResponse'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationResponse'
'401':
description: Authentication failed
'403':
description: Access denied
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedResponse'
'500':
description: Server error
content:
application/json:
schema:
$ref: '#/components/schemas/ServerErrorResponse'
security:
- Auth0: []
/bpm/newbusiness/v1/evidence-request:
post:
x-internal: true
tags:
- New Business Transactions V1
summary: Evidence Request
operationId: evidenceRequest
requestBody:
description: Additional evidence requested from TPP to PG.
content:
application/json:
schema:
$ref: '#/components/schemas/TppEvidenceRequest'
required: true
responses:
'201':
description: Case Created
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessResponse'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationResponse'
'401':
description: Authentication failed
'403':
description: Access denied
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedResponse'
'500':
description: Server error
content:
application/json:
schema:
$ref: '#/components/schemas/ServerErrorResponse'
security:
- Auth0: []
/bpm/newbusiness/v1/interim-status-update:
post:
x-internal: true
tags:
- New Business Transactions V1
summary: Submit interim status update
operationId: submitInterimStatusUpdate
requestBody:
description: Details required to submit interim status to PG
content:
application/json:
schema:
$ref: '#/components/schemas/InterimStatusUpdateRequest'
required: true
responses:
'201':
description: Case Created
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessResponse'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationResponse'
'401':
description: Authentication failed
'403':
description: Access denied
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedResponse'
'500':
description: Server error
content:
application/json:
schema:
$ref: '#/components/schemas/ServerErrorResponse'
security:
- Auth0: []
/newbusiness/actuator/health:
get:
summary: New Business Life Health Check
tags:
- New Business Life
description: Returns the health status of the application
operationId: getHealth
responses:
'200':
description: Application is healthy
content:
application/json:
schema:
type: object
properties:
status:
type: string
enum:
- UP
- DOWN
example: UP
'401':
description: Authentication failed
'403':
description: Access denied
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedResponse'
'503':
description: Application is unhealthy
content:
application/json:
schema:
type: object
properties:
status:
type: string
enum:
- DOWN
example: DOWN
security:
- Auth0: []
x-kong-plugin-pre-function:
config:
access:
- 'local path = kong.request.get_path()
kong.service.request.set_path("/bpm" .. path)
'
/bpm/newbusiness/v1/application-validation:
post:
tags:
- New Business Transactions V1
summary: Create Underwriting Case
operationId: createUnderwritingCase
requestBody:
description: Details required to initiate the underwriting process and initial validation
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationData'
required: true
responses:
'201':
description: Case Created
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessResponse'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationResponse'
'401':
description: Authentication failed
'403':
description: Access denied
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedResponse'
'500':
description: Server error
content:
application/json:
schema:
$ref: '#/components/schemas/ServerErrorResponse'
security:
- Auth0: []
/bpm/newbusiness/v1/underwriting-submission:
post:
tags:
- New Business Transactions V1
summary: Underwriting Processing
operationId: submitUnderwritingPayload
requestBody:
description: Details require to proceed further with underwriting process
content:
application/json:
schema:
$ref: '#/components/schemas/UnderwritingRequest'
required: true
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessResponse'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationResponse'
'401':
description: Authentication failed
'403':
description: Access denied
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedResponse'
'500':
description: Server error
content:
application/json:
schema:
$ref: '#/components/schemas/ServerErrorResponse'
security:
- Auth0: []
/bpm/newbusiness/v1/evidence-submission:
post:
tags:
- New Business Transactions V1
summary: Receive additional information from UI in response to Underwriter's request.
requestBody:
description: Required to submit additional details to Underwriting System.
content:
application/json:
schema:
$ref: '#/components/schemas/EvidenceResponse'
required: true
responses:
'201':
description: Case Created
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessResponse'
examples:
NewBusiness:
value:
caseId: cde717c9-5f7e-4c63-953c-ef50e44c021a
carrier: CarrierName_1
process: NewBusiness
caseStatus: Open
correlationId: 2ad51ecf-9923-437f-a6f0-70968e464cdb
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationResponse'
'401':
description: Authentication failed
'403':
description: Access denied
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedResponse'
'500':
description: Server error
content:
application/json:
schema:
$ref: '#/components/schemas/ServerErrorResponse'
security:
- Auth0: []
/bpm/newbusiness/v1/application-submission:
post:
tags:
- New Business Transactions V1
summary: Submit application details
operationId: submitApplicationDetails
parameters:
- name: Authorization
required: true
description: This will be passed as Bearer plus "token" as generated by above token API.
in: header
schema:
type: string
example: Bearer eykjsfjfjasdasdad
requestBody:
description: Details required for to submit the decisions to UI
content:
application/json:
schema:
$ref: '#/components/schemas/SubmitPolicy'
required: true
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessResponse'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationResponse'
'401':
description: Authentication failed
'403':
description: Access denied
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedResponse'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundResponse'
'500':
description: Server error
content:
application/json:
schema:
$ref: '#/components/schemas/ServerErrorResponse'
security:
- Auth0: []
/bpm/newbusiness/v1/agent-validation:
post:
tags:
- New Business Transactions V1
summary: Validate agent details
operationId: validateAgentDetails
parameters:
- name: Authorization
required: true
description: This will be passed as Bearer plus "token" as generated by above token API.
in: header
schema:
type: string
example: Bearer eykjsfjfjasdasdad
requestBody:
description: Details required to validate agent
content:
application/json:
schema:
$ref: '#/components/schemas/AgentValidationRequest'
required: true
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/AgentValidationSuccessResponse'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationResponse'
'401':
description: Authentication failed
'403':
description: Access denied
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedResponse'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundResponse'
'500':
description: Server error
content:
application/json:
schema:
$ref: '#/components/schemas/ServerErrorResponse'
security:
- Auth0: []
/newbusiness/v2/application/{eAppId}:
post:
tags:
- New Business Transactions V2
summary: Create case for New Business
parameters:
- name: eAppId
in: path
required: true
schema:
type: string
requestBody:
description: Required to submit case before submit new business documents / application
content:
application/json:
schema:
$ref: '#/components/schemas/CreateCaseRequest'
required: true
responses:
'201':
description: Case Created
content:
application/json:
schema:
$ref: '#/components/schemas/CaseSuccessResponse'
examples:
NewBusiness:
value:
caseId: CA000000456
correlationId: 2ad51ecf-9923-437f-a6f0-70968e464cdb
eappId: 2ad51ecf-9923-437f-a6f0-70968e464cdb
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationResponse'
'401':
description: Authentication failed
content:
application/json:
examples:
NewBusiness:
value:
message: Unauthorized
'403':
description: Access denied
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedResponse'
'500':
description: Server error
content:
application/json:
schema:
$ref: '#/components/schemas/ServerErrorResponse'
security:
- Auth0: []
x-kong-plugin-pre-function:
config:
access:
- 'local path = kong.request.get_path()
kong.service.request.set_path("/bpm" .. path)
'
put:
tags:
- New Business Transactions V2
summary: Submit application for New Business
operationId: submitPolicyDetails
parameters:
- name: Authorization
required: true
description: This will be passed as Bearer plus "token" as generated by above token API.
in: header
schema:
type: string
example: Bearer eykjsfjfjasdasdad
- name: eAppId
in: path
required: true
schema:
type: string
requestBody:
description: Details required to be submitted for Policy generation.
content:
application/json:
schema:
$ref: '#/components/schemas/PolicySubmissionRequest'
required: true
responses:
'202':
description: Accepted
content:
application/json:
schema:
$ref: '#/components/schemas/PolicySubmissionResponse'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationResponse'
'401':
description: Authentication failed
content:
application/json:
examples:
NewBusiness:
value:
message: Unauthorized
'403':
description: Access denied
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedResponse'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundResponse'
'500':
description: Server error
content:
application/json:
schema:
$ref: '#/components/schemas/ServerErrorResponse'
security:
- Auth0: []
x-kong-plugin-pre-function:
config:
access:
- 'local path = kong.request.get_path()
kong.service.request.set_path("/bpm" .. path)
'
patch:
tags:
- New Business Transactions V2
summary: Update application for New Business
operationId: updateEApp
parameters:
- name: Authorization
required: true
description: This will be passed as Bearer plus "token" as generated by above token API.
in: header
schema:
type: string
example: Bearer eykjsfjfjasdasdad
- name: eAppId
in: path
required: true
schema:
type: string
requestBody:
description: Details required to be submitted for Policy generation.
content:
application/json:
schema:
$ref: '#/components/schemas/PolicySubmissionUpdate'
required: true
responses:
'202':
description: Accepted
content:
application/json:
schema:
$ref: '#/components/schemas/PolicySubmissionResponse'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationResponse'
'401':
description: Authentication failed
content:
application/json:
examples:
NewBusiness:
value:
message: Unauthorized
'403':
description: Access denied
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedResponse'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundResponse'
'500':
description: Server error
content:
application/json:
schema:
$ref: '#/components/schemas/ServerErrorResponse'
security:
- Auth0: []
x-kong-plugin-pre-function:
config:
access:
- 'local path = kong.request.get_path()
kong.service.request.set_path("/bpm" .. path)
'
get:
tags:
- New Business Transactions V2
summary: Get New Business application
operationId: GetEApp
parameters:
- name: Authorization
required: true
description: This will be passed as Bearer plus "token" as generated by above token API.
in: header
schema:
type: string
example: Bearer eykjsfjfjasdasdad
- name: eAppId
in: path
required: true
schema:
type: string
responses:
'202':
description: Accepted
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationResponse'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationResponse'
'401':
description: Authentication failed
content:
application/json:
examples:
NewBusiness:
value:
message: Unauthorized
'403':
description: Access denied
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedResponse'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundResponse'
'500':
description: Server error
content:
application/json:
schema:
$ref: '#/components/schemas/ServerErrorResponse'
security:
- Auth0: []
x-kong-plugin-pre-function:
config:
access:
- 'local path = kong.request.get_path()
kong.service.request.set_path("/bpm" .. path)
'
/newbusiness/v2/application/{eAppId}/document:
post:
tags:
- New Business Transactions V2
summary: Submit documents for New Business
parameters:
- name: eAppId
in: path
required: true
schema:
type: string
requestBody:
description: Required to submit documents before submit new business application
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentRequest'
required: true
responses:
'201':
description: Document Persisted
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentSuccessResponse'
examples:
Document:
value:
caseId: CA000000456
correlationId: 2ad51ecf-9923-437f-a6f0-70968e464cdb
eappId: 2ad51ecf-9923-437f-a6f0-70968e464cdb
documentId: 67334f4882c412621f9ab7cc
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationResponse'
'401':
description: Authentication failed
content:
application/json:
examples:
NewBusiness:
value:
message: Unauthorized
'403':
description: Access denied
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedResponse'
'500':
description: Server error
content:
application/json:
schema:
$ref: '#/components/schemas/ServerErrorResponse'
security:
- Auth0: []
x-kong-plugin-pre-function:
config:
access:
- 'local path = kong.request.get_path()
kong.service.request.set_path("/bpm" .. path)
'
components:
schemas:
IdentifierInstance:
type: object
properties:
identifier:
type: string
example: eAppId
value:
type: string
example: 15ea7582-262f-4dfe-8a60-1e8b8e763fd4
SuccessResponse:
type: object
properties:
statusCode:
type: integer
format: int32
example: 201
timestamp:
type: string
format: date-time
message:
type: string
example: Request Submitted Successfully
CaseSuccessResponse:
type: object
properties:
caseId:
type: string
example: CA000000536
correlationId:
type: string
example: 15ea7582-262f-4dfe-8a60-1e8b8e763fd4
eappId:
type: string
example: 15ea7582-262f-4dfe-8a60-1e8b8e763fd4
ProducerSuccessResponse:
type: object
properties:
statusCode:
type: integer
format: int32
example: 202
timestamp:
type: string
format: date-time
message:
type: string
example: Request Accepted Successfully
npn:
type: string
example: '12345678'
caseId:
type: string
example: CA0000389896
correlationId:
type: string
example: 2ad51ecf-9923-437f-a6f0-70968e464cuu
AgentValidationSuccessResponse:
type: object
properties:
status:
type: string
example: IGO or NIGO
validationResult:
type: array
items:
$ref: '#/components/schemas/ValidationResult'
ValidationResult:
type: object
properties:
errorCode:
type: string
example: EM.035
error:
type: string
example: 1.) Add Transmittal Task. 2.) Pend Case 5 days.
resolution:
type: string
example: Transmittal to licensing - agent needs to complete product training and LOB updated
ValidationResponse:
type: object
properties:
status:
type: string
example: FAILED
timestamp:
type: string
format: date-time
message:
type: string
example: Bad Request
error:
type: array
items:
type: string
example: Mandatory attribute label missing
ProducerValidationResponse:
type: object
properties:
statusCode:
type: integer
format: int32
example: 400
timestamp:
type: string
format: date-time
message:
type: string
example: Bad Request
errors:
type: array
items:
type: string
example: Mandatory field is required
path:
type: string
example: uri=/bpm/onboarding/v1/producer
ResourceNotFoundResponse:
type: object
properties:
timestamp:
type: string
format: date-time
message:
type: string
example: Resource not found
error:
type: array
items:
type: string
example: Resource not found for provided input
AccessDeniedResponse:
type: object
properties:
timestamp:
type: string
format: date-time
message:
type: string
example: 'User is not authorized for the carrier : CarrierName_1'
ServerErrorResponse:
type: object
properties:
timestamp:
type: string
format: date-time
message:
type: string
example: Failed to process request
TppEvidenceRequest:
type: object
properties:
TXLife:
$ref: '#/components/schemas/TXLife'
AppliesToPartyID:
type: string
ReqId:
type: string
required:
- TXLife
TXLife:
type: object
properties:
TXLifeRequest:
$ref: '#/components/schemas/TXLifeRequest'
required:
- TXLifeRequest
TXLifeRequest:
type: object
properties:
TransRefGUID:
type: string
transExeDate:
type: string
transExeTime:
type: string
OLifE:
$ref: '#/components/schemas/OLifE'
required:
- TransRefGUID
- OLifE
OLifE:
type: object
properties:
Holding:
$ref: '#/components/schemas/Holding'
Party:
$ref: '#/components/schemas/EvidenceParty'
Relation:
$ref: '#/components/schemas/Relation'
Holding:
type: object
properties:
attribute_id:
type: string
Policy:
$ref: '#/components/schemas/EvidencePolicy'
required:
- Policy
EvidencePolicy:
type: object
properties:
CarrierCode:
type: string
ApplicationInfo:
$ref: '#/components/schemas/ApplicationInfo'
RequirementInfo:
$ref: '#/components/schemas/RequirementInfo'
ApplicationInfo:
type: object
properties:
TrackingID:
type: string
HOAppFormNumber:
type: string
required:
- HOAppFormNumber
RequirementInfo:
type: object
properties:
attribute_id:
type: string
attribute_AppliesToPartyID:
type: string
ReqCode:
# --- truncated at 32 KB (531 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zinnia/refs/heads/main/openapi/zinnia-new-business-openapi.yml