---
title: "Zinnia New Business API."
url: "https://developers.zinnia.com/apis/new-business/versions/b8532e16-b28e-4393-9305-def50b91e40e"
---

# Zinnia New Business API.

OpenAPI specification document.

```json
{"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()\nkong.service.request.set_path(\"/bpm\" .. path)\n"]}}}},"/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()\nkong.service.request.set_path(\"/bpm\" .. path)\n"]}}},"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()\nkong.service.request.set_path(\"/bpm\" .. path)\n"]}}},"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()\nkong.service.request.set_path(\"/bpm\" .. path)\n"]}}},"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()\nkong.service.request.set_path(\"/bpm\" .. path)\n"]}}}},"/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()\nkong.service.request.set_path(\"/bpm\" .. path)\n"]}}}}},"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":{"type":"string"},"RequirementInfoUniqueID":{"type":"string"},"RequirementDetails":{"type":"string"}},"required":["RequirementDetails"]},"EvidenceParty":{"type":"object","properties":{"PartyTypeCode":{"type":"string"},"GovtID":{"type":"string"},"GovtIDTC":{"type":"string"},"Person":{"$ref":"#/components/schemas/EvidencePerson"},"Address":{"$ref":"#/components/schemas/EvidenceAddress"}}},"EvidencePerson":{"type":"object","properties":{"FirstName":{"type":"string"},"LastName":{"type":"string"},"Gender":{"type":"string","description":"Allowed values: M, F"},"BirthDate":{"type":"string"}}},"EvidenceAddress":{"type":"object","properties":{"Zip":{"type":"string"}}},"Relation":{"type":"object","properties":{"OriginatingObjectType":{"type":"string"},"RelatedObjectType":{"type":"string"},"RelationRoleCode":{"type":"string"},"BirthDate":{"type":"string"}}},"InterimStatusUpdateRequest":{"type":"object","properties":{"eappId":{"type":"string","description":"Unique application Id generated by the UI. Each application would have unique identifier","example":"15ea7582-262f-4dfe-8a60-1e8b8e763fd4"},"caseId":{"type":"string","description":"Zinnia Live case","example":"CA0000005656"},"policyNumber":{"type":"string","description":"Policy Number","example":"AB00000001"},"uwCaseId":{"type":"string","description":"Underwriter caseId","example":"UW0000005656"},"carrier":{"type":"string","description":"Client Code","example":"CL0000001"},"policyStatus":{"type":"string","description":"Status of Policy","example":"Policy Status"},"underwriting":{"allOf":[{"$ref":"#/components/schemas/Underwriting"},{"type":"object","properties":{"instantIdDecision":{"type":"string","description":"InstantId decision"}}}]}},"required":["eappId","caseId"]},"ApplicationData":{"type":"object","properties":{"eappId":{"type":"string","description":"Unique application Id generated by the UI. Each application would have unique identifier","example":"15ea7582-262f-4dfe-8a60-1e8b8e763fd4"},"caseId":{"type":"string","description":"Zinnia Live case","example":"CA0000005656"},"correlationId":{"type":"string","description":"Unique process identifier to track the all linked processed against one single application. This is an optional","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"carrier":{"type":"string","example":"CarrierName_1"},"customerId":{"type":"string","description":"We get the customer Id as part of application request to support older products.","example":"0017b0000102A1UAAU"},"idpUserId":{"type":"string","description":"Need to update idp user id description","example":"abc"},"appStartDate":{"type":"string","format":"date-time","description":"Date (with pattern \"yyyy-MM-dd'T'HH:mm:ss'Z'\"). Application start date"},"actionType":{"type":"string","enum":["Create","Update","Submit"],"description":"To create the application, actionType would be - Create","example":"Create"},"policyStatus":{"type":"string","enum":["Applied For","Approved","Submitted to Underwriting","Pending","Declined","Quoted","Risk Not Acceptable","Proposed","Counter Offer","Not Taken","Issue Pending","Issued","Closed","Active","Lapsed","Cancelled Not Taken","Lapse Pending","Cancelled FreeLook","Cancelled","Offer Accepted","Death Claim Pending","Death Claim Paid","Expired","Matured","Surrendered","Rescission","Death Claim Approved","Suspended Active","Suspended Not Active"],"description":"Status of the policy. It should be - Issued in order to issue the policy","example":"Issued"},"appSubmissionType":{"type":"string","enum":["Internet","Electronic","Handwritten"],"description":"Submission method of the application","example":"Electronic"},"policyHoldingForm":{"type":"string","enum":["Individual"],"description":"Holding Form. It should always be Individual.","example":"Individual"},"policyHoldingStatus":{"type":"string","enum":["Proposed","Active"],"description":"Holding Status","example":"Proposed"},"consentInd":{"type":"string","enum":["Yes","No"],"description":"Consent Indicator Value. Whether the user has provided the consent for this policy or not. This value is used by the underwriting system."},"appState":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","GU","PR"],"description":"State Code","example":"AL"},"consentIndState":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"],"description":"Consented state value"},"consentSubmissionType":{"type":"string","enum":["Internet","Electronic","Handwritten"],"description":"Consented submission method of the application","example":"Electronic"},"appFormNumber":{"type":"string","description":"Form number if applicable. The number assigned on the application form.","example":"ICC20 ABC 104_08-20"},"appVersionNumber":{"type":"string","description":"Form version number if applicable","example":"ICC20 ABC 104_08-20"},"pageLastVisitedId":{"type":"string","description":"User Id who has accessed this page last time."},"appLastUpdated":{"type":"string","format":"date-time","description":"Date (with pattern \"yyyy-MM-dd'T'HH:mm:ss'Z'\"). Application last update date."},"appExpirationDate":{"type":"string","format":"date-time","description":"Date (with pattern \"yyyy-MM-dd'T'HH:mm:ss'Z'\"). Application expiration date"},"marketingOptInd":{"type":"string","enum":["Yes","No"],"description":"Marketing Indicator flag used by the distributor to capture the sale scope."},"agreeToTermsInd":{"type":"string","enum":["Yes","No"],"description":"Agreed to terms and condition or not."},"replacementIndicator":{"type":"string","enum":["Yes","No","Unknown"],"description":"Flag to dertermine whether this is replacement application or not."},"replacementLtcIndicator":{"type":"string","enum":["Yes","No"],"description":"Indicates whether the application involves replacement of existing Long-Term Care (LTC) coverage."},"pageId":{"type":"string","description":"Page Identifier","example":"5f45f7b34a3eea021f2fef1c"},"quote":{"$ref":"#/components/schemas/Quote"},"payload":{"type":"object","properties":{"insured":{"$ref":"#/components/schemas/PartyAdditional"},"childInsured":{"type":"array","items":{"$ref":"#/components/schemas/PartyChild"}},"coverageDetails":{"$ref":"#/components/schemas/CoverageDetails"},"additional":{"$ref":"#/components/schemas/ApplicationAdditionalInformation"},"documents":{"type":"array","items":{"$ref":"#/components/schemas/Documents"}}},"required":["insured","coverageDetails","documents"]}},"required":["eappId","caseId","correlationId","customerId","carrier","actionType","policyStatus","appSubmissionType","policyHoldingForm","consentInd","appStartDate","appState","consentIndState","consentSubmissionType"]},"Quote":{"type":"object","properties":{"quoteId":{"type":"string","description":"Unique Id generated by the LPS system","example":"Q332022203127424"},"carrier":{"type":"string","example":"CarrierName_1"},"leadId":{"type":"string","description":"Unique Id generated by the LPS system","example":"Q332022203127424"},"riskClass":{"type":"string","enum":["Elite Non-Tobacco","Preferred Non-Tobacco","Standard Non-Tobacco","Standard Tobacco","Standard Aggregate","Substandard Non-Tobacco","Substandard Tobacco"],"description":"Risk Class Configured at LPS Engine","example":"Elite Non-Tobacco"},"lob":{"type":"string","enum":["Life"],"description":"Line of business","example":"Life"},"productType":{"type":"string","enum":["Indexed Universal Life","Universal Life","Term"],"description":"type of product","example":"Indexed Universal Life"},"email":{"type":"string","description":"Email id of the insured","example":"test.qa182@test.com"},"productCode":{"type":"string","enum":["ABC001"],"description":"Product code","example":"ABC001"},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"],"description":"State Code","example":"AL"},"faceAmount":{"type":"number","description":"Face Amount","example":250000},"premiumAmount":{"type":"number","format":"double","description":"Premium amount","example":216.16},"paymentTerm":{"type":"string","description":"Duration of payment","example":"20"},"premiumFrequency":{"type":"string","enum":["m","q","a","sa","sp"],"description":"Frequency of premium payment","example":"m"},"dob":{"type":"string","format":"date","description":"Date of birth of insured"},"ageAsOfDate":{"type":"string","format":"date","description":"Date as of when age needs to be calculated. This can be defaulted to current date in format YYYY-MM-DD or can be signature date to calculate issue age as of sign date."},"gender":{"type":"string","enum":["Male","Female"],"description":"Gender of insured","example":"Male"},"smoker":{"type":"string","enum":["Yes","No"],"description":"Smoking preferences","example":"No"},"health":{"type":"string","description":"Health condition","example":"Good"},"underwritingMethod":{"type":"string","enum":["FULL_UNDERWRITING","ATTESTATION_VALIDATION","ADDITIONAL_UNDERWRITING","SIMPLIFIED_UNDERWRITING","REDUCED_UNDERWRITING"],"description":"Underwriting types","example":"FULL_UNDERWRITING"},"issueAge":{"type":"string","description":"Age at issue","example":"26"},"quoteDate":{"type":"string","format":"date-time","description":"date (with pattern \"yyyy-MM-dd'T'HH:mm:ss'Z'\"). Quote date"},"cashValue":{"type":"number","description":"Cash value as on date","example":3952.941779},"success":{"type":"boolean","description":"Quote status","example":false},"annualIncome":{"type":"number","description":"Annual of insured/owner","example":0},"annualPolicyMgmtFee":{"type":"number","description":"Annual policy management fee","example":0},"additionalPaymentAmount":{"type":"number","description":"Additional payment amount","example":0},"pricingVersion":{"type":"string","description":"Internal to LPS","example":"2021.10.15"},"matchVersion":{"type":"string","description":"Internal to LPS","example":"2021.10.15"},"matchPercent":{"type":"number","description":"Match percent","example":1},"averageMonthlyCOI":{"type":"number","description":"Average monthly cost of issuance","example":76},"firstMonthCOI":{"type":"number","description":"first month cost of issuance","example":17.46},"adminFee":{"type":"number","description":"Admin fee","example":8},"firstMonthSavings":{"type":"number","description":"First month saving","example":190.54},"monthlySavings":{"$ref":"#/components/schemas/MonthlySavings"},"quoteQuestions":{"items":{"$ref":"#/components/schemas/QuoteQuestions"}},"approvedQuote":{"$ref":"#/components/schemas/ApprovedQuote"}},"required":["quoteId","riskClass"]},"QuoteQuestions":{"type":"object","properties":{"id":{"type":"string","description":"Index number of the question","example":"1"},"code":{"type":"string","enum":["RelationshipStatus","ChildrenStatus","FinanceSavvy","MoneyRelation","FundsUsage","FamilyUsage"],"description":"RelationshipStatus","example":"FinanceSavvy"},"description":{"type":"array","items":{"type":"string","enum":["Single","Future","Engaged","Recently Married","Married","None","Plan To","Trying","Pregnant","Yes-Plus","Yes-Complete","Novice","Student","Hobbyist","Expert","Adventurer","Individualist","Moderate","Planner","Saver","Retirement Hedge","Early Retirement","Retirement Supplement","Fund a Large Expense","College Savings","Disability Income","Small Business Venture","Build Wealth","Other","Nest Egg","Protect Co-signers","Pay Off Debts","Fund College","Cover Expenses","Maintain Quality Of Life","Support Additional Family","Funeral Expenses","Support Family","Undecided","Help With Illness"]},"description":"Response details"}}},"MonthlySavings":{"type":"object","properties":{"minSavings":{"type":"number","description":"Minimunm Savings","example":132},"maxSavings":{"type":"number","description":"Maximum Savings","example":222},"targetSavings":{"type":"number","description":"Target Savings","example":132}}},"ApprovedQuote":{"type":"object","properties":{"quoteId":{"type":"string","description":"Unique Id generated by the LPS system","example":"Q332022203127424"},"acctValIntRate":{"type":"number","description":"Account value interst rate","example":3.5},"riskClass":{"type":"string","enum":["Elite Non-Tobacco","Preferred Non-Tobacco","Standard Non-Tobacco","Standard Tobacco","Standard Aggregate","Substandard Non-Tobacco","Substandard Tobacco"],"description":"Risk Class Configured at LPS Engine","example":"Elite Non-Tobacco"},"faceAmount":{"type":"number","description":"Face Amount","example":250000},"premiumAmount":{"type":"number","format":"double","description":"Premium amount","example":216.16},"paymentTerm":{"type":"string","description":"Duration of payment","example":"20"},"issueAge":{"type":"string","description":"Age at issue","example":"26"},"quoteDate":{"type":"string","format":"date-time","description":"date (with pattern \"yyyy-MM-dd'T'HH:mm:ss'Z'\"). Quote date"},"cashValue":{"type":"number","description":"Cash value as on date","example":3952.941779},"pricingVersion":{"type":"string","description":"Internal to LPS","example":"2021.10.15"},"matchVersion":{"type":"string","description":"Internal to LPS","example":"2021.10.15"},"matchPercent":{"type":"number","description":"Match percent","example":1},"averageMonthlyCOI":{"type":"number","description":"Average monthly cost of issuance","example":76},"firstMonthCOI":{"type":"number","description":"first month cost of issuance","example":17.46},"adminFee":{"type":"number","description":"Admin fee","example":8},"firstMonthSavings":{"type":"number","description":"First month saving","example":190.54},"monthlySavings":{"$ref":"#/components/schemas/MonthlySavings"}}},"CoverageDetails":{"type":"object","properties":{"lob":{"type":"string","enum":["Life"],"description":"Line of business","example":"Life"},"productType":{"type":"string","enum":["Indexed Universal Life","Universal Life","Term"],"description":"type of product","example":"Indexed Universal Life"},"productCode":{"type":"string","description":"Product code","example":"ABC001"},"riderInd":{"type":"string","description":"Rider Indicator","example":"Yes"},"faceAmount":{"type":"number","description":"Face Amount","example":250000},"deathBenefitOpt":{"type":"string","enum":["Level","Increasing"]},"deathBenefitComplianceTest":{"type":"string","enum":["Cash Value Accumulation Test","Guideline Premium Test"]},"paymentFrequency":{"type":"string","enum":["m","q","a","sa","sp"],"description":"Frequency of premium payment","example":"m"},"plannedPremiumAmount":{"type":"number","format":"double","description":"Planned Premium Amount","example":250000.12},"fixedCostPeriod":{"type":"string","enum":["10","15","20","25","30","65"],"description":"Period information","example":"20"},"childCoverageInd":{"type":"string","enum":["Yes","No"],"description":"Flag to indicate the child coverage"},"childCoverageAmount":{"type":"number","description":"Per child coverage amount. This is an optional field","example":250000},"owners":{"type":"array","items":{"$ref":"#/components/schemas/PartyOwners"}},"agents":{"type":"array","items":{"$ref":"#/components/schemas/Agent"}},"existingPolicyCoverageAmount":{"type":"number","description":"existingPolicyCoverageAmount","example":250000},"replacementCoverageAmount":{"type":"number","description":"replacementCoverageAmount","example":250000}}},"Agent":{"type":"object","properties":{"firstName":{"type":"string","description":"First Name of the party","example":"Thomas"},"lastName":{"type":"string","description":"Last Name of the the party","example":"Lawrence"},"middleName":{"type":"string","description":"Middle name of the party"},"name":{"type":"string","description":"Full name of the party.","example":"Thomas Lawrence"},"externalId":{"type":"string","description":"Agent External id","example":"PG000001"},"agentDistributorChannel":{"type":"string","description":"Agent Distribution Channel","example":"CAS"},"licenseNumber":{"type":"string","description":"Agent license Number","example":"19584368"},"brokerName":{"type":"string","description":"Name of broker firm","example":"ABC Company"},"brokerExternalid":{"type":"string","description":"Broker External Id","example":"12324234"},"taxIdType":{"type":"string","enum":["P","C"],"description":"Type of Tax Id. P means Individual and C means Corporate","example":"P"},"taxId":{"type":"string","description":"Agent tax Id","example":"123456789"},"npn":{"type":"string","description":"NPN of the agent","example":"1223435346"},"parentNpn":{"type":"string","description":"Parent entity NPN number","example":"1242353455"},"dateOfTrust":{"type":"string","format":"date","description":"Date of trust"},"parentTaxId":{"type":"string","description":"Parent taxId","example":"1242353455"},"type":{"type":"string","enum":["Agent","Primary Writing Agent","Additional Writing Agent","Primary Servicing Agent","Additional Servicing Agent","General Agent"]},"solicitingServiceIndicator":{"type":"boolean","description":"if the agent is servicing agent send the flag as True else false","example":true},"agentPercent":{"type":"number","description":"Agent percent","example":100},"classification":{"type":"string","enum":["Individual","Business","Trust","Corporation","Partnership","Other","Group of Individuals","Estate"],"description":"Party classification","example":"Individual"}},"required":["classification","firstName","lastName","externalId","brokerName","licenseNumber","taxId","agentDistributorChannel","solicitingServiceIndicator","agentPercent"]},"Riders":{"type":"object","properties":{"type":{"type":"string","enum":["Rider_ABRTRM","Rider_CTR","Rider_ABRCHR","Rider_ADR","Rider_WPR","Rider_CGR","Rider_GIBR","Rider_OPR","Rider_OWDR","Rider_WDR","Rider_NHR","Rider_ABRCRI"],"description":"Riders Code"},"approvedRiderFaceAmountMaximum":{"type":"number","description":"Rider current amount","example":100000}}},"RidersPatch":{"type":"object","properties":{"code":{"type":"string","enum":["Rider_ABRTRM","Rider_CTR","Rider_ABRCHR","Rider_ADR","Rider_WPR","Rider_CGR","Rider_GIBR","Rider_OPR","Rider_OWDR","Rider_WDR","Rider_NHR","Rider_ABRCRI"],"description":"Riders Code"},"amount":{"type":"number","nullable":true,"description":"Rider current amount","example":100000}}},"PolicyDecisionRequest":{"type":"object","properties":{"eappId":{"type":"string","description":"Unique application Id geenrated by the UI. Each application would have unique identifier","example":"15ea7582-262f-4dfe-8a60-1e8b8e763fd4"},"caseId":{"type":"string","description":"Zinnia Live case","example":"CA0000005656"},"correlationId":{"type":"string","description":"Unique process identifier to track the all linked processed against one single application. This is an optional","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"carrier":{"type":"string","example":"CarrierName1"},"customerId":{"type":"string","description":"We get the customer Id as part of application request to support older products.","example":"0017b0000102A1UAAU"},"idpUserId":{"type":"string","example":"abc"},"appStartDate":{"type":"string","format":"date-time","description":"Date (with pattern \"yyyy-MM-dd'T'HH:mm:ss'Z'\"). Application start date"},"actionType":{"type":"string","enum":["Create","Update","Submit"],"description":"To update the application, actionType would be - Update","example":"Update"},"policyStatus":{"type":"string","enum":["Applied For","Approved","Submitted to Underwriting","Pending","Declined","Quoted","Risk Not Acceptable","Proposed","Counter Offer","Not Taken","Issue Pending","Issued","Closed","Active","Lapsed","Cancelled Not Taken","Lapse Pending","Cancelled FreeLook","Cancelled","Offer Accepted","Death Claim Pending","Death Claim Paid","Expired","Matured","Surrendered","Rescission","Death Claim Approved","Suspended Active","Suspended Not Active"],"description":"Status of the policy. It should be - Issued in order to issue the policy","example":"Issued"},"appSubmissionType":{"type":"string","enum":["Internet","Electronic","Handwritten"],"description":"Submission method of the application","example":"Electronic"},"policyHoldingForm":{"type":"string","enum":["Individual"],"description":"Holding Form. It should always be Individual.","example":"Individual"},"policyHoldingStatus":{"type":"string","enum":["Proposed","Active"],"description":"Holding Status","example":"Proposed"},"consentInd":{"type":"string","enum":["Yes","No"],"description":"Consent Indicator Value. Whether the user has provided the consent for this policy or not. This value is used by the underwriting system."},"appState":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","GU","PR"],"description":"State Code","example":"AL"},"consentIndState":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"],"description":"Consented state value"},"consentSubmissionType":{"type":"string","enum":["Internet","Electronic","Handwritten"],"description":"Consented submission method of the application","example":"Electronic"},"appFormNumber":{"type":"string","description":"Form number if applicable. The number assigned on the application form.","example":"ICC20 ABC 104_08-20"},"appVersionNumber":{"type":"string","description":"Form version number if applicable","example":"ICC20 ABC 104_08-20"},"pageLastVisitedId":{"type":"string","description":"User Id who has accessed this page last time."},"appLastUpdated":{"type":"string","format":"date-time","description":"Date (with pattern \"yyyy-MM-dd'T'HH:mm:ss'Z'\"). Application last update date."},"appExpirationDate":{"type":"string","format":"date-time","description":"Date (with pattern \"yyyy-MM-dd'T'HH:mm:ss'Z'\"). Application expiration date"},"marketingOptInd":{"type":"string","enum":["Yes","No"],"description":"Marketing Indicator flag used by the distributor to capture the sale scope."},"agreeToTermsInd":{"type":"string","enum":["Yes","No"],"description":"Agreed to terms and condition or not."},"replacementIndicator":{"type":"string","enum":["Yes","No","Unknown"],"description":"Flag to dertermine whether this is replacement application or not."},"replacementLtcIndicator":{"type":"string","enum":["Yes","No"],"description":"Indicates whether the application involves replacement of existing Long-Term Care (LTC) coverage."},"pageId":{"type":"string","description":"Page Identifier","example":"5f45f7b34a3eea021f2fef1c"},"overrideDecisionFlag":{"type":"boolean","description":"Flag to dertermine override decisions. In case of true Override results is required."},"overrideResults":{"$ref":"#/components/schemas/OverrideResults"},"quote":{"$ref":"#/components/schemas/Quote"},"payload":{"type":"object","properties":{"underwriting":{"$ref":"#/components/schemas/Underwriting"},"insured":{"$ref":"#/components/schemas/PartyAdditional"},"childInsured":{"type":"array","items":{"$ref":"#/components/schemas/PartyChild"}},"coverageDetails":{"$ref":"#/components/schemas/CoverageDetailsComplete"},"additional":{"$ref":"#/components/schemas/AdditionalInformation"},"documents":{"type":"array","items":{"$ref":"#/components/schemas/Documents"}}}}},"required":["eappId","caseId"]},"UnderwritingRequest":{"type":"object","properties":{"eappId":{"type":"string","description":"Unique application Id geenrated by the UI. Each application would have unique identifier","example":"15ea7582-262f-4dfe-8a60-1e8b8e763fd4"},"caseId":{"type":"string","description":"Zinnia Live case","example":"CA0000005656"},"correlationId":{"type":"string","description":"Unique process identifier to track the all linked processed against one single application. This is an optional","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"carrier":{"type":"string","example":"CarrierName1"},"customerId":{"type":"string","description":"We get the customer Id as part of application request to support older products.","example":"0017b0000102A1UAAU"},"idpUserId":{"type":"string","example":"abc"},"appStartDate":{"type":"string","format":"date-time","description":"Date (with pattern \"yyyy-MM-dd'T'HH:mm:ss'Z'\"). Application start date"},"actionType":{"type":"string","enum":["Create","Update","Submit"],"description":"To update the application, actionType would be - Update","example":"Update"},"policyStatus":{"type":"string","enum":["Applied For","Approved","Submitted to Underwriting","Pending","Declined","Quoted","Risk Not Acceptable","Proposed","Counter Offer","Not Taken","Issue Pending","Issued","Closed","Active","Lapsed","Cancelled Not Taken","Lapse Pending","Cancelled FreeLook","Cancelled","Offer Accepted","Death Claim Pending","Death Claim Paid","Expired","Matured","Surrendered","Rescission","Death Claim Approved","Suspended Active","Suspended Not Active"],"description":"Status of the policy. It should be - Issued in order to issue the policy","example":"Issued"},"appSubmissionType":{"type":"string","enum":["Internet","Electronic","Handwritten"],"description":"Submission method of the application","example":"Electronic"},"policyHoldingForm":{"type":"string","enum":["Individual"],"description":"Holding Form. It should always be Individual.","example":"Individual"},"policyHoldingStatus":{"type":"string","enum":["Proposed","Active"],"description":"Holding Status","example":"Proposed"},"consentInd":{"type":"string","enum":["Yes","No"],"description":"Consent Indicator Value. Whether the user has provided the consent for this policy or not. This value is used by the underwriting system."},"appState":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","GU","PR"],"description":"State Code","example":"AL"},"consentIndState":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"],"description":"Consented state value"},"consentSubmissionType":{"type":"string","enum":["Internet","Electronic","Handwritten"],"description":"Consented submission method of the application","example":"Electronic"},"appFormNumber":{"type":"string","description":"Form number if applicable. The number assigned on the application form.","example":"ICC20 ABC 104_08-20"},"appVersionNumber":{"type":"string","description":"Form version number if applicable","example":"ICC20 ABC 104_08-20"},"pageLastVisitedId":{"type":"string","description":"User Id who has accessed this page last time."},"appLastUpdated":{"type":"string","format":"date-time","description":"Date (with pattern \"yyyy-MM-dd'T'HH:mm:ss'Z'\"). Application last update date."},"appExpirationDate":{"type":"string","format":"date-time","description":"Date (with pattern \"yyyy-MM-dd'T'HH:mm:ss'Z'\"). Application expiration date"},"marketingOptInd":{"type":"string","enum":["Yes","No"],"description":"Marketing Indicator flag used by the distributor to capture the sale scope."},"agreeToTermsInd":{"type":"string","enum":["Yes","No"],"description":"Agreed to terms and condition or not."},"replacementIndicator":{"type":"string","enum":["Yes","No","Unknown"],"description":"Flag to dertermine whether this is replacement application or not."},"replacementLtcIndicator":{"type":"string","enum":["Yes","No"],"description":"Indicates whether the application involves replacement of existing Long-Term Care (LTC) coverage."},"pageId":{"type":"string","description":"Page Identifier","example":"5f45f7b34a3eea021f2fef1c"},"overrideDecisionFlag":{"type":"boolean","description":"Flag to dertermine override decisions. In case of true Override results is required."},"overrideResults":{"$ref":"#/components/schemas/OverrideResults"},"quote":{"$ref":"#/components/schemas/Quote"},"payload":{"type":"object","properties":{"underwriting":{"$ref":"#/components/schemas/Underwriting"},"insured":{"$ref":"#/components/schemas/PartyAdditional"},"childInsured":{"type":"array","items":{"$ref":"#/components/schemas/PartyChild"}},"coverageDetails":{"$ref":"#/components/schemas/CoverageDetailsComplete"},"additional":{"$ref":"#/components/schemas/AdditionalInformation"},"documents":{"type":"array","items":{"$ref":"#/components/schemas/Documents"}}}}},"required":["eappId","caseId","correlationId","customerId","carrier","actionType","policyStatus","appSubmissionType","policyHoldingForm","consentInd","appStartDate","appState","consentIndState","consentSubmissionType"]},"PartyAdditional":{"type":"object","properties":{"firstName":{"type":"string","description":"First Name of the party","example":"Thomas"},"lastName":{"type":"string","description":"Last Name of the the party","example":"Lawrence"},"middleName":{"type":"string","description":"Middle name of the party"},"name":{"type":"string","description":"Full name of the party.","example":"Thomas Lawrence"},"suffix":{"type":"string","description":"Suffix for given party if Applicable","example":"Sr"},"prefix":{"type":"string","description":"Prefix for given party if Applicable","example":"Dr"},"gender":{"type":"string","enum":["Male","Female"],"description":"Gender of party","example":"Male"},"dob":{"type":"string","format":"date","description":"Date of birth of party"},"age":{"type":"number","description":"Age of the party","example":26},"ssn":{"type":"string","description":"Party SSN. In case if non individual it should be Tax Id","minLength":9,"maxLength":9,"example":"121328426"},"driverNumber":{"type":"string","description":"Driver license number","example":"T61217265934"},"driverState":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"],"description":"State Code","example":"AL"},"noDriversLicenseInd":{"type":"string","enum":["Yes","No","Unknown"],"description":"Flag for Driver License","example":"No"},"address1":{"type":"string","description":"Addres line 1","example":"Wt Road"},"address2":{"type":"string","description":"Addres line 2","example":"St Street"},"city":{"type":"string","description":"City name","example":"Test City"},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"],"description":"State Code","example":"AL"},"zip":{"type":"string","description":"Zip Code. Max char allowed is 9.","maxLength":9,"example":"12345"},"birthCountry":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AN","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","CV","KH","CM","CA","KY","CF","TD","CL","CN","CX","CC","CO","KM","CD","CG","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","SZ","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","US","UY","UZ","VU","VE","VN","VG","VI","WF","EH","XK","YE","ZM","ZW","Other"],"description":"Birth Country","example":"US"},"identification":{"type":"array","items":{"type":"object","properties":{"governmentIdType":{"type":"string","enum":["Passport","StateId","SSN"],"example":"Passport"},"governmentId":{"type":"string","example":"213121414"},"jurisdiction":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","GU","PR"],"description":"State Code if applicable. Provided in case of state issued Id","example":"AL"}}}},"phone":{"type":"string","description":"Phone number","example":"111-111-2222"},"email":{"type":"string","description":"Email Id of the party","example":"test@abc.com"},"emailType":{"type":"string","enum":["Personal","Business"],"description":"Type of email","example":"Business"},"communicationPreference":{"type":"string","enum":["Mail","Email","Phone"],"description":"Communication preferences","example":"Email"},"classification":{"type":"string","enum":["Individual","Business","Trust","Corporation","Partnership","Other","Group of Individuals","Estate","Child"],"description":"Party classification","example":"Individual"},"employed":{"type":"string","enum":["Yes","No"]},"employmentStatus":{"type":"string","enum":["Student","Unemployed","Primary Caregiver","Salaried","Other"],"description":"Employment Status of the party","example":"Salaried"},"occupation":{"type":"string","description":"Occupation details","example":"Self Employed"},"householdIncome":{"type":"string","description":"Income details.","example":"200000"},"netAnnualIncome":{"type":"string","description":"Income details it can be range or any number.It will be US standard currency","example":"10000"},"childExpectedInd":{"type":"string","enum":["Yes","No","Unknown"],"description":"Flag for Unborn Child","example":"No"},"existingLifeInsuranceInd":{"type":"string","enum":["Yes","No","Unknown"],"description":"Does party have any existing insurance policy"},"lifeInsuranceHistoryInd":{"type":"string","enum":["Yes","No","Unknown"]}}},"PartyChild":{"type":"object","properties":{"firstName":{"type":"string","description":"First Name of the party","example":"Thomas"},"lastName":{"type":"string","description":"Last Name of the the party","example":"Lawrence"},"middleName":{"type":"string","description":"Middle name of the party"},"name":{"type":"string","description":"Full name of the party.","example":"Thomas Lawrence"},"gender":{"type":"string","enum":["Male","Female"],"description":"Gender of party","example":"Male"},"dob":{"type":"string","format":"date","description":"Date of birth of party"},"age":{"type":"number","description":"Age of the party","example":26},"address1":{"type":"string","description":"Address line 1","example":"Wt Road"},"address2":{"type":"string","description":"Address line 2","example":"St Street"},"city":{"type":"string","description":"City name","example":"Test City"},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"],"description":"State Code","example":"AL"},"zip":{"type":"string","description":"Zip Code. Max char allowed is 9.","maxLength":9,"example":"123456"},"birthCountry":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AN","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","CV","KH","CM","CA","KY","CF","TD","CL","CN","CX","CC","CO","KM","CD","CG","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","SZ","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","US","UY","UZ","VU","VE","VN","VG","VI","WF","EH","XK","YE","ZM","ZW","Other"],"description":"Birth Country","example":"US"},"identification":{"type":"array","items":{"type":"object","properties":{"governmentIdType":{"type":"string","enum":["Passport","StateId","SSN"],"example":"Passport"},"governmentId":{"type":"string","example":"213121414"},"jurisdiction":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","GU","PR"],"description":"State Code if applicable. Provided in case of state issued Id","example":"AL"}}}},"phone":{"type":"string","description":"Phone number","example":"111-111-2222"},"email":{"type":"string","description":"Email Id of the party","example":"test@abc.com"},"emailType":{"type":"string","enum":["Personal","Business"],"description":"Type of email","example":"Business"},"communicationPreference":{"type":"string","enum":["Mail","Email","Phone"],"description":"Communication preferences","example":"Email"},"relationship":{"type":"string","enum":["Child"],"description":"Party relationship","example":"Child"},"classification":{"type":"string","enum":["Individual"],"description":"Party classification","example":"Individual"},"childMedicalHistory":{"type":"array","items":{"type":"object","properties":{"conditionType":{"type":"string","enum":["Asthma","Cancer","Cystic fibrosis","Depression","Diabetes","Down syndrome","Epilepsy","Heart Disorder","Leukemia","Muscular dystrophy","Other","Brain Disorder","Kidney Disorder"],"description":"Medical condition questions"},"isApplicable":{"type":"string","enum":["Yes","No"],"description":"Indicator flag for medical history questions"}}}}}},"AdditionalInformation":{"type":"object","properties":{"tobaccoUsed":{"type":"string","enum":["Yes","No","Unknown"],"description":"Indicator flag for tobacco preferences"},"USResidentPast2YrsInd":{"type":"string","enum":["Yes","No","Unknown"],"description":"Indicator flag for resident options"},"livingHistory":{"type":"array","items":{"$ref":"#/components/schemas/LivingHistory"}},"foreignTravelPlanNext2yrs":{"type":"string","enum":["Yes","No","Unknown"],"description":"Indicator flag for foreign travel plans"},"foreignTravel":{"type":"array","items":{"$ref":"#/components/schemas/ForeignTravel"}},"restrictedTravelPlanNext2yrs":{"type":"string","enum":["Yes","No"],"description":"Indicator flag for foreign travel plans for 2 years"},"useExistingPolicyFunds":{"type":"string","enum":["Yes","No","Unknown"],"description":"Indicator flag for existing policy funds applicability"},"heightFeet":{"type":"string","description":"height of party in feet","example":"5"},"heightInches":{"type":"string","description":"height of party in inches","example":"5"},"weight":{"type":"string","description":"Weight of party in pounds","example":"150"},"primaryPhysicianInd":{"type":"string","enum":["Yes","No","Unknown"],"description":"Indicator flag for primary physician"},"disabilityBenefitsInd":{"type":"string","enum":["Yes","No","Unknown"],"description":"Indicator flag for disability benefit"},"disabilityPaymentOptions":{"type":"string","enum":["Yes","No","Unknown"],"description":"Indicator flag for disability benefit"},"existingPolicyHistory":{"type":"array","items":{"$ref":"#/components/schemas/ExistingPolicyHistory"}},"riskInfo":{"$ref":"#/components/schemas/RiskInformation"}}},"RiskInformation":{"type":"object","properties":{"lostWeightRecently":{"type":"string","enum":["Yes","No","Unknown"],"description":"Indicator flag for weight loss"},"lostWeightReason":{"type":"array","items":{"type":"string","enum":["Diet","Illness","Exercise","Other","Surgery","Unknown","Pregnancy"]},"description":"lostWeightReason"},"lostWeightOtherDesc":{"type":"string","description":"Description value if lostWeightReason is selected as Other"},"dailyActivityAssistantInd":{"type":"string","enum":["Yes","No"],"description":"Indicator flag for daily activity assistant required"},"durationTobaccoUsed":{"type":"string","description":"Duration stating use of tobacco","example":"5"},"marijuanaUsedInd":{"type":"string","enum":["Yes","No","Unknown"],"description":"Indicator flag for marijuana used"},"durationMarijuanaUsed":{"type":"string","description":"Duration stating use of Marijuana","example":"5"},"assistanceRequired":{"type":"string","enum":["Yes","No","Unknown"],"description":"Indicator flag for help needed or not"},"diagnosticTestInd":{"type":"string","enum":["Yes","No","Unknown"],"description":"Indicator flag for diagnostic tests"},"hospitalizedRecentlyInd":{"type":"string","enum":["Yes","No","Unknown"],"description":"Indicator flag for hospitalization history"},"outstandingTreatments":{"type":"string","enum":["Yes","No","Unknown"],"description":"Indicator flag for outstanding treatment except AIDS and HIV"},"treatmentList":{"type":"array","items":{"type":"string"},"enum":["Allergy Testing","Routine Blood work","Routine Urine testing","Routine Pap smear","Routine colonoscopy","Routine mammogram","Routine EKG","Imaging for bone or joint","Routine bone density","Pregnancy or fertility related","Vision or Hearing","Other"]},"convictedInd":{"type":"string","enum":["Yes","No","Unknown"],"description":"Indicator flag"},"felonyInd":{"type":"string","enum":["Yes","No","Unknown"],"description":"Indicator flag for felony"},"covid19Ind":{"type":"string","enum":["Yes","No","Unknown"],"description":"Indicator flag for covid 19 hospitalization"},"deceasedParentInd":{"type":"string","enum":["Yes","No","Unknown"],"description":"Indicator flag for parents"},"deceaseFamily":{"type":"array","items":{"$ref":"#/components/schemas/DeceaseFamily"}},"rejectionInd":{"type":"string","enum":["Yes","No"],"description":"Indicator flag for rejection of insurence application"},"medicalHistory":{"type":"array","items":{"$ref":"#/components/schemas/MedicalHistory"}},"lifeStyleActivities":{"$ref":"#/components/schemas/LifeStyleActivities"},"violations":{"$ref":"#/components/schemas/Violations"}}},"MedicalHistory":{"type":"object","properties":{"conditionType":{"type":"string","enum":["None","Substance Abuse","Drug Abuse","Alcoholism","Self Help","Arthritis","Ankylosing Spondylitis","Myositis","Rheumatoid Arthritis","Scleroderma","SLE","Granulomatosis","Benign Tumor","Brain Tumor","Colon Polyps","Insitu Melanoma","Insitu Breast","Ovarian Cyst","Blood Disorder","Aplastic Anemia","Clotting Disorder","Essential Thrombocytosis","Hemochromatosis","Low Platelets","Polycythemia Vera","Cancer","Breast Cancer","Colon Cancer","Leukemia","Lymphomas","Lung Cancer","Melanoma","Ovarian Cancer","Pancreatic Cancer","Prostate Cancer","Skin Cancer","Testicular Cancer","Alzheimer Disease","ALS","Cerebral Palsy","Epilepsy","Multiple Sclerosis","Paraplegia","Stroke","Endocrine Disorder","Addisons Disease","Cushings Disease","Hyperparathyroidism","Hyperthyroidism","Pituitary Disorder","Thyroid Nodule","Hypothyroidism","Liver Disorder","Autoimmune Hepatitis","Barrett Esophagus","Chronic Pancreatitis","Liver Cirrhosis","Crohns Disease","Hepatitis B","Hepatitis C","Liver Enzymes","Ulcerative Colitis","Heart Disorder","Abnormal Heart","Aneurysm","Brain Aneurysm","Thrombosis","Coronary Disease","Heart Attack","Heart Failure","Cardiomyopathy","Heart Valve","HBP","Pacemaker","Kidney Disorder","Kidney Infection","Glomerulonephritis","Kidney failure","PKD","Blood Urine","Self Catheterization","Respiratory Disorder","Asthma","COPD","Sleep Apnea","Mens Health","PSA","Enlarged Prostate","Metabolic Disorder","High Cholesterol","Diabetes Type1","Diabetes Type2","Prediabetes","Psychiatric Illness","ADHD","Anxiety","Bipolar Disorder","Depression","Eating Disorder","PTSD","Schizophrenia","UnspecifiedHIV","AIDS","ARC","HIV","Womens Health","Abnormal Mammogram","Abnormal Pap","Brain Disorder","Cystic Fibrosis","Pulmonary Fibrosis","Chronic Kidney Disease","OCD","Psychosis","DrugAlcohol","Pulmonary Hypertension","Deep Vein Thrombosis","Heart Disorder None Apply","Metabolic Disorder None Apply","Endocrine Disorder None Apply","Respiratory Disorder None Apply","Kidney Disorder None Apply","Psychiatric Illness None Apply","Womens Health None Apply","Liver Disorder None Apply","Brain Disorder None Apply","Arthritis None Apply","Blood Disorder None Apply"],"description":"Medical condition questions"},"isApplicable":{"type":"string","enum":["Yes","No"],"description":"Indicator flag for medical history questions"},"treatmentInd":{"type":"string","enum":["Yes","No","Unknown"],"description":"Indicator flag for treatment indicator"},"recoveredStatus":{"type":"string","enum":["Yes","No","Unknown"],"description":"Indicator flag for recovered status"},"stage":{"type":"string","description":"Condition Stage","example":"Stage 1"},"organCancerSpreadInd":{"type":"string","enum":["Yes","No","Unknown"],"description":"Indicator flag for organ cancer spread"},"basalSquamousSkinCancerInd":{"type":"string","enum":["Yes","No"],"description":"Indicator flag for basal or squamous cell skin cancer"},"resultsKnownInd":{"type":"string","enum":["Yes","No","Unknown"],"description":"Indicator flag for test result value"},"bipolarSuicideInd":{"type":"string","enum":["Yes","No"],"description":"Indicator flag for bipolar Suicide"},"motorAccidentInd":{"type":"string","enum":["Yes","No"],"description":"Indicator flag for motar accident"},"resultsReading":{"type":"string","description":"Results reading","example":"70"},"resultsReadingDate":{"type":"string","format":"date","description":"Last result reading date"},"diagnosisDate":{"type":"string","format":"date","description":"Treatment Date"},"systolicBPReading":{"type":"string","description":"BP reading upper","example":"140"},"diastolicBPReading":{"type":"string","description":"BP reading lower","example":"70"},"yearOfFirstSeizure":{"type":"string","description":"Year of first seizure in case of epilepsy","example":"2001"},"dateOfLastSeizure":{"type":"string","format":"date","description":"Last Seizure date if applicable"},"numberOfSeizure":{"type":"string","description":"number of seizure in past year. Maximum value applicable is 10.","example":"6"},"raLmtdFingToesInd":{"type":"string","enum":["Yes","No","Unknown"],"description":"Indicator flag for Rheumatoid arthritis limitation"},"workSchlHmActRAInd":{"type":"string","enum":["Yes","No","Unknown"],"description":"Indicator flag for Rheumatoid arthritis life impact"},"treatmentDetail":{"type":"array","items":{"$ref":"#/components/schemas/TreatmentDetail"}},"substanceUsage":{"type":"array","items":{"$ref":"#/components/schemas/SubstanceUsage"}}}},"TreatmentDetail":{"type":"object","properties":{"treatmentType":{"type":"string","enum":["Medication","Hospitalization","CPAP","Surgery","Chemotherapy","Radiation","Other","Test","Medication Added","Medication Increased","Quit Medication","None"],"description":"Treatment Type"},"isApplicable":{"type":"string","enum":["Yes","No","Unknown"],"description":"Indicator flag for recovered status"},"description":{"type":"string","description":"treatment description","example":"other type of treatment"},"treatmentCompletionInd":{"type":"string","enum":["Yes","No","Unknown"],"description":"Indicator flag for treatment completion"},"otherTestRecommendInd":{"type":"string","enum":["Yes","No","Unknown"],"description":"Indicator flag for other test recommendation"},"complicationsInd":{"type":"string","enum":["Yes","No","Unknown"],"description":"Indicator flag for treatment complication"},"dateLastSeen":{"type":"string","format":"date","description":"Last seen date for treatment observation"},"medication":{"type":"string","description":"treatment description","example":"prescribed pain meds"},"treatmentStartDate":{"type":"string","format":"date","description":"treatmentStartDate in 'YYYY-MM-DD' format."}}},"LifeStyleActivities":{"type":"object","properties":{"bankruptcyFiledInd":{"type":"string","enum":["Yes","No"],"description":"Indicator flag for bankruptcy"},"bankruptcyDischargeDate":{"type":"string","format":"date","description":"Discharge date of bankruptcy in YYYY-MM-DD format."},"privatePilotLast10YrsInd":{"type":"string","enum":["Yes","No","Unknown"],"description":"Indicator flag for flying history"},"privateFlyingDetails":{"type":"object","properties":{"ifrInd":{"type":"string","enum":["Yes","No","Unknown"],"description":"Indicator flag for Instrument Flight Rating"},"noOfHoursFlown":{"type":"string","description":"Solo flying experience in hours","example":"10"}}},"flyExperimentalInd":{"type":"string","enum":["Yes","No","Unknown"],"description":"Indicator flag for flying experience"},"plantoFlyNext2YrsInd":{"type":"string","enum":["Yes","No","Unknown"],"description":"Indicator flag for future flying plans"},"airRacingInd":{"type":"string","enum":["Yes","No","Unknown"],"description":"Indicator flag for air racing"},"diagnosticTestInd":{"type":"string","enum":["Yes","No","Unknown"],"description":"Indicator flag for diagnostic tests"},"skyDiveInd":{"type":"string","enum":["Yes","No","Unknown"],"description":"Indicator flag for sky diving"},"scubaDivingInd":{"type":"string","enum":["Yes","No","Unknown"],"description":"Indicator flag for scuba diving"},"wingSuitSoaringInd":{"type":"string","enum":["Yes","No","Unknown"],"description":"Indicator flag"},"baseJumpSkiingInd":{"type":"string","enum":["Yes","No","Unknown"],"description":"Indicator flag for jump skiing"},"motorCrossInd":{"type":"string","enum":["Yes","No","Unknown"],"description":"Indicator flag"},"hangGlidingInd":{"type":"string","enum":["Yes","No","Unknown"],"description":"Indicator flag"},"noActivityPlannedInd":{"type":"string","enum":["Yes","No","Unknown"],"description":"Indicator flag for no activity"},"motorRacingInd":{"type":"string","enum":["Yes","No","Unknown"],"description":"Indicator flag for motor racing"},"freeDivingAbove50ftInd":{"type":"string","enum":["Yes","No","Unknown"],"description":"Indicator flag for diving"},"climbingInd":{"type":"string","enum":["Yes","No","Unknown"],"description":"Indicator flag for climbing"},"highRiskPlanNext2YrsInd":{"type":"string","enum":["Yes","No"],"description":"Indicator flag for high risk activity"}}},"PartyOthers":{"type":"object","properties":{"firstName":{"type":"string","description":"First Name of the party","example":"Thomas"},"lastName":{"type":"string","description":"Last Name of the the party","example":"Lawrence"},"middleName":{"type":"string","description":"Middle name of the party"},"name":{"type":"string","description":"Full name of the party.","example":"Thomas Lawrence"},"suffix":{"type":"string","description":"Suffix for given party if Applicable","example":"Sr"},"prefix":{"type":"string","description":"Prefix for given party if Applicable","example":"Dr"},"gender":{"type":"string","enum":["Male","Female"],"description":"Gender of party","example":"Male"},"dob":{"type":"string","format":"date","description":"Date of birth of party"},"age":{"type":"number","description":"Age of the party","example":26},"ssn":{"type":"string","description":"Party SSN","minLength":9,"maxLength":9,"example":"121328426"},"driverNumber":{"type":"string","description":"Driver license number","example":"T61217265934"},"driverState":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"],"description":"State Code","example":"AL"},"noDriversLicenseInd":{"type":"string","enum":["Yes","No","Unknown"],"description":"Flag for Driver License","example":"No"},"address1":{"type":"string","description":"Addres line 1","example":"Wt Road"},"address2":{"type":"string","description":"Addres line 2","example":"St Street"},"city":{"type":"string","description":"City name","example":"Test City"},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"],"description":"State Code","example":"AL"},"zip":{"type":"string","description":"Zip Code. Max char allowed is 9.","maxLength":9,"example":"123456"},"birthCountry":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AN","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","CV","KH","CM","CA","KY","CF","TD","CL","CN","CX","CC","CO","KM","CD","CG","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","SZ","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","US","UY","UZ","VU","VE","VN","VG","VI","WF","EH","XK","YE","ZM","ZW","Other"],"description":"Birth Country","example":"US"},"phone":{"type":"string","description":"Phone number","example":"111-111-2222"},"email":{"type":"string","description":"Email Id of the party","example":"test@abc.com"},"emailType":{"type":"string","enum":["Personal","Business"],"description":"Type of email","example":"Business"},"communicationPreference":{"type":"string","enum":["Mail","Email","Phone"],"description":"Communication preferences","example":"Email"},"classification":{"type":"string","enum":["Individual","Business","Trust","Corporation","Partnership","Other","Group of Individuals","Estate","Child"],"description":"Party classification","example":"Individual"},"relationship":{"type":"string","enum":["Aunt","Brother","Business","Business Associate","Charity","Child","Co-Mortgager","Cousin","Daughter","Dependant","Domestic Partner","Estate","Executors","Father","Fiance","Fiancee","Former Spouse","Friend","God Child","God Parent","Grandchild","Grandparent","Great Grandchild","Great Grandparent","Legal Guardian","Life Partner","Mother","Nephew","Niece","Parent","Parents In Law","Sibling","Sister","Son","Spouse","Stepfather","Stepmother","Trust","Uncle","Self","Other"],"description":"Relationship with insured","example":"Father"},"percentage":{"type":"number","format":"double","example":100,"description":"Requested percentage value"},"dateOfTrust":{"type":"string","format":"date","description":"Date of trust"},"trusteeName":{"type":"array","items":{"type":"object","properties":{"fullName":{"type":"string","description":"Trusee Name","example":"John Doe"}}}},"stateExecution":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"],"description":"State Code","example":"AL"},"trustBeneficiaries":{"type":"array","items":{"type":"object","properties":{"fullName":{"type":"string","description":"Trust Bene Name","example":"John Smith"}}}}}},"PartyOwners":{"type":"object","properties":{"firstName":{"type":"string","description":"First Name of the party","example":"Thomas"},"lastName":{"type":"string","description":"Last Name of the the party","example":"Lawrence"},"middleName":{"type":"string","description":"Middle name of the party"},"name":{"type":"string","description":"Full name of the party.","example":"Thomas Lawrence"},"suffix":{"type":"string","description":"Suffix for given party if Applicable","example":"Sr"},"prefix":{"type":"string","description":"Prefix for given party if Applicable","example":"Dr"},"gender":{"type":"string","enum":["Male","Female"],"description":"Gender of party","example":"Male"},"dob":{"type":"string","format":"date","description":"Date of birth of party"},"age":{"type":"number","description":"Age of the party","example":26},"ssn":{"type":"string","description":"Party SSN. In case if non individual it should be Tax Id","minLength":9,"maxLength":9,"example":"121328426"},"driverNumber":{"type":"string","description":"Driver license number","example":"T61217265934"},"driverState":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"],"description":"State Code","example":"AL"},"noDriversLicenseInd":{"type":"string","enum":["Yes","No","Unknown"],"description":"Flag for Driver License","example":"No"},"address1":{"type":"string","description":"Addres line 1","example":"Wt Road"},"address2":{"type":"string","description":"Addres line 2","example":"St Street"},"city":{"type":"string","description":"City name","example":"Test City"},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"],"description":"State Code","example":"AL"},"zip":{"type":"string","description":"Zip Code. Max char allowed is 9.","maxLength":9,"example":"123456"},"birthCountry":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AN","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","CV","KH","CM","CA","KY","CF","TD","CL","CN","CX","CC","CO","KM","CD","CG","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","SZ","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","US","UY","UZ","VU","VE","VN","VG","VI","WF","EH","XK","YE","ZM","ZW","Other"],"description":"Birth Country","example":"US"},"identification":{"type":"array","items":{"type":"object","properties":{"governmentIdType":{"type":"string","enum":["Passport","StateId","SSN"],"example":"Passport"},"governmentId":{"type":"string","example":"213121414"},"jurisdiction":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","GU","PR"],"description":"State Code if applicable. Provided in case of state issued Id","example":"AL"}}}},"phone":{"type":"string","description":"Phone number","example":"111-111-2222"},"email":{"type":"string","description":"Email Id of the party","example":"test@abc.com"},"emailType":{"type":"string","enum":["Personal","Business"],"description":"Type of email","example":"Business"},"communicationPreference":{"type":"string","enum":["Mail","Email","Phone"],"description":"Communication preferences","example":"Email"},"classification":{"type":"string","enum":["Individual","Business","Trust","Corporation","Partnership","Other","Group of Individuals","Estate","Child"],"description":"Party classification","example":"Individual"},"dateOfTrust":{"type":"string","format":"date","description":"Date of trust"},"trusteeName":{"type":"array","items":{"type":"object","properties":{"fullName":{"type":"string","description":"Trusee Name","example":"John Doe"}}}},"stateExecution":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"],"description":"State Code","example":"AL"},"trustBeneficiaries":{"type":"array","items":{"type":"object","properties":{"fullName":{"type":"string","description":"Trust Bene Name","example":"John Smith"}}}},"relationship":{"type":"string","enum":["Aunt","Brother","Business","Business Associate","Charity","Child","Co-Mortgager","Cousin","Daughter","Dependant","Domestic Partner","Estate","Executors","Father","Fiance","Fiancee","Former Spouse","Friend","God Child","God Parent","Grandchild","Grandparent","Great Grandchild","Great Grandparent","Legal Guardian","Life Partner","Mother","Nephew","Niece","Parent","Parents In Law","Sibling","Sister","Son","Spouse","Stepfather","Stepmother","Trust","Uncle","Self","Other"],"description":"Relationship with insured","example":"Father"}}},"CoverageDetailsComplete":{"type":"object","properties":{"lob":{"type":"string","enum":["Life"],"description":"Line of business","example":"Life"},"riderInd":{"type":"string","example":"Yes"},"productType":{"type":"string","enum":["Indexed Universal Life","Universal Life","Term"],"description":"type of product","example":"Indexed Universal Life"},"productCode":{"type":"string","description":"Product code","example":"ABC001"},"faceAmount":{"type":"number","description":"Face Amount","example":250000},"deathBenefitOpt":{"type":"string","enum":["Level","Increasing"]},"deathBenefitComplianceTest":{"type":"string","enum":["Cash Value Accumulation Test","Guideline Premium Test"]},"paymentFrequency":{"type":"string","enum":["m","q","a","sa","sp"],"description":"Frequency of premium payment","example":"m"},"plannedPremiumAmount":{"type":"number","format":"double","description":"Planned Premium Amount","example":250000.12},"fixedCostPeriod":{"type":"string","enum":["10","15","20","25","30","65"],"description":"Period information","example":"20"},"childCoverageInd":{"type":"string","enum":["Yes","No"],"description":"Flag to indicate the child coverage"},"childCoverageAmount":{"type":"number","description":"Per child coverage amount. This is an optional field","example":250000},"owners":{"type":"array","items":{"$ref":"#/components/schemas/PartyOwners"}},"agents":{"type":"array","items":{"$ref":"#/components/schemas/Agent"}},"primary":{"type":"array","items":{"$ref":"#/components/schemas/PartyOthers"}},"contingent":{"type":"array","items":{"$ref":"#/components/schemas/PartyOthers"}},"physician":{"type":"array","items":{"$ref":"#/components/schemas/PartyOthers"}},"payor":{"type":"array","items":{"$ref":"#/components/schemas/PartyOwners"}},"thirdPartyDesignation":{"type":"array","items":{"$ref":"#/components/schemas/PartyOthers"}},"secondaryAddressee":{"type":"array","items":{"$ref":"#/components/schemas/PartyOthers"}},"existingPolicyCoverageAmount":{"type":"number","description":"existingPolicyCoverageAmount","example":250000},"replacementCoverageAmount":{"type":"number","description":"replacementCoverageAmount","example":250000}}},"Underwriting":{"type":"object","properties":{"decision":{"type":"string","enum":["Approved","Pending Decision","Pending Review","Declined","Risk Not Acceptable"],"description":"Underwriting decision"},"totalReplacementCoverageAmt":{"type":"number","description":"Total replacement coverage amount","example":250000},"status":{"type":"string","enum":["CLEAN_CASE","DECLINED","MODIFIED","ADVERSE","N/A"],"description":"Status of UW case"},"issuedAsAppliedInd":{"type":"string","enum":["Yes","No","Unknown"],"description":"Indicator flag to specify as no change"},"underwritingRiskClass":{"type":"string","enum":["Elite Non-Tobacco","Preferred Non-Tobacco","Standard Non-Tobacco","Standard Tobacco","Standard Aggregate","Substandard Non-Tobacco","Substandard Tobacco"],"description":"Risk Class Configured at Underwriting System.","example":"Elite Non-Tobacco"},"decisionRiskClass":{"type":"string","enum":["Elite Non-Tobacco","Preferred Non-Tobacco","Standard Non-Tobacco","Standard Tobacco","Standard Aggregate","Substandard Non-Tobacco","Substandard Tobacco"],"description":"Decision Risk Class","example":"Elite Non-Tobacco"},"underwritingMethod":{"type":"string","enum":["FULL_UNDERWRITING","ATTESTATION_VALIDATION","ADDITIONAL_UNDERWRITING","SIMPLIFIED_UNDERWRITING","REDUCED_UNDERWRITING"],"description":"Underwriting methods"},"tobaccoPremiumBasis":{"type":"string","enum":["Smoker","Non-Smoker"],"description":"Premium basis"},"tableRating":{"type":"string","enum":["A","B","C","D","E","F","G","H"],"description":"Table rating from Underwriting System.","example":"A"},"permFlatExtraAmt":{"type":"number","description":"Extra Amount","example":250000},"tempFlatExtraAmt":{"type":"number","description":"Temporary extra amount","example":250000},"flatExtrasDuration":{"type":"number","description":"extra duration","example":250000},"approvedFaceAmount":{"type":"number","description":"Approved Face Amount","example":250000},"approvedMaxFaceAmount":{"type":"number","description":"Approved Maximum Face Amount","example":250000},"UnderwritingResult":{"type":"array","items":{"$ref":"#/components/schemas/UnderwritingResult"}}}},"UnderwritingResult":{"type":"object","properties":{"description":{"type":"string","description":"Result description","example":"Scuba diving deeper than 130 feet"},"reasonCode":{"type":"string","enum":["App","MM","LN","Exam One","MIB","EIS"],"description":"Reason code","example":"LN"}}},"Documents":{"type":"object","properties":{"referenceId":{"type":"string","description":"Unique number assigned to given document"},"productCode":{"type":"string","description":"Product code","example":"ABC001"},"documentInformation":{"type":"array","items":{"$ref":"#/components/schemas/DocumentInformation"}}}},"DocumentInformation":{"type":"object","properties":{"documentStream":{"type":"string","description":"Document binary string"},"documentType":{"type":"string","enum":["Terms of Use","Notice and Consent","Privacy Policy","GLBA Privacy Notice","FCRA","MIB Pre Notice","ID Verification Notice","HIPAA","Accelerated Benefit Rider","Buyer Guide","Illustration","Suitability","Application","Signed Application","Replacements Acknowledgement","1035 Exchange Surrender","Evidence Document","Amendment","Electronic Funds Transfer","Supplemental Application","Conforming Illustration","Signed Illustration","Overflow Additional Information"],"description":"Types of document","example":"Illustration"},"documentCategory":{"type":"string","description":"Category of the document as per OnBase system","example":"NB Supporting Document"},"documentFileType":{"type":"string","enum":["application/pdf","image/jpeg","image/jpg","image/png"],"description":"Type of file"}}},"OverrideResults":{"type":"object","properties":{"decisionStatus":{"type":"string","enum":["Risk Not Acceptable"],"description":"Override decision status"},"riskClass":{"type":"string","enum":["Elite Non-Tobacco","Preferred Non-Tobacco","Standard Non-Tobacco","Standard Tobacco","Standard Aggregate","Substandard Non-Tobacco","Substandard Tobacco"],"description":"Risk Class Configured at LPS Engine","example":"Elite Non-Tobacco"},"sourceSystem":{"type":"string","description":"Static value for the source system. Should be always provided.","example":"CarrierName_1-EAPP"},"reason":{"type":"string","description":"Reason details for override","example":"Due to bankcrupty filed"}}},"Payment":{"type":"object","properties":{"paymentMethod":{"type":"string","enum":["ACH","CC"],"description":"Payment methods","example":"ACH"},"paymentFrequency":{"type":"string","enum":["m","q","a","sa","sp"],"description":"Frequency of premium payment","example":"m"},"paymentAmount":{"type":"number","description":"Payment amount","example":100000}},"required":["paymentMethod","paymentFrequency","paymentAmount"]},"BankInformation":{"type":"object","properties":{"bankName":{"type":"string","enum":["Bank of America"],"description":"Name of Bank","example":"Bank of America"},"accountNumber":{"type":"string","description":"Account Number","example":"12345123400"},"routingNumber":{"type":"string","description":"Routing Number","example":"110000150"},"accountType":{"type":"string","enum":["Savings","Checking"],"description":"Account Type","example":"Savings"},"purpose":{"type":"string","enum":["Premium"],"description":"Purpose","example":"Premium"}},"required":["bankName","accountNumber","accountType"]},"Signature":{"required":["state","date"],"type":"object","properties":{"date":{"type":"string","description":"Sign Date","example":"2021-01-12"},"city":{"type":"string","description":"City name","example":"Quincy"},"state":{"$ref":"#/components/schemas/State"},"ip":{"type":"string","description":"IP address","example":"11.11.11.111"}}},"RequestEvidence":{"type":"object","properties":{"eappId":{"type":"string","description":"Unique application Id geenrated by the UI. Each application would have unique identifier","example":"15ea7582-262f-4dfe-8a60-1e8b8e763fd4"},"caseId":{"type":"string","description":"Zinnia Live case","example":"CA0000005656"},"correlationId":{"type":"string","description":"Unique process identifier to track the all linked processed against one single application. This is an optional","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"carrier":{"type":"string","example":"CarrierName"},"firstName":{"type":"string","description":"First Name of the party","example":"Thomas"},"lastName":{"type":"string","description":"Last Name of the the party","example":"Lawrence"},"middleName":{"type":"string","description":"Middle name of the party"},"name":{"type":"string","description":"Full name of the party.","example":"Thomas Lawrence"},"gender":{"type":"string","enum":["Male","Female"],"description":"Gender of party","example":"Male"},"dob":{"type":"string","format":"date","description":"Date of birth of party"},"ssn":{"type":"string","description":"Party SSN. In case if non individual it should be Tax Id","minLength":9,"maxLength":9,"example":"121328426"},"address1":{"type":"string","description":"Address line 1","example":"Wt Road"},"address2":{"type":"string","description":"Address line 2","example":"St Street"},"city":{"type":"string","description":"City name","example":"Test City"},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"],"description":"State Code","example":"AL"},"zip":{"type":"string","description":"Zip Code. Max char allowed is 9.","maxLength":9,"example":"123456"},"phone":{"type":"string","description":"Phone number","example":"111-111-2222"},"classification":{"type":"string","enum":["Individual","Business","Trust","Corporation","Partnership","Other","Group of Individuals","Estate","Child"],"description":"Party classification","example":"Individual"},"appliesToPartyId":{"type":"string","description":"Provided by the Underwriting System.","example":"ID_407226"},"question":{"type":"string","description":"Question will be free text entered by th case manager","example":"Required utility bill to process the request"}}},"EvidenceResponse":{"type":"object","properties":{"eappId":{"type":"string","description":"Unique application Id generated by the UI. Each application would have unique identifier","example":"15ea7582-262f-4dfe-8a60-1e8b8e763fd4"},"caseId":{"type":"string","description":"Zinnia Live case","example":"CA0000005656"},"correlationId":{"type":"string","description":"Unique process identifier to track the all linked processed against one single application. This is an optional","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"carrier":{"type":"string","example":"CarrierName_1"},"firstName":{"type":"string","description":"Frst Name of the party","example":"Thomas"},"lastName":{"type":"string","description":"Last Name of the the party","example":"Lawrence"},"middleName":{"type":"string","description":"Middle name of the party"},"name":{"type":"string","description":"Full name of the party.","example":"Thomas Lawrence"},"gender":{"type":"string","enum":["Male","Female"],"description":"Gender of party","example":"Male"},"dob":{"type":"string","format":"date","description":"Date of birth of party"},"ssn":{"type":"string","description":"Party SSN. In case if non individual it should be Tax Id","minLength":9,"maxLength":9,"example":"121328426"},"address1":{"type":"string","description":"Address line 1","example":"Wt Road"},"address2":{"type":"string","description":"Address line 2","example":"St Street"},"city":{"type":"string","description":"City name","example":"Test City"},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"],"description":"State Code","example":"AL"},"zip":{"type":"string","description":"Zip Code. Max char allowed is 9.","maxLength":9,"example":"123456"},"phone":{"type":"string","description":"Phone number","example":"111-111-2222"},"classification":{"type":"string","enum":["Individual","Business","Trust","Corporation","Partnership","Other","Group of Individuals","Estate","Child"],"description":"Party classification","example":"Individual"},"reqCode":{"type":"string","description":"reqCode as string","example":"Clarifying Question UW"},"reqId":{"type":"string","description":"reqId as string","example":"1030000001"},"requirementId":{"type":"string","description":"requirementId as string","example":"2001234"},"requestedDate":{"type":"string","format":"date","description":"requestedDate in 'YYYY-MM-DD' format."},"appliesToPartyId":{"type":"string","description":"Provided by the Underwriting System.","example":"ID_407226"},"question":{"type":"string","description":"Question will be free text entered by th case manager","example":"Required utility bill to process the request"},"response":{"type":"string","description":"Based on the question type. If it requires attachment then client will submit the document against it.","example":"Sharing the utility bill details"},"documents":{"type":"array","items":{"$ref":"#/components/schemas/Documents"}}}},"CreateCaseRequest":{"type":"object","properties":{"planCode":{"type":"string","description":"Product code","example":"ABC001"}},"required":["eappId","planCode"]},"DocumentRequest":{"type":"object","properties":{"caseId":{"type":"string","description":"Zinnia Live case","example":"CA0000005656"},"externalDocumentId":{"type":"string","description":"Unique number assigned to given document by the source system"},"binaryData":{"type":"string","format":"base64","description":"Base 64 encoded binary stream"},"formNumber":{"type":"string","description":"Unique Number for a form","example":"123456"},"documentType":{"type":"string","enum":["NB_STATE_REPLACEMENT","NB_CONVERSION","NB_APPLICATION","COST_DISCLOSURE","NON_CONTRACTUAL","AGENT_REPORT","ACCELERATED_BENEFIT_RIDER","SURRENDER_COMPARISION","CONSENT_PAPERLESS","TERMS_OF_USE","TERMS_CONDITIONS","CHARITY_ELECTION_FORMS","AUTHORIZATION_FORMS","HIPPA","HIV_CONSENT_FORM_ALL_STATE","AMENDMENT","DISCLOSURES","NB_STATE_REPLACEMENT_NOTICE","TRUSTEE_STATEMENT","TERMS_OF_USE","NOTICE_AND_CONSENT","PRIVACY_POLICY","GLBA_PRIVACY_NOTICE","FCRA","MIB_PRE_NOTICE","ID_VERIFICATION_NOTICE","HIPAA","ACCELERATED_BENEFIT_RIDER","BUYER_GUIDE","ILLUSTRATION","SUITABILITY","APPLICATION","SIGNED_APPLICATION","REPLACEMENTS_ACKNOWLEDGEMENT","1035_EXCHANGE_SURRENDER","EVIDENCE_DOCUMENT","AMENDMENT","ELECTRONIC_FUNDS_TRANSFER","SUPPLEMENTAL_APPLICATION","CONFORMING_ILLUSTRATION","SIGNED_ILLUSTRATION","OVERFLOW_ADDITIONAL_INFORMATION"],"example":"TERMS_OF_USE"},"category":{"type":"string","enum":["NEW_BUSINESS"],"description":"Category of the document as per OnBase system","example":"NEW_BUSINESS"},"fileName":{"type":"string","description":"Source File Name","example":"E0001_Signed_Application.PDF, E0002 Unsigned Application.PDF"},"displayName":{"type":"string","description":"Source File Name","example":"Signed_Application.PDF, Unsigned Application.PDF"},"fileType":{"type":"string","enum":["pdf"],"description":"Type of file"}},"required":["correlationId","eappId","carrier","caseId","binaryData","documentType","fileName","fileType","displayName","category"]},"UnderwritingDecision":{"type":"object","properties":{"eappId":{"type":"string","description":"Unique application Id generated by the UI. Each application would have unique identifier","example":"15ea7582-262f-4dfe-8a60-1e8b8e763fd4"},"correlationId":{"type":"string","description":"Unique process identifier to track the all linked processed against one single application. This is an optional","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"carrier":{"type":"string","example":"CarrierName_1"},"policyStatus":{"type":"string","enum":["Applied For","Approved","Submitted to Underwriting","Pending","Declined","Quoted","Risk Not Acceptable","Proposed","Counter Offer","Not Taken","Issue Pending","Issued","Closed","Active","Lapsed","Cancelled Not Taken","Lapse Pending","Cancelled FreeLook","Cancelled","Offer Accepted","Death Claim Pending","Death Claim Paid","Expired","Matured","Surrendered","Rescission","Death Claim Approved","Suspended Active","Suspended Not Active"],"description":"Status of the policy. It should be - Issued in order to issue the policy","example":"Issued"},"underwriting":{"$ref":"#/components/schemas/Underwriting"},"quoteResponse":{"$ref":"#/components/schemas/QuoteResponse"}}},"QuoteResponse":{"type":"object","properties":{"quoteId":{"type":"string","description":"Unique Id generated by the LPS system","example":"Q332022203127424"},"success":{"type":"boolean","description":"Quote status","example":false},"faceAmount":{"type":"number","description":"Face Amount","example":250000},"premiumAmount":{"type":"number","format":"double","description":"Premium amount","example":216.16},"paymentTerm":{"type":"string","description":"Duration of payment","example":"20"},"premiumFrequency":{"type":"string","enum":["m","q","a","sa","sp"],"description":"Frequency of premium payment","example":"m"},"totRequestedFaceAmt":{"type":"number","description":"Requested Face Amount","example":250000},"totRequestedFaceAmtPremium":{"type":"number","description":"Requested Face Amount Premium amount","example":216},"issueAge":{"type":"number","description":"Issue Age","example":34},"quoteDate":{"type":"string","format":"date-time","description":"Date (with pattern \"yyyy-MM-dd'T'HH:mm:ss'Z'\"). Quote date"},"productVersionCode":{"type":"string","description":"Product Version code","example":"2019v1"},"annualPolicyMgmtFee":{"type":"number","description":"Annual policy management fee","example":0},"budgetFriendlyPremiumAmt":{"type":"number","description":"Premium amount option","example":10},"maxMatchPremiumAmt":{"type":"number","description":"Maximum Premium amount","example":260},"maxFundedPremiumAmt":{"type":"number","description":"Maximum Funded Premium amount","example":600},"maxMatchPercent":{"type":"number","description":"Maximum match percent","example":10},"maxMatchYear":{"type":"number","description":"Year","example":7},"acctValIntRate":{"type":"number","description":"Account value interest rate","example":3.5},"payToAge":{"type":"string","description":"pay to age till given value","example":"60"},"maxPayToAge":{"type":"string","description":"Maximum Pay age","example":"60"},"minPayToAge":{"type":"string","description":"Min pay age","example":"30"},"cashValue":{"type":"number","description":"Cash value as on date","example":139512.94},"cashValueAgeOf":{"type":"number","description":"Cash value as on date","example":60},"solveType":{"type":"string","description":"From LPS","example":"INITIAL"},"riskClass":{"type":"string","enum":["Elite Non-Tobacco","Preferred Non-Tobacco","Standard Non-Tobacco","Standard Tobacco","Standard Aggregate","Substandard Non-Tobacco","Substandard Tobacco"],"description":"Risk Class Configured at LPS Engine","example":"Elite Non-Tobacco"},"underwritingMethod":{"type":"string","enum":["FULL_UNDERWRITING","ATTESTATION_VALIDATION","ADDITIONAL_UNDERWRITING","SIMPLIFIED_UNDERWRITING","REDUCED_UNDERWRITING"],"description":"Underwriting types","example":"FULL_UNDERWRITING"},"deathBenefitOpt":{"type":"string","enum":["Level","Increasing"]},"costIndices":{"type":"array","items":{"$ref":"#/components/schemas/CostIndices"}},"riders":{"type":"array","items":{"$ref":"#/components/schemas/RidersDetails"}}}},"CostIndices":{"type":"object","properties":{"type":{"type":"string","description":"Indices Type","example":"NetPayment"},"year":{"type":"string","description":"Year at value","example":"10"},"value":{"type":"number","description":"Indices Type","example":2.31}}},"RidersDetails":{"type":"object","properties":{"code":{"type":"string","enum":["ABC001_CR"],"description":"Riders Code"},"name":{"type":"string","description":"Rider Name","example":"Child rider"},"isAllowed":{"type":"string","enum":["Yes","No"],"description":"Flag related to riders details","example":"Yes"},"isIncluded":{"type":"string","enum":["Yes","No"],"description":"Flag related to riders details","example":"Yes"}}},"SubmitPolicy":{"type":"object","properties":{"eappId":{"type":"string","description":"Unique application Id generated by the UI. Each application would have unique identifier","example":"15ea7582-262f-4dfe-8a60-1e8b8e763fd4"},"caseId":{"type":"string","description":"Zinnia Live case","example":"CA0000005656"},"correlationId":{"type":"string","description":"Unique process identifier to track the all linked processed against one single application. This is an optional","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"carrier":{"type":"string","description":"Four characters carrier code provided by zinnia","example":"ABCD"},"uwCaseId":{"type":"string","description":"Underwriting case Id generated by the underwriting system","example":"1124152"},"customerId":{"type":"string","description":"We get the customer Id as part of application request to support older products.","example":"0017b0000102A1UAAU"},"appStartDate":{"type":"string","format":"date-time","description":"Date (with pattern \"yyyy-MM-dd'T'HH:mm:ss'Z'\"). Application start date"},"actionType":{"type":"string","enum":["Create","Update","Submit"],"description":"To submit the application, actionType would be - Submit","example":"Submit"},"policyStatus":{"type":"string","enum":["Applied For","Approved","Submitted to Underwriting","Pending","Declined","Quoted","Risk Not Acceptable","Proposed","Counter Offer","Not Taken","Issue Pending","Issued","Closed","Active","Lapsed","Cancelled Not Taken","Lapse Pending","Cancelled FreeLook","Cancelled","Offer Accepted","Death Claim Pending","Death Claim Paid","Expired","Matured","Surrendered","Rescission","Death Claim Approved","Suspended Active","Suspended Not Active"],"description":"Status of the policy. It should be - Issued in order to issue the policy","example":"Issued"},"appSubmissionType":{"type":"string","enum":["Internet","Electronic","Handwritten"],"description":"Submission method of the application","example":"Electronic"},"policyHoldingForm":{"type":"string","enum":["Individual"],"description":"Holding Form. It should always be Individual.","example":"Individual"},"policyHoldingStatus":{"type":"string","enum":["Proposed","Active"],"description":"Holding Status","example":"Proposed"},"consentInd":{"type":"string","enum":["Yes","No"],"description":"Consent Indicator Value. Whether the user has provided the consent for this policy or not. This value is used by the underwriting system."},"appState":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"],"description":"State Code. The application state.","example":"AL"},"consentIndState":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"],"description":"Consented state value"},"consentSubmissionType":{"type":"string","enum":["Internet","Electronic","Handwritten"],"description":"Consented submission method of the application","example":"Electronic"},"appFormNumber":{"type":"string","description":"Form number if applicable. The number assigned on the application form.","example":"ICC20 ABC 104_08-20"},"appVersionNumber":{"type":"string","description":"Form version number if applicable","example":"ICC20 ABC 104_08-20"},"pageLastVisitedId":{"type":"string","description":"User Id who has accessed this page last time."},"appLastUpdated":{"type":"string","format":"date-time","description":"Date (with pattern \"yyyy-MM-dd'T'HH:mm:ss'Z'\"). Application last update date."},"appExpirationDate":{"type":"string","format":"date-time","description":"Date (with pattern \"yyyy-MM-dd'T'HH:mm:ss'Z'\"). Application expiration date"},"marketingOptInd":{"type":"string","enum":["Yes","No"],"description":"Marketing Indicator flag used by the distributor to capture the sale scope"},"agreeToTermsInd":{"type":"string","enum":["Yes","No"],"description":"Agreed to terms and condition or not."},"replacementIndicator":{"type":"string","enum":["Yes","No","Unknown"],"description":"Flag to determine whether this is replacement application or not."},"replacementLtcIndicator":{"type":"string","enum":["Yes","No"],"description":"Indicates whether the application involves replacement of existing Long-Term Care (LTC) coverage."},"pageId":{"type":"string","description":"Page Identifier","example":"5f45f7b34a3eea021f2fef1c"},"reason":{"type":"string","description":"Reason for declining the policy. This is needed if the policy status is declined or not taken."},"overrideDecisionFlag":{"type":"boolean","description":"Flag to determine override decisions. In case of true Override results is required."},"overrideResults":{"$ref":"#/components/schemas/OverrideResults"},"quote":{"$ref":"#/components/schemas/Quote"},"payload":{"type":"object","properties":{"underwriting":{"$ref":"#/components/schemas/Underwriting"},"insured":{"$ref":"#/components/schemas/PartyAdditional"},"childInsured":{"type":"array","items":{"$ref":"#/components/schemas/PartyChild"}},"coverageDetails":{"$ref":"#/components/schemas/CoverageDetailsComplete"},"additional":{"$ref":"#/components/schemas/AdditionalInformation"},"payment":{"$ref":"#/components/schemas/Payment"},"bankInformation":{"$ref":"#/components/schemas/BankInformation"},"documents":{"type":"array","items":{"$ref":"#/components/schemas/DocumentsList"}}},"required":["insured","coverageDetails","documents","underwriting","payment","bankInformation"]}},"required":["eappId","caseId","correlationId","carrier","actionType","policyStatus","appSubmissionType","policyHoldingForm","consentInd","appStartDate","appState","consentIndState","consentSubmissionType","replacementIndicator","payload","quote"]},"DocumentsList":{"type":"object","properties":{"referenceId":{"type":"string","description":"Unique number assigned to given document"},"trackingId":{"type":"string","description":"Tracking Id"},"productCode":{"type":"string","enum":["ABC001"],"description":"Product code","example":"ABC001"},"documentInformation":{"type":"array","items":{"$ref":"#/components/schemas/DocumentInformation"}},"signature":{"type":"array","items":{"$ref":"#/components/schemas/Signature"}}}},"DeceaseFamily":{"type":"object","properties":{"relationship":{"type":"string","enum":["Aunt","Brother","Business","Business Associate","Charity","Child","Co-Mortgager","Cousin","Daughter","Dependant","Domestic Partner","Estate","Executors","Father","Fiance","Fiancee","Former Spouse","Friend","God Child","God Parent","Grandchild","Grandparent","Great Grandchild","Great Grandparent","Legal Guardian","Life Partner","Mother","Nephew","Niece","Parent","Parents In Law","Sibling","Sister","Son","Spouse","Stepfather","Stepmother","Trust","Uncle","Self","Other"],"description":"Relationship with the insured"},"ageOfDeath":{"type":"string","description":"Age at death"},"diagnosis":{"type":"string","enum":["Coronary artery disease","Heart attack","Heart failure or congestive heart failure","Stroke","Bladder Cancer","Colon and Rectal Cancer","Kidney Cancer","Leukemia","Liver Cancer","Lung Cancer","Melanoma","Non-Hodgkin Lymphoma","Pancreatic Cancer","Prostate or testicular Cancer","Thyroid Cancer","Other","Breast Cancer","Endometrial/Ovarian/Cervical Cancer"],"description":"Diagnosis reason"}}},"ExistingPolicyHistory":{"type":"object","properties":{"policyNumber":{"type":"string","description":"Policy Number","example":"ABC000007"},"productCode":{"type":"string","description":"Product code","example":"ABC001"},"amount":{"type":"number","description":"Policy coverage amount","example":25000},"policyStatus":{"type":"string","enum":["Applied For","Approved","Submitted to Underwriting","Pending","Declined","Quoted","Risk Not Acceptable","Proposed","Counter Offer","Not Taken","Issue Pending","Issued","Closed","Active","Lapsed","Cancelled Not Taken","Lapse Pending","Cancelled FreeLook","Cancelled","Offer Accepted","Death Claim Pending","Death Claim Paid","Expired","Matured","Surrendered","Rescission","Death Claim Approved","Suspended Active","Suspended Not Active"],"description":"Policy status","example":"Active"},"replacementCoverageAmount":{"type":"number","description":"Replacement coverage amount","example":10000},"client":{"type":"string","description":"Company name","example":"Security Benefit"},"issueDate":{"type":"string","format":"date","description":"issueDate in 'YYYY-MM-DD' format."}}},"Violations":{"type":"array","items":{"type":"object","properties":{"violationType":{"type":"string","enum":["DUI","SuspLicense","RecklessDriving"],"description":"Violation Types","example":"DUI"},"violationDate":{"type":"string","format":"date","description":"Violation date"},"isApplicable":{"type":"string","enum":["Yes","No"],"description":"Applicable flag."}}}},"LivingHistory":{"type":"object","properties":{"country":{"type":"string","description":"Country Name","example":"IN"},"fromDate":{"type":"string","format":"date","description":"From Date"},"toDate":{"type":"string","format":"date","description":"To Date"},"reason":{"type":"string","description":"Reason of stay","example":"Work"}}},"ForeignTravel":{"type":"object","properties":{"country":{"type":"string","description":"Country Name","example":"IN"},"city":{"type":"string","description":"City Name","example":"abc"}}},"SubstanceUsage":{"type":"object","properties":{"substanceType":{"type":"string","enum":["Drug","Alcohol"],"description":"Type of substance"},"substanceTypeDesc":{"type":"string","description":"Type of substance description","example":"Cocaine"},"frequency":{"type":"string","enum":["Per Day","Per Week","Per Year","Per Month","Per Lifetime","Random","Single","Other","Unknown"],"description":"Violation date","example":"Per Day"},"substanceAmount":{"type":"string","description":"Amount of substance","example":"2"}}},"AgentValidationRequest":{"type":"object","properties":{"carrier":{"type":"string","description":"client code"},"appStartDate":{"type":"string","description":"Application start date","example":"2024-02-07"},"appState":{"type":"string","description":"application state","example":"AL"},"productCode":{"type":"string","description":"product code"},"agents":{"type":"array","items":{"$ref":"#/components/schemas/Agent"}}},"required":["carrier","appStartDate","appState","productCode"]},"ApplicationAdditionalInformation":{"type":"object","properties":{"existingPolicyHistory":{"type":"array","items":{"$ref":"#/components/schemas/ExistingPolicyHistory"}}}},"PolicySubmissionRequest":{"type":"object","required":["caseId","application","illustrations","policy","underwriting","quote","parties"],"properties":{"caseId":{"type":"string","pattern":"^CA\\d{10}$","description":"Case identifier for the policy submission","example":"CA1234567890"},"application":{"$ref":"#/components/schemas/Application"},"illustrations":{"oneOf":[{"$ref":"#/components/schemas/ZinniaIllustration"},{"$ref":"#/components/schemas/ExternalIllustration"}]},"policy":{"$ref":"#/components/schemas/Policy"},"parties":{"$ref":"#/components/schemas/Party"},"underwriting":{"$ref":"#/components/schemas/UnderwritingReview"}}},"PolicySubmissionUpdate":{"type":"object","required":["caseId"],"properties":{"caseId":{"type":"string","pattern":"^CA\\d{10}$","description":"Case identifier for the policy submission","example":"CA1234567890"},"application":{"$ref":"#/components/schemas/ApplicationPatch"},"illustrations":{"oneOf":[{"$ref":"#/components/schemas/ZinniaIllustrationPatch"},{"$ref":"#/components/schemas/ExternalIllustrationPatch"}]},"policy":{"$ref":"#/components/schemas/PolicyPatch"},"parties":{"$ref":"#/components/schemas/PartyPatch"},"underwriting":{"$ref":"#/components/schemas/UnderwritingReviewPatch"}}},"ApplicationResponse":{"type":"object","properties":{"caseId":{"type":"string","description":"Case identifier for the policy submission","example":"CA1234567890"},"application":{"$ref":"#/components/schemas/ApplicationPatch"},"illustrations":{"oneOf":[{"$ref":"#/components/schemas/ZinniaIllustrationResponse"},{"$ref":"#/components/schemas/ExternalIllustrationResponse"}]},"policy":{"$ref":"#/components/schemas/PolicyPatch"},"parties":{"$ref":"#/components/schemas/PartyResponse"},"underwriting":{"$ref":"#/components/schemas/UnderwritingReviewPatch"}}},"PolicySubmissionResponse":{"type":"object","required":["status","timestamp"],"properties":{"status":{"type":"string","enum":["ACCEPTED","PROCESSING","COMPLETED","FAILED"],"description":"Status of the submission","example":"ACCEPTED"},"timestamp":{"type":"string","format":"date-time","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})$","description":"Date and time in ISO-8601 format (YYYY-MM-DDTHH:mm:ss.sssZ)","example":"2022-01-01T00:00:00.000Z"},"message":{"type":"string","example":"Request submitted successfully"},"errors":{"type":"array","items":{"type":"string","example":""}}}},"Party":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/Insured"},{"$ref":"#/components/schemas/Owner"},{"$ref":"#/components/schemas/Beneficiary"},{"$ref":"#/components/schemas/Payor"},{"$ref":"#/components/schemas/Payee"},{"$ref":"#/components/schemas/AgentV2"},{"$ref":"#/components/schemas/Trustee"},{"$ref":"#/components/schemas/Grantor"},{"$ref":"#/components/schemas/AuthorizedSignatory"},{"$ref":"#/components/schemas/CoverageInsured"},{"$ref":"#/components/schemas/ThirdPartyDesignee"},{"$ref":"#/components/schemas/OtherInterestedParty"}]},"description":"All the party role should be explicitly send in the party object."},"PartyPatch":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/InsuredPatch"},{"$ref":"#/components/schemas/OwnerPatch"},{"$ref":"#/components/schemas/BeneficiaryPatch"},{"$ref":"#/components/schemas/PayorPatch"},{"$ref":"#/components/schemas/PayeePatch"},{"$ref":"#/components/schemas/AgentV2Patch"},{"$ref":"#/components/schemas/TrusteePatch"},{"$ref":"#/components/schemas/GrantorPatch"},{"$ref":"#/components/schemas/AuthorizedSignatoryPatch"},{"$ref":"#/components/schemas/CoverageInsuredPatch"},{"$ref":"#/components/schemas/ThirdPartyDesigneePatch"},{"$ref":"#/components/schemas/OtherInterestedPartyPatch"}]},"description":"All the party role should be explicitly send in the party object."},"PartyResponse":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/OwnerResponse"},{"$ref":"#/components/schemas/InsuredResponse"},{"$ref":"#/components/schemas/BeneficiaryResponse"},{"$ref":"#/components/schemas/PayorResponse"},{"$ref":"#/components/schemas/PayeeResponse"},{"$ref":"#/components/schemas/AgentV2Response"},{"$ref":"#/components/schemas/TrusteeResponse"},{"$ref":"#/components/schemas/GrantorResponse"},{"$ref":"#/components/schemas/AuthorizedSignatoryResponse"},{"$ref":"#/components/schemas/RiderInsuredResponse"},{"$ref":"#/components/schemas/ThirdPartyDesigneeResponse"},{"$ref":"#/components/schemas/OtherInterestedPartyResponse"}]},"description":"All the party role should be explicitly send in the party object."},"Policy":{"type":"object","required":["planCode","productType","policyStatus","parties","coverage","payment","documents","issueState","issueCountry"],"properties":{"policyNumber":{"type":"string","description":"If no policy number is provided, Zinnia will generate policy number according to business rules in BPM","example":"1234567890"},"previousPolicyNumber":{"type":"string","description":"Previous policy number in case of Policy Conversion","example":"1234567890"},"planCode":{"type":"string","description":"Plan code for the policy","example":"TL0101"},"productType":{"type":"string","enum":["INDEXEDUNIVERSALLIFE","UNIVERSALLIFE","TERM","WHOLELIFE"],"description":"Type of insurance product","example":"INDEXEDUNIVERSALLIFE"},"policyStatus":{"type":"string","enum":["APPLIEDFOR","APPROVED","SUBMITTEDTOUNDERWRITING","PENDING","DECLINED","QUOTED","RISKNOTACCEPTABLE","NOTTAKEN","PENDINGISSUED","ISSUED","CLOSED","CANCELLED","EXPIRED","CONVERSION"],"description":"Status of the policy","example":"ISSUED"},"policyHoldingForm":{"type":"string","enum":["INDIVIDUAL","GROUP","JOINTINDIVIDUAL"],"description":"Policy holding form (Individual, Organization, or Trust)","example":"INDIVIDUAL"},"policyEffectiveDate":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","description":"Date (with pattern \"yyyy-mm-dd\")","example":"2022-01-01"},"issueState":{"$ref":"#/components/schemas/State"},"issueCountry":{"type":"string","enum":["US"],"description":"Policy Issue Country","example":"US"},"coverage":{"$ref":"#/components/schemas/Coverage"},"riders":{"type":"array","items":{"$ref":"#/components/schemas/RiderDetail"},"description":"List of riders details"},"feature":{"type":"object","properties":{"type":{"type":"string","enum":["SURPLUSDISTRIBUTION"],"example":"SURPLUSDISTRIBUTION"},"subType":{"type":"string","enum":["PAIDUPADDITION","CASH"],"example":"PAIDUPADDITION"},"discounts":{"type":"array","items":{"type":"string","enum":["MULTIPRODUCT","NON"],"description":"Type of discount","example":"MULTIPRODUCT"}}},"allOf":[{"$ref":"#/components/schemas/NonforfeitureOption"},{"type":"object","properties":{"customFeatures":{"type":"array","items":{"type":"string"},"enum":["CONTROLBUSINESSINDICATOR","MULTIPLEPOLICYDISCOUNT"],"description":"Custom features"}}}]},"fundDetails":{"type":"array","items":{"type":"object","properties":{"fundType":{"type":"string","enum":["FIXED","INDEXED","VARIABLE"],"description":"Type of fund","example":"FIXED"},"fundName":{"type":"string","description":"- If fundType FIXED, allowed fundName one of ['Short Term Holding Account', 'Fixed Account', 'Everly Fixed IUL Fund']\n- If fundType INDEXED, allowed fundName one of ['S&P 500', 'S AND P 500 Price Return Annual Point-to-Point with Cap Account', 'S AND P 500 Price Return Annual Point-to-Point with Participation Rate Account', 'S&P MARC 5% ER']\n- If fundType VARIABLE, allowed fundName any string\n","example":"Fixed Account"},"percentage":{"type":"string","description":"Percentage","example":"100"}}}},"payment":{"$ref":"#/components/schemas/PaymentV2"}}},"PolicyPatch":{"type":"object","properties":{"policyNumber":{"type":"string","description":"If no policy number is provided, Zinnia will generate policy number according to business rules in BPM","example":"1234567890"},"previousPolicyNumber":{"type":"string","description":"Previous policy number in case of Policy Conversion","example":"1234567890"},"planCode":{"type":"string","description":"Plan code for the policy","example":"TL0101"},"productType":{"type":"string","enum":["INDEXEDUNIVERSALLIFE","UNIVERSALLIFE","TERM","WHOLELIFE"],"description":"Type of insurance product","example":"INDEXEDUNIVERSALLIFE"},"policyStatus":{"type":"string","enum":["APPLIEDFOR","APPROVED","SUBMITTEDTOUNDERWRITING","PENDING","DECLINED","QUOTED","RISKNOTACCEPTABLE","NOTTAKEN","PENDINGISSUED","ISSUED","CLOSED","CANCELLED","EXPIRED","CONVERSION"],"description":"Status of the policy","example":"ISSUED"},"policyHoldingForm":{"type":"string","enum":["INDIVIDUAL","GROUP","JOINTINDIVIDUAL"],"description":"Policy holding form (Individual, Organization, or Trust)","example":"INDIVIDUAL"},"policyEffectiveDate":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","description":"Date (with pattern \"yyyy-mm-dd\")","example":"2022-01-01"},"issueState":{"$ref":"#/components/schemas/State"},"issueCountry":{"type":"string","enum":["US"],"description":"Policy Issue Country","example":"US"},"coverage":{"$ref":"#/components/schemas/CoveragePatch"},"riders":{"type":"array","items":{"$ref":"#/components/schemas/RiderDetailPatch"},"description":"List of riders details"},"feature":{"type":"object","properties":{"type":{"type":"string","enum":["SURPLUSDISTRIBUTION"],"example":"SURPLUSDISTRIBUTION"},"subType":{"type":"string","enum":["PAIDUPADDITION","CASH"],"example":"PAIDUPADDITION"},"discounts":{"type":"array","items":{"type":"string","enum":["MULTIPRODUCT","NON"],"description":"Type of discount","example":"MULTIPRODUCT"}}},"allOf":[{"$ref":"#/components/schemas/NonforfeitureOption"},{"type":"object","properties":{"customFeatures":{"type":"array","items":{"type":"string"},"enum":["CONTROLBUSINESSINDICATOR","MULTIPLEPOLICYDISCOUNT"],"description":"Custom features"}}}]},"fundDetails":{"type":"array","items":{"type":"object","properties":{"fundType":{"type":"string","enum":["FIXED","INDEXED","VARIABLE"],"description":"Type of fund","example":"FIXED"},"fundName":{"type":"string","description":"- If fundType FIXED, allowed fundName one of ['Short Term Holding Account', 'Fixed Account', 'Everly Fixed IUL Fund']\n- If fundType INDEXED, allowed fundName one of ['S&P 500', 'S AND P 500 Price Return Annual Point-to-Point with Cap Account', 'S AND P 500 Price Return Annual Point-to-Point with Participation Rate Account', 'S&P MARC 5% ER']\n- If fundType VARIABLE, allowed fundName any string\n","example":"Fixed Account"},"percentage":{"type":"string","description":"Percentage","example":"100"}}}},"payment":{"$ref":"#/components/schemas/PaymentV2Patch"}}},"Owner":{"type":"object","required":["partyId","partyType","partyRole","personalInformation","relationship","address","contact","partyCommunication"],"properties":{"partyId":{"type":"string","description":"Unique identifier for the party","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"partyRole":{"type":"string","enum":["OWNER","JOINTOWNER","CONTINGENTOWNER"],"description":"Type of party role","example":"OWNER"},"partyType":{"type":"string","enum":["INDIVIDUAL","ORGANIZATION","TRUST"],"description":"Type of party","example":"INDIVIDUAL"},"relationship":{"$ref":"#/components/schemas/Relationship"},"personalInformation":{"oneOf":[{"$ref":"#/components/schemas/PersonalInformationOwner"},{"$ref":"#/components/schemas/TrustDetails"},{"$ref":"#/components/schemas/OrganizationDetails"}]},"partyCommunication":{"type":"string","enum":["REGULARMAIL","EMAIL","PHONE"],"example":"REGULARMAIL"},"identifiers":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/PassportIdentifier"},{"$ref":"#/components/schemas/StateIdIdentifier"},{"$ref":"#/components/schemas/DriversLicenseIdentifier"},{"$ref":"#/components/schemas/SsnIdentifier"},{"$ref":"#/components/schemas/ItinIdentifier"},{"$ref":"#/components/schemas/EinIdentifier"},{"$ref":"#/components/schemas/AlienRegistrationIdentifier"},{"$ref":"#/components/schemas/ExternalPartyIdentifier"}]},"description":"Array of identifiers for this party"},"address":{"type":"object","properties":{"preferredAddressId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/Address"},"description":"List of addresses associated with this party"}}},"phoneNumber":{"type":"object","properties":{"preferredPhoneId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumber"},"description":"List of phone numbers associated with this party"}}},"email":{"type":"object","properties":{"preferredEmailId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"emails":{"type":"array","items":{"$ref":"#/components/schemas/Email"},"description":"List of emails associated with this party"}}}}},"OwnerPatch":{"type":"object","properties":{"partyId":{"type":"string","description":"Unique identifier for the party","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"partyRole":{"type":"string","enum":["OWNER","JOINTOWNER","CONTINGENTOWNER"],"description":"Type of party role","example":"OWNER"},"partyType":{"type":"string","enum":["INDIVIDUAL","ORGANIZATION","TRUST"],"description":"Type of party","example":"INDIVIDUAL"},"relationship":{"$ref":"#/components/schemas/RelationshipPatch"},"personalInformation":{"oneOf":[{"$ref":"#/components/schemas/PersonalInformationOwnerPatch"},{"$ref":"#/components/schemas/TrustDetailsPatch"},{"$ref":"#/components/schemas/OrganizationDetailsPatch"}]},"partyCommunication":{"type":"string","enum":["REGULARMAIL","EMAIL","PHONE"]},"identifiers":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/PassportIdentifierPatch"},{"$ref":"#/components/schemas/StateIdIdentifierPatch"},{"$ref":"#/components/schemas/DriversLicenseIdentifierPatch"},{"$ref":"#/components/schemas/SsnIdentifierPatch"},{"$ref":"#/components/schemas/ItinIdentifierPatch"},{"$ref":"#/components/schemas/EinIdentifierPatch"},{"$ref":"#/components/schemas/AlienRegistrationIdentifierPatch"},{"$ref":"#/components/schemas/ExternalPartyIdentifierPatch"}]},"description":"Array of identifiers for this party","example":[]},"address":{"type":"object","properties":{"preferredAddressId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/AddressPatch"},"description":"List of addresses associated with this party","example":[]}}},"phoneNumber":{"type":"object","properties":{"preferredPhoneId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberPatch"},"description":"List of phone numbers associated with this party"}}},"email":{"type":"object","properties":{"preferredEmailId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"emails":{"type":"array","items":{"$ref":"#/components/schemas/EmailPatch"},"description":"List of emails associated with this party","example":[]}}}}},"OwnerResponse":{"type":"object","properties":{"partyId":{"type":"string","description":"Unique identifier for the party","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"partyRole":{"type":"string","enum":["OWNER","JOINTOWNER","CONTINGENTOWNER"],"description":"Type of party role","example":"OWNER"},"partyType":{"type":"string","enum":["INDIVIDUAL","ORGANIZATION","TRUST"],"description":"Type of party","example":"INDIVIDUAL"},"relationship":{"$ref":"#/components/schemas/RelationshipPatch"},"personalInformation":{"oneOf":[{"$ref":"#/components/schemas/PersonalInformationOwnerResponse"},{"$ref":"#/components/schemas/TrustDetailsResponse"},{"$ref":"#/components/schemas/OrganizationDetailsResponse"}]},"partyCommunication":{"type":"string","enum":["REGULARMAIL","EMAIL","PHONE"]},"identifiers":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/PassportIdentifierResponse"},{"$ref":"#/components/schemas/StateIdIdentifierResponse"},{"$ref":"#/components/schemas/DriversLicenseIdentifierResponse"},{"$ref":"#/components/schemas/SsnIdentifierResponse"},{"$ref":"#/components/schemas/ItinIdentifierResponse"},{"$ref":"#/components/schemas/EinIdentifierResponse"},{"$ref":"#/components/schemas/AlienRegistrationIdentifierResponse"},{"$ref":"#/components/schemas/ExternalPartyIdentifierResponse"}]},"description":"Array of identifiers for this party","example":[]},"address":{"type":"object","properties":{"preferredAddressId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/AddressPatch"},"description":"List of addresses associated with this party","example":[]}}},"phoneNumber":{"type":"object","properties":{"preferredPhoneId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberPatch"},"description":"List of phone numbers associated with this party"}}},"email":{"type":"object","properties":{"preferredEmailId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"emails":{"type":"array","items":{"$ref":"#/components/schemas/EmailPatch"},"description":"List of emails associated with this party","example":[]}}}}},"AgentV2":{"type":"object","required":["partyId","partyType","partyRole","personalInformation","contact","commissionPercentage","servicingAgent","partyPercentage"],"properties":{"partyId":{"type":"string","description":"Unique identifier for the party","format":"uuid","example":"34ae59ba-daa5-42ca-a8b4-4cd008eac5c5"},"partyRole":{"type":"string","enum":["PRIMARYWRITINGAGENT","PRIMARYSERVICINGAGENT","ADDITIONALSERVICINGAGENT","ADDITIONALWRITINGAGENT"],"example":"PRIMARYWRITINGAGENT"},"partyType":{"type":"string","enum":["INDIVIDUAL","ORGANIZATION"],"example":"INDIVIDUAL"},"partyPercentage":{"type":"number","minimum":0,"maximum":100,"example":50},"agentExternalId":{"type":"string","example":"A12345"},"personalInformation":{"oneOf":[{"$ref":"#/components/schemas/PersonalInformationAgent"},{"$ref":"#/components/schemas/OrganizationDetails"}]},"partyCommunication":{"type":"string","enum":["REGULARMAIL","EMAIL","PHONE"]},"identifiers":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/PassportIdentifier"},{"$ref":"#/components/schemas/StateIdIdentifier"},{"$ref":"#/components/schemas/DriversLicenseIdentifier"},{"$ref":"#/components/schemas/SsnIdentifier"},{"$ref":"#/components/schemas/ItinIdentifier"},{"$ref":"#/components/schemas/EinIdentifier"},{"$ref":"#/components/schemas/AlienRegistrationIdentifier"},{"$ref":"#/components/schemas/ExternalPartyIdentifier"}]},"description":"Array of identifiers for this party"},"address":{"type":"object","properties":{"preferredAddressId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/Address"},"description":"List of addresses associated with this party","example":[]}}},"phoneNumber":{"type":"object","properties":{"preferredPhoneId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumber"},"description":"List of phone numbers associated with this party","example":[]}}},"email":{"type":"object","properties":{"preferredEmailId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"emails":{"type":"array","items":{"$ref":"#/components/schemas/Email"},"description":"List of emails associated with this party","example":[]}}}}},"AgentV2Patch":{"type":"object","properties":{"partyId":{"type":"string","description":"Unique identifier for the party","format":"uuid","example":"34ae59ba-daa5-42ca-a8b4-4cd008eac5c5"},"partyRole":{"type":"string","enum":["PRIMARYWRITINGAGENT","PRIMARYSERVICINGAGENT","ADDITIONALSERVICINGAGENT","ADDITIONALWRITINGAGENT"],"example":"PRIMARYWRITINGAGENT"},"partyType":{"type":"string","enum":["INDIVIDUAL","ORGANIZATION"],"example":"INDIVIDUAL"},"partyPercentage":{"type":"number","minimum":0,"maximum":100,"example":50},"agentExternalId":{"type":"string","example":"A12345"},"personalInformation":{"oneOf":[{"$ref":"#/components/schemas/PersonalInformationAgentPatch"},{"$ref":"#/components/schemas/OrganizationDetailsPatch"}]},"partyCommunication":{"type":"string","enum":["REGULARMAIL","EMAIL","PHONE"]},"identifiers":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/PassportIdentifierPatch"},{"$ref":"#/components/schemas/StateIdIdentifierPatch"},{"$ref":"#/components/schemas/DriversLicenseIdentifierPatch"},{"$ref":"#/components/schemas/SsnIdentifierPatch"},{"$ref":"#/components/schemas/ItinIdentifierPatch"},{"$ref":"#/components/schemas/EinIdentifierPatch"},{"$ref":"#/components/schemas/AlienRegistrationIdentifierPatch"},{"$ref":"#/components/schemas/ExternalPartyIdentifierPatch"}]},"description":"Array of identifiers for this party"},"address":{"type":"object","properties":{"preferredAddressId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/AddressPatch"},"description":"List of addresses associated with this party","example":[]}}},"phoneNumber":{"type":"object","properties":{"preferredPhoneId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberPatch"},"description":"List of phone numbers associated with this party","example":[]}}},"email":{"type":"object","properties":{"preferredEmailId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"emails":{"type":"array","items":{"$ref":"#/components/schemas/EmailPatch"},"description":"List of emails associated with this party","example":[]}}}}},"AgentV2Response":{"type":"object","properties":{"partyId":{"type":"string","description":"Unique identifier for the party","format":"uuid","example":"34ae59ba-daa5-42ca-a8b4-4cd008eac5c5"},"partyRole":{"type":"string","enum":["PRIMARYWRITINGAGENT","PRIMARYSERVICINGAGENT","ADDITIONALSERVICINGAGENT","ADDITIONALWRITINGAGENT"],"example":"PRIMARYWRITINGAGENT"},"partyType":{"type":"string","enum":["INDIVIDUAL","ORGANIZATION"],"example":"INDIVIDUAL"},"partyPercentage":{"type":"number","minimum":0,"maximum":100,"example":50},"agentExternalId":{"type":"string","example":"A12345"},"personalInformation":{"oneOf":[{"$ref":"#/components/schemas/PersonalInformationAgentResponse"},{"$ref":"#/components/schemas/OrganizationDetailsResponse"}]},"partyCommunication":{"type":"string","enum":["REGULARMAIL","EMAIL","PHONE"]},"identifiers":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/PassportIdentifierResponse"},{"$ref":"#/components/schemas/StateIdIdentifierResponse"},{"$ref":"#/components/schemas/DriversLicenseIdentifierResponse"},{"$ref":"#/components/schemas/SsnIdentifierResponse"},{"$ref":"#/components/schemas/ItinIdentifierResponse"},{"$ref":"#/components/schemas/EinIdentifierResponse"},{"$ref":"#/components/schemas/AlienRegistrationIdentifierResponse"},{"$ref":"#/components/schemas/ExternalPartyIdentifierResponse"}]},"description":"Array of identifiers for this party"},"address":{"type":"object","properties":{"preferredAddressId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/AddressPatch"},"description":"List of addresses associated with this party","example":[]}}},"phoneNumber":{"type":"object","properties":{"preferredPhoneId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberPatch"},"description":"List of phone numbers associated with this party","example":[]}}},"email":{"type":"object","properties":{"preferredEmailId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"emails":{"type":"array","items":{"$ref":"#/components/schemas/EmailPatch"},"description":"List of emails associated with this party","example":[]}}}}},"Insured":{"type":"object","required":["partyId","partyType","partyRole","personalInformation","relationship","address"],"properties":{"partyId":{"type":"string","description":"Unique identifier for the party","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"partyRole":{"type":"string","enum":["INSURED"],"description":"Type of party role","example":"INSURED"},"partyType":{"type":"string","enum":["INDIVIDUAL"],"description":"Type of party","example":"INDIVIDUAL"},"personalInformation":{"$ref":"#/components/schemas/PersonalInformationInsured"},"partyCommunication":{"type":"string","enum":["REGULARMAIL","EMAIL","PHONE"]},"identifiers":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/PassportIdentifier"},{"$ref":"#/components/schemas/StateIdIdentifier"},{"$ref":"#/components/schemas/DriversLicenseIdentifier"},{"$ref":"#/components/schemas/SsnIdentifier"},{"$ref":"#/components/schemas/ItinIdentifier"},{"$ref":"#/components/schemas/EinIdentifier"},{"$ref":"#/components/schemas/AlienRegistrationIdentifier"},{"$ref":"#/components/schemas/ExternalPartyIdentifier"}]},"description":"Array of identifiers for this party"},"address":{"type":"object","properties":{"preferredAddressId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/Address"},"description":"List of addresses associated with this party","example":[]}}},"phoneNumber":{"type":"object","properties":{"preferredPhoneId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumber"},"description":"List of phone numbers associated with this party","example":[]}}},"email":{"type":"object","properties":{"preferredEmailId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"emails":{"type":"array","items":{"$ref":"#/components/schemas/Email"},"description":"List of emails associated with this party","example":[]}}},"employment":{"$ref":"#/components/schemas/Employment"},"consentProvider":{"type":"object","description":"Optional consent provider information","properties":{"indicator":{"type":"boolean","description":"Consent indicator","example":true},"state":{"$ref":"#/components/schemas/State"},"submissionType":{"type":"string","enum":["ELECTRONIC","PAPER"],"description":"Method of consent submission","example":"ELECTRONIC"}}},"marketingOptIn":{"type":"boolean","description":"Marketing opt-in preference","example":true},"agreeToTerms":{"type":"boolean","description":"Agreement to terms and conditions","example":true},"signatures":{"type":"array","items":{"$ref":"#/components/schemas/SignatureV2"},"description":"Required list of signatures for the policy submission","minItems":1}}},"InsuredPatch":{"type":"object","properties":{"partyId":{"type":"string","description":"Unique identifier for the party","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"partyRole":{"type":"string","enum":["INSURED"],"description":"Type of party role","example":"INSURED"},"partyType":{"type":"string","enum":["INDIVIDUAL"],"description":"Type of party","example":"INDIVIDUAL"},"personalInformation":{"$ref":"#/components/schemas/PersonalInformationInsuredPatch"},"partyCommunication":{"type":"string","enum":["REGULARMAIL","EMAIL","PHONE"]},"identifiers":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/PassportIdentifierPatch"},{"$ref":"#/components/schemas/StateIdIdentifierPatch"},{"$ref":"#/components/schemas/DriversLicenseIdentifierPatch"},{"$ref":"#/components/schemas/SsnIdentifierPatch"},{"$ref":"#/components/schemas/ItinIdentifierPatch"},{"$ref":"#/components/schemas/EinIdentifierPatch"},{"$ref":"#/components/schemas/AlienRegistrationIdentifierPatch"},{"$ref":"#/components/schemas/ExternalPartyIdentifierPatch"}]},"description":"Array of identifiers for this party"},"address":{"type":"object","properties":{"preferredAddressId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/AddressPatch"},"description":"List of addresses associated with this party","example":[]}}},"phoneNumber":{"type":"object","properties":{"preferredPhoneId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberPatch"},"description":"List of phone numbers associated with this party","example":[]}}},"email":{"type":"object","properties":{"preferredEmailId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"emails":{"type":"array","items":{"$ref":"#/components/schemas/EmailPatch"},"description":"List of emails associated with this party","example":[]}}},"employment":{"$ref":"#/components/schemas/EmploymentPatch"},"consentProvider":{"type":"object","description":"Optional consent provider information","properties":{"indicator":{"type":"boolean","description":"Consent indicator","example":true},"state":{"$ref":"#/components/schemas/State"},"submissionType":{"type":"string","enum":["ELECTRONIC","PAPER"],"description":"Method of consent submission","example":"ELECTRONIC"}}},"marketingOptIn":{"type":"boolean","description":"Marketing opt-in preference","example":true},"agreeToTerms":{"type":"boolean","description":"Agreement to terms and conditions","example":true},"signatures":{"type":"array","items":{"$ref":"#/components/schemas/SignatureV2Patch"},"description":"Required list of signatures for the policy submission","minItems":1}}},"InsuredResponse":{"type":"object","properties":{"partyId":{"type":"string","description":"Unique identifier for the party","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"partyRole":{"type":"string","enum":["INSURED"],"description":"Type of party role","example":"INSURED"},"partyType":{"type":"string","enum":["INDIVIDUAL"],"description":"Type of party","example":"INDIVIDUAL"},"personalInformation":{"$ref":"#/components/schemas/PersonalInformationInsuredPatch"},"partyCommunication":{"type":"string","enum":["REGULARMAIL","EMAIL","PHONE"]},"identifiers":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/PassportIdentifierResponse"},{"$ref":"#/components/schemas/StateIdIdentifierResponse"},{"$ref":"#/components/schemas/DriversLicenseIdentifierResponse"},{"$ref":"#/components/schemas/SsnIdentifierResponse"},{"$ref":"#/components/schemas/ItinIdentifierResponse"},{"$ref":"#/components/schemas/EinIdentifierResponse"},{"$ref":"#/components/schemas/AlienRegistrationIdentifierResponse"},{"$ref":"#/components/schemas/ExternalPartyIdentifierResponse"}]},"description":"Array of identifiers for this party"},"address":{"type":"object","properties":{"preferredAddressId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/AddressPatch"},"description":"List of addresses associated with this party","example":[]}}},"phoneNumber":{"type":"object","properties":{"preferredPhoneId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberPatch"},"description":"List of phone numbers associated with this party","example":[]}}},"email":{"type":"object","properties":{"preferredEmailId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"emails":{"type":"array","items":{"$ref":"#/components/schemas/EmailPatch"},"description":"List of emails associated with this party","example":[]}}},"employment":{"$ref":"#/components/schemas/EmploymentPatch"},"consentProvider":{"type":"object","description":"Optional consent provider information","properties":{"indicator":{"type":"boolean","description":"Consent indicator","example":true},"state":{"$ref":"#/components/schemas/State"},"submissionType":{"type":"string","enum":["ELECTRONIC","PAPER"],"description":"Method of consent submission","example":"ELECTRONIC"}}},"marketingOptIn":{"type":"boolean","description":"Marketing opt-in preference","example":true},"agreeToTerms":{"type":"boolean","description":"Agreement to terms and conditions","example":true},"signatures":{"type":"array","items":{"$ref":"#/components/schemas/SignatureV2Patch"},"description":"Required list of signatures for the policy submission","minItems":1}}},"Beneficiary":{"type":"object","required":["partyId","partyType","partyRole","personalInformation","relationship","partyPercentage"],"properties":{"partyId":{"type":"string","description":"Unique identifier for the party","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"partyRole":{"type":"string","enum":["PRIMARYBENEFICIARY","CONTINGENTBENEFICIARY"],"description":"Type of party role","example":"PRIMARYBENEFICIARY"},"partyType":{"type":"string","enum":["INDIVIDUAL","ORGANIZATION","TRUST"],"description":"Type of party","example":"INDIVIDUAL"},"irrevocableBene":{"type":"boolean","default":false,"description":"Indicates whether the beneficiary designation is irrevocable. Applicable only for the Beneficiary party and accepted regardless of the party type (individual, organization, or trust). Defaults to false when not provided.","example":true},"beneficiaryShareMethod":{"type":"string","enum":["PER_STIRPES_DISTRIBUTION"],"description":"Share method for the beneficiary designation. Applicable only for the Beneficiary party and supported for both Primary and Contingent beneficiary roles. When not provided, no share method is sent to the system of record.","example":"PER_STIRPES_DISTRIBUTION"},"relationship":{"$ref":"#/components/schemas/Relationship"},"personalInformation":{"oneOf":[{"$ref":"#/components/schemas/TrustDetails"},{"$ref":"#/components/schemas/OrganizationDetails"},{"$ref":"#/components/schemas/PersonalInformationPrimary"}]},"partyCommunication":{"type":"string","enum":["REGULARMAIL","EMAIL","PHONE"]},"identifiers":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/PassportIdentifier"},{"$ref":"#/components/schemas/StateIdIdentifier"},{"$ref":"#/components/schemas/DriversLicenseIdentifier"},{"$ref":"#/components/schemas/SsnIdentifier"},{"$ref":"#/components/schemas/ItinIdentifier"},{"$ref":"#/components/schemas/EinIdentifier"},{"$ref":"#/components/schemas/AlienRegistrationIdentifier"},{"$ref":"#/components/schemas/ExternalPartyIdentifier"}]},"description":"Array of identifiers for this party"},"address":{"type":"object","properties":{"preferredAddressId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/Address"},"description":"List of addresses associated with this party","example":[]}}},"phoneNumber":{"type":"object","properties":{"preferredPhoneId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumber"},"description":"List of phone numbers associated with this party","example":[]}}},"email":{"type":"object","properties":{"preferredEmailId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"emails":{"type":"array","items":{"$ref":"#/components/schemas/Email"},"description":"List of emails associated with this party","example":[]}}}}},"BeneficiaryPatch":{"type":"object","properties":{"partyId":{"type":"string","description":"Unique identifier for the party","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"partyRole":{"type":"string","enum":["PRIMARYBENEFICIARY","CONTINGENTBENEFICIARY"],"description":"Type of party role","example":"PRIMARYBENEFICIARY"},"partyType":{"type":"string","enum":["INDIVIDUAL","ORGANIZATION","TRUST"],"description":"Type of party","example":"INDIVIDUAL"},"irrevocableBene":{"type":"boolean","default":false,"description":"Indicates whether the beneficiary designation is irrevocable. Applicable only for the Beneficiary party and accepted regardless of the party type (individual, organization, or trust). Defaults to false when not provided.","example":true},"beneficiaryShareMethod":{"type":"string","enum":["PER_STIRPES_DISTRIBUTION"],"description":"Share method for the beneficiary designation. Applicable only for the Beneficiary party and supported for both Primary and Contingent beneficiary roles. When not provided, no share method is sent to the system of record.","example":"PER_STIRPES_DISTRIBUTION"},"relationship":{"$ref":"#/components/schemas/RelationshipPatch"},"personalInformation":{"oneOf":[{"$ref":"#/components/schemas/TrustDetailsPatch"},{"$ref":"#/components/schemas/OrganizationDetailsPatch"},{"$ref":"#/components/schemas/PersonalInformationPrimaryPatch"}]},"partyCommunication":{"type":"string","enum":["REGULARMAIL","EMAIL","PHONE"]},"identifiers":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/PassportIdentifierPatch"},{"$ref":"#/components/schemas/StateIdIdentifierPatch"},{"$ref":"#/components/schemas/DriversLicenseIdentifierPatch"},{"$ref":"#/components/schemas/SsnIdentifierPatch"},{"$ref":"#/components/schemas/ItinIdentifierPatch"},{"$ref":"#/components/schemas/EinIdentifierPatch"},{"$ref":"#/components/schemas/AlienRegistrationIdentifierPatch"},{"$ref":"#/components/schemas/ExternalPartyIdentifierPatch"}]},"description":"Array of identifiers for this party"},"address":{"type":"object","properties":{"preferredAddressId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/AddressPatch"},"description":"List of addresses associated with this party","example":[]}}},"phoneNumber":{"type":"object","properties":{"preferredPhoneId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberPatch"},"description":"List of phone numbers associated with this party","example":[]}}},"email":{"type":"object","properties":{"preferredEmailId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"emails":{"type":"array","items":{"$ref":"#/components/schemas/EmailPatch"},"description":"List of emails associated with this party","example":[]}}}}},"BeneficiaryResponse":{"type":"object","properties":{"partyId":{"type":"string","description":"Unique identifier for the party","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"partyRole":{"type":"string","enum":["PRIMARYBENEFICIARY","CONTINGENT_BENEFICIARY"],"description":"Type of party role","example":"PRIMARYBENEFICIARY"},"partyType":{"type":"string","enum":["INDIVIDUAL","ORGANIZATION","TRUST"],"description":"Type of party","example":"INDIVIDUAL"},"relationship":{"$ref":"#/components/schemas/RelationshipPatch"},"personalInformation":{"oneOf":[{"$ref":"#/components/schemas/TrustDetailsResponse"},{"$ref":"#/components/schemas/OrganizationDetailsResponse"},{"$ref":"#/components/schemas/PersonalInformationPrimaryResponse"}]},"partyCommunication":{"type":"string","enum":["REGULARMAIL","EMAIL","PHONE"]},"identifiers":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/PassportIdentifierResponse"},{"$ref":"#/components/schemas/StateIdIdentifierResponse"},{"$ref":"#/components/schemas/DriversLicenseIdentifierResponse"},{"$ref":"#/components/schemas/SsnIdentifierResponse"},{"$ref":"#/components/schemas/ItinIdentifierResponse"},{"$ref":"#/components/schemas/EinIdentifierResponse"},{"$ref":"#/components/schemas/AlienRegistrationIdentifierResponse"},{"$ref":"#/components/schemas/ExternalPartyIdentifierResponse"}]},"description":"Array of identifiers for this party"},"address":{"type":"object","properties":{"preferredAddressId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/AddressPatch"},"description":"List of addresses associated with this party","example":[]}}},"phoneNumber":{"type":"object","properties":{"preferredPhoneId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberPatch"},"description":"List of phone numbers associated with this party","example":[]}}},"email":{"type":"object","properties":{"preferredEmailId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"emails":{"type":"array","items":{"$ref":"#/components/schemas/EmailPatch"},"description":"List of emails associated with this party","example":[]}}}}},"Payor":{"type":"object","required":["partyId","partyType","partyRole","personalInformation","contact"],"properties":{"partyId":{"type":"string","description":"Unique identifier for the party","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"partyRole":{"type":"string","enum":["PAYOR"],"description":"Type of party role","example":"PAYOR"},"partyType":{"type":"string","enum":["INDIVIDUAL","ORGANIZATION","TRUST"],"description":"Type of party","example":"INDIVIDUAL"},"relationship":{"$ref":"#/components/schemas/Relationship"},"personalInformation":{"$ref":"#/components/schemas/PersonalInformationPayor"},"partyCommunication":{"type":"string","enum":["REGULARMAIL","EMAIL","PHONE"]},"identifiers":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/PassportIdentifier"},{"$ref":"#/components/schemas/StateIdIdentifier"},{"$ref":"#/components/schemas/DriversLicenseIdentifier"},{"$ref":"#/components/schemas/SsnIdentifier"},{"$ref":"#/components/schemas/ItinIdentifier"},{"$ref":"#/components/schemas/EinIdentifier"},{"$ref":"#/components/schemas/AlienRegistrationIdentifier"},{"$ref":"#/components/schemas/ExternalPartyIdentifier"}]},"description":"Array of identifiers for this party"},"address":{"type":"object","properties":{"preferredAddressId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/Address"},"description":"List of addresses associated with this party","example":[]}}},"phoneNumber":{"type":"object","properties":{"preferredPhoneId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumber"},"description":"List of phone numbers associated with this party","example":[]}}},"email":{"type":"object","properties":{"preferredEmailId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"emails":{"type":"array","items":{"$ref":"#/components/schemas/Email"},"description":"List of emails associated with this party","example":[]}}},"employment":{"$ref":"#/components/schemas/Employment"}}},"PayorPatch":{"type":"object","properties":{"partyId":{"type":"string","description":"Unique identifier for the party","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"partyRole":{"type":"string","enum":["PAYOR"],"description":"Type of party role","example":"PAYOR"},"partyType":{"type":"string","enum":["INDIVIDUAL","ORGANIZATION","TRUST"],"description":"Type of party","example":"INDIVIDUAL"},"relationship":{"$ref":"#/components/schemas/RelationshipPatch"},"personalInformation":{"$ref":"#/components/schemas/PersonalInformationPayorPatch"},"partyCommunication":{"type":"string","enum":["REGULARMAIL","EMAIL","PHONE"]},"identifiers":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/PassportIdentifierPatch"},{"$ref":"#/components/schemas/StateIdIdentifierPatch"},{"$ref":"#/components/schemas/DriversLicenseIdentifierPatch"},{"$ref":"#/components/schemas/SsnIdentifierPatch"},{"$ref":"#/components/schemas/ItinIdentifierPatch"},{"$ref":"#/components/schemas/EinIdentifierPatch"},{"$ref":"#/components/schemas/AlienRegistrationIdentifierPatch"},{"$ref":"#/components/schemas/ExternalPartyIdentifierPatch"}]},"description":"Array of identifiers for this party"},"address":{"type":"object","properties":{"preferredAddressId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/AddressPatch"},"description":"List of addresses associated with this party","example":[]}}},"phoneNumber":{"type":"object","properties":{"preferredPhoneId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberPatch"},"description":"List of phone numbers associated with this party","example":[]}}},"email":{"type":"object","properties":{"preferredEmailId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"emails":{"type":"array","items":{"$ref":"#/components/schemas/EmailPatch"},"description":"List of emails associated with this party","example":[]}}},"employment":{"$ref":"#/components/schemas/EmploymentPatch"}}},"PayorResponse":{"type":"object","properties":{"partyId":{"type":"string","description":"Unique identifier for the party","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"partyRole":{"type":"string","enum":["PAYOR"],"description":"Type of party role","example":"PAYOR"},"partyType":{"type":"string","enum":["INDIVIDUAL","ORGANIZATION","TRUST"],"description":"Type of party","example":"INDIVIDUAL"},"relationship":{"$ref":"#/components/schemas/RelationshipPatch"},"personalInformation":{"$ref":"#/components/schemas/PersonalInformationPayorPatch"},"partyCommunication":{"type":"string","enum":["REGULARMAIL","EMAIL","PHONE"]},"identifiers":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/PassportIdentifierResponse"},{"$ref":"#/components/schemas/StateIdIdentifierResponse"},{"$ref":"#/components/schemas/DriversLicenseIdentifierResponse"},{"$ref":"#/components/schemas/SsnIdentifierResponse"},{"$ref":"#/components/schemas/ItinIdentifierResponse"},{"$ref":"#/components/schemas/EinIdentifierResponse"},{"$ref":"#/components/schemas/AlienRegistrationIdentifierResponse"},{"$ref":"#/components/schemas/ExternalPartyIdentifierResponse"}]},"description":"Array of identifiers for this party"},"address":{"type":"object","properties":{"preferredAddressId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/AddressPatch"},"description":"List of addresses associated with this party","example":[]}}},"phoneNumber":{"type":"object","properties":{"preferredPhoneId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberPatch"},"description":"List of phone numbers associated with this party","example":[]}}},"email":{"type":"object","properties":{"preferredEmailId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"emails":{"type":"array","items":{"$ref":"#/components/schemas/EmailPatch"},"description":"List of emails associated with this party","example":[]}}},"employment":{"$ref":"#/components/schemas/EmploymentPatch"}}},"Payee":{"type":"object","required":["partyId","partyType","partyRole","personalInformation","contact"],"properties":{"partyId":{"type":"string","description":"Unique identifier for the party","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"partyRole":{"type":"string","enum":["Payee"],"description":"Type of party role","example":"Payee"},"partyType":{"type":"string","enum":["INDIVIDUAL","ORGANIZATION","TRUST"],"description":"Type of party","example":"INDIVIDUAL"},"relationship":{"$ref":"#/components/schemas/Relationship"},"personalInformation":{"$ref":"#/components/schemas/PersonalInformationPayee"},"partyCommunication":{"type":"string","enum":["REGULARMAIL","EMAIL","PHONE"]},"identifiers":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/PassportIdentifier"},{"$ref":"#/components/schemas/StateIdIdentifier"},{"$ref":"#/components/schemas/DriversLicenseIdentifier"},{"$ref":"#/components/schemas/SsnIdentifier"},{"$ref":"#/components/schemas/ItinIdentifier"},{"$ref":"#/components/schemas/EinIdentifier"},{"$ref":"#/components/schemas/AlienRegistrationIdentifier"},{"$ref":"#/components/schemas/ExternalPartyIdentifier"}]},"description":"Array of identifiers for this party"},"address":{"type":"object","properties":{"preferredAddressId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/Address"},"description":"List of addresses associated with this party","example":[]}}},"phoneNumber":{"type":"object","properties":{"preferredPhoneId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumber"},"description":"List of phone numbers associated with this party","example":[]}}},"email":{"type":"object","properties":{"preferredEmailId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"emails":{"type":"array","items":{"$ref":"#/components/schemas/Email"},"description":"List of emails associated with this party","example":[]}}}}},"PayeePatch":{"type":"object","properties":{"partyId":{"type":"string","description":"Unique identifier for the party","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"partyRole":{"type":"string","enum":["Payee"],"description":"Type of party role","example":"Payee"},"partyType":{"type":"string","enum":["INDIVIDUAL","ORGANIZATION","TRUST"],"description":"Type of party","example":"INDIVIDUAL"},"relationship":{"$ref":"#/components/schemas/RelationshipPatch"},"personalInformation":{"$ref":"#/components/schemas/PersonalInformationPayeePatch"},"partyCommunication":{"type":"string","enum":["REGULARMAIL","EMAIL","PHONE"]},"identifiers":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/PassportIdentifierPatch"},{"$ref":"#/components/schemas/StateIdIdentifierPatch"},{"$ref":"#/components/schemas/DriversLicenseIdentifierPatch"},{"$ref":"#/components/schemas/SsnIdentifierPatch"},{"$ref":"#/components/schemas/ItinIdentifierPatch"},{"$ref":"#/components/schemas/EinIdentifierPatch"},{"$ref":"#/components/schemas/AlienRegistrationIdentifierPatch"},{"$ref":"#/components/schemas/ExternalPartyIdentifierPatch"}]},"description":"Array of identifiers for this party"},"address":{"type":"object","properties":{"preferredAddressId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/AddressPatch"},"description":"List of addresses associated with this party","example":[]}}},"phoneNumber":{"type":"object","properties":{"preferredPhoneId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberPatch"},"description":"List of phone numbers associated with this party","example":[]}}},"email":{"type":"object","properties":{"preferredEmailId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"emails":{"type":"array","items":{"$ref":"#/components/schemas/EmailPatch"},"description":"List of emails associated with this party","example":[]}}}}},"PayeeResponse":{"type":"object","properties":{"partyId":{"type":"string","description":"Unique identifier for the party","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"partyRole":{"type":"string","enum":["Payee"],"description":"Type of party role","example":"Payee"},"partyType":{"type":"string","enum":["INDIVIDUAL","ORGANIZATION","TRUST"],"description":"Type of party","example":"INDIVIDUAL"},"relationship":{"$ref":"#/components/schemas/RelationshipPatch"},"personalInformation":{"$ref":"#/components/schemas/PersonalInformationPayeePatch"},"partyCommunication":{"type":"string","enum":["REGULARMAIL","EMAIL","PHONE"]},"identifiers":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/PassportIdentifierResponse"},{"$ref":"#/components/schemas/StateIdIdentifierResponse"},{"$ref":"#/components/schemas/DriversLicenseIdentifierResponse"},{"$ref":"#/components/schemas/SsnIdentifierResponse"},{"$ref":"#/components/schemas/ItinIdentifierResponse"},{"$ref":"#/components/schemas/EinIdentifierResponse"},{"$ref":"#/components/schemas/AlienRegistrationIdentifierResponse"},{"$ref":"#/components/schemas/ExternalPartyIdentifierResponse"}]},"description":"Array of identifiers for this party"},"address":{"type":"object","properties":{"preferredAddressId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/AddressPatch"},"description":"List of addresses associated with this party","example":[]}}},"phoneNumber":{"type":"object","properties":{"preferredPhoneId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberPatch"},"description":"List of phone numbers associated with this party","example":[]}}},"email":{"type":"object","properties":{"preferredEmailId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"emails":{"type":"array","items":{"$ref":"#/components/schemas/EmailPatch"},"description":"List of emails associated with this party","example":[]}}}}},"Trustee":{"type":"object","required":["partyId","partyType","partyRole","personalInformation","contact","parentPartyId"],"properties":{"partyId":{"type":"string","description":"Unique identifier for the party","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"parentPartyId":{"type":"string","description":"Unique identifier for the parent party associated with. For eg it can be owner party Id if owner type is Trust","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"partyRole":{"type":"string","enum":["TRUSTEE"],"description":"Type of party role","example":"TRUSTEE"},"partyType":{"type":"string","enum":["INDIVIDUAL","ORGANIZATION","TRUST"],"description":"Type of party","example":"INDIVIDUAL"},"personalInformation":{"$ref":"#/components/schemas/PersonalInformationTrustee"},"partyCommunication":{"type":"string","enum":["REGULARMAIL","EMAIL","PHONE"]},"identifiers":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/PassportIdentifier"},{"$ref":"#/components/schemas/StateIdIdentifier"},{"$ref":"#/components/schemas/DriversLicenseIdentifier"},{"$ref":"#/components/schemas/SsnIdentifier"},{"$ref":"#/components/schemas/ItinIdentifier"},{"$ref":"#/components/schemas/EinIdentifier"},{"$ref":"#/components/schemas/AlienRegistrationIdentifier"},{"$ref":"#/components/schemas/ExternalPartyIdentifier"}]},"description":"Array of identifiers for this party"},"address":{"type":"object","properties":{"preferredAddressId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/Address"},"description":"List of addresses associated with this party","example":[]}}},"phoneNumber":{"type":"object","properties":{"preferredPhoneId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumber"},"description":"List of phone numbers associated with this party","example":[]}}},"email":{"type":"object","properties":{"preferredEmailId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"emails":{"type":"array","items":{"$ref":"#/components/schemas/Email"},"description":"List of emails associated with this party","example":[]}}},"signature":{"type":"array","items":{"$ref":"#/components/schemas/SignatureV2"}}}},"TrusteePatch":{"type":"object","properties":{"partyId":{"type":"string","description":"Unique identifier for the party","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"parentPartyId":{"type":"string","description":"Unique identifier for the parent party associated with. For eg it can be owner party Id if owner type is Trust","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"partyRole":{"type":"string","enum":["TRUSTEE"],"description":"Type of party role","example":"TRUSTEE"},"partyType":{"type":"string","enum":["INDIVIDUAL","ORGANIZATION","TRUST"],"description":"Type of party","example":"INDIVIDUAL"},"personalInformation":{"$ref":"#/components/schemas/PersonalInformationTrusteePatch"},"partyCommunication":{"type":"string","enum":["REGULARMAIL","EMAIL","PHONE"]},"identifiers":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/PassportIdentifierPatch"},{"$ref":"#/components/schemas/StateIdIdentifierPatch"},{"$ref":"#/components/schemas/DriversLicenseIdentifierPatch"},{"$ref":"#/components/schemas/SsnIdentifierPatch"},{"$ref":"#/components/schemas/ItinIdentifierPatch"},{"$ref":"#/components/schemas/EinIdentifierPatch"},{"$ref":"#/components/schemas/AlienRegistrationIdentifierPatch"},{"$ref":"#/components/schemas/ExternalPartyIdentifierPatch"}]},"description":"Array of identifiers for this party"},"address":{"type":"object","properties":{"preferredAddressId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/AddressPatch"},"description":"List of addresses associated with this party","example":[]}}},"phoneNumber":{"type":"object","properties":{"preferredPhoneId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberPatch"},"description":"List of phone numbers associated with this party","example":[]}}},"email":{"type":"object","properties":{"preferredEmailId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"emails":{"type":"array","items":{"$ref":"#/components/schemas/EmailPatch"},"description":"List of emails associated with this party","example":[]}}},"signature":{"type":"array","items":{"$ref":"#/components/schemas/SignatureV2Patch"}}}},"TrusteeResponse":{"type":"object","properties":{"partyId":{"type":"string","description":"Unique identifier for the party","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"parentPartyId":{"type":"string","description":"Unique identifier for the parent party associated with. For eg it can be owner party Id if owner type is Trust","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"partyRole":{"type":"string","enum":["Trustee"],"description":"Type of party role","example":"Trustee"},"partyType":{"type":"string","enum":["INDIVIDUAL","ORGANIZATION","TRUST"],"description":"Type of party","example":"INDIVIDUAL"},"personalInformation":{"$ref":"#/components/schemas/PersonalInformationTrusteePatch"},"partyCommunication":{"type":"string","enum":["REGULARMAIL","EMAIL","PHONE"]},"identifiers":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/PassportIdentifierResponse"},{"$ref":"#/components/schemas/StateIdIdentifierResponse"},{"$ref":"#/components/schemas/DriversLicenseIdentifierResponse"},{"$ref":"#/components/schemas/SsnIdentifierResponse"},{"$ref":"#/components/schemas/ItinIdentifierResponse"},{"$ref":"#/components/schemas/EinIdentifierResponse"},{"$ref":"#/components/schemas/AlienRegistrationIdentifierResponse"},{"$ref":"#/components/schemas/ExternalPartyIdentifierResponse"}]},"description":"Array of identifiers for this party"},"address":{"type":"object","properties":{"preferredAddressId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/AddressPatch"},"description":"List of addresses associated with this party","example":[]}}},"phoneNumber":{"type":"object","properties":{"preferredPhoneId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberPatch"},"description":"List of phone numbers associated with this party","example":[]}}},"email":{"type":"object","properties":{"preferredEmailId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"emails":{"type":"array","items":{"$ref":"#/components/schemas/EmailPatch"},"description":"List of emails associated with this party","example":[]}}},"signature":{"type":"array","items":{"$ref":"#/components/schemas/SignatureV2Patch"}}}},"Grantor":{"type":"object","required":["partyId","partyType","partyRole","personalInformation","contact","parentPartyId"],"properties":{"partyId":{"type":"string","description":"Unique identifier for the party","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"parentPartyId":{"type":"string","description":"Unique identifier for the parent party associated with. For eg it can be owner party Id if owner type is Trust","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"partyRole":{"type":"string","enum":["Grantor"],"description":"Type of party role","example":"Grantor"},"partyType":{"type":"string","enum":["INDIVIDUAL","ORGANIZATION","TRUST"],"description":"Type of party","example":"INDIVIDUAL"},"personalInformation":{"$ref":"#/components/schemas/PersonalInformationGrantor"},"partyCommunication":{"type":"string","enum":["REGULARMAIL","EMAIL","PHONE"]},"identifiers":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/PassportIdentifier"},{"$ref":"#/components/schemas/StateIdIdentifier"},{"$ref":"#/components/schemas/DriversLicenseIdentifier"},{"$ref":"#/components/schemas/SsnIdentifier"},{"$ref":"#/components/schemas/ItinIdentifier"},{"$ref":"#/components/schemas/EinIdentifier"},{"$ref":"#/components/schemas/AlienRegistrationIdentifier"},{"$ref":"#/components/schemas/ExternalPartyIdentifier"}]},"description":"Array of identifiers for this party"},"address":{"type":"object","properties":{"preferredAddressId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/Address"},"description":"List of addresses associated with this party","example":[]}}},"phoneNumber":{"type":"object","properties":{"preferredPhoneId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumber"},"description":"List of phone numbers associated with this party","example":[]}}},"email":{"type":"object","properties":{"preferredEmailId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"emails":{"type":"array","items":{"$ref":"#/components/schemas/Email"},"description":"List of emails associated with this party","example":[]}}},"signature":{"type":"array","items":{"$ref":"#/components/schemas/SignatureV2"}}}},"GrantorPatch":{"type":"object","properties":{"partyId":{"type":"string","description":"Unique identifier for the party","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"parentPartyId":{"type":"string","description":"Unique identifier for the parent party associated with. For eg it can be owner party Id if owner type is Trust","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"partyRole":{"type":"string","enum":["Grantor"],"description":"Type of party role","example":"Grantor"},"partyType":{"type":"string","enum":["INDIVIDUAL","ORGANIZATION","TRUST"],"description":"Type of party","example":"INDIVIDUAL"},"personalInformation":{"$ref":"#/components/schemas/PersonalInformationGrantorPatch"},"partyCommunication":{"type":"string","enum":["REGULARMAIL","EMAIL","PHONE"]},"identifiers":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/PassportIdentifierPatch"},{"$ref":"#/components/schemas/StateIdIdentifierPatch"},{"$ref":"#/components/schemas/DriversLicenseIdentifierPatch"},{"$ref":"#/components/schemas/SsnIdentifierPatch"},{"$ref":"#/components/schemas/ItinIdentifierPatch"},{"$ref":"#/components/schemas/EinIdentifierPatch"},{"$ref":"#/components/schemas/AlienRegistrationIdentifierPatch"},{"$ref":"#/components/schemas/ExternalPartyIdentifierPatch"}]},"description":"Array of identifiers for this party"},"address":{"type":"object","properties":{"preferredAddressId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/AddressPatch"},"description":"List of addresses associated with this party","example":[]}}},"phoneNumber":{"type":"object","properties":{"preferredPhoneId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberPatch"},"description":"List of phone numbers associated with this party","example":[]}}},"email":{"type":"object","properties":{"preferredEmailId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"emails":{"type":"array","items":{"$ref":"#/components/schemas/EmailPatch"},"description":"List of emails associated with this party","example":[]}}},"signature":{"type":"array","items":{"$ref":"#/components/schemas/SignatureV2Patch"}}}},"GrantorResponse":{"type":"object","properties":{"partyId":{"type":"string","description":"Unique identifier for the party","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"parentPartyId":{"type":"string","description":"Unique identifier for the parent party associated with. For eg it can be owner party Id if owner type is Trust","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"partyRole":{"type":"string","enum":["Grantor"],"description":"Type of party role","example":"Grantor"},"partyType":{"type":"string","enum":["INDIVIDUAL","ORGANIZATION","TRUST"],"description":"Type of party","example":"INDIVIDUAL"},"personalInformation":{"$ref":"#/components/schemas/PersonalInformationGrantorPatch"},"partyCommunication":{"type":"string","enum":["REGULARMAIL","EMAIL","PHONE"]},"identifiers":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/PassportIdentifierResponse"},{"$ref":"#/components/schemas/StateIdIdentifierResponse"},{"$ref":"#/components/schemas/DriversLicenseIdentifierResponse"},{"$ref":"#/components/schemas/SsnIdentifierResponse"},{"$ref":"#/components/schemas/ItinIdentifierResponse"},{"$ref":"#/components/schemas/EinIdentifierResponse"},{"$ref":"#/components/schemas/AlienRegistrationIdentifierResponse"},{"$ref":"#/components/schemas/ExternalPartyIdentifierResponse"}]},"description":"Array of identifiers for this party"},"address":{"type":"object","properties":{"preferredAddressId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/AddressPatch"},"description":"List of addresses associated with this party","example":[]}}},"phoneNumber":{"type":"object","properties":{"preferredPhoneId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberPatch"},"description":"List of phone numbers associated with this party","example":[]}}},"email":{"type":"object","properties":{"preferredEmailId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"emails":{"type":"array","items":{"$ref":"#/components/schemas/EmailPatch"},"description":"List of emails associated with this party","example":[]}}},"signature":{"type":"array","items":{"$ref":"#/components/schemas/SignatureV2Patch"}}}},"AuthorizedSignatory":{"type":"object","required":["partyId","partyType","partyRole","personalInformation","contact"],"properties":{"partyId":{"type":"string","description":"Unique identifier for the party","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"partyRole":{"type":"string","enum":["AUTHORIZEDSIGNATORY"],"description":"Type of party role","example":"AUTHORIZEDSIGNATORY"},"partyType":{"type":"string","enum":["INDIVIDUAL"],"description":"Type of party","example":"INDIVIDUAL"},"personalInformation":{"$ref":"#/components/schemas/PersonalInformationAuthorizedSigner"},"partyCommunication":{"type":"string","enum":["REGULARMAIL","EMAIL","PHONE"]},"identifiers":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/PassportIdentifier"},{"$ref":"#/components/schemas/StateIdIdentifier"},{"$ref":"#/components/schemas/DriversLicenseIdentifier"},{"$ref":"#/components/schemas/SsnIdentifier"},{"$ref":"#/components/schemas/ItinIdentifier"},{"$ref":"#/components/schemas/EinIdentifier"},{"$ref":"#/components/schemas/AlienRegistrationIdentifier"},{"$ref":"#/components/schemas/ExternalPartyIdentifier"}]},"description":"Array of identifiers for this party"},"address":{"type":"object","properties":{"preferredAddressId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/Address"},"description":"List of addresses associated with this party","example":[]}}},"phoneNumber":{"type":"object","properties":{"preferredPhoneId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumber"},"description":"List of phone numbers associated with this party","example":[]}}},"email":{"type":"object","properties":{"preferredEmailId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"emails":{"type":"array","items":{"$ref":"#/components/schemas/Email"},"description":"List of emails associated with this party","example":[]}}},"signature":{"type":"array","items":{"$ref":"#/components/schemas/SignatureV2"}}}},"AuthorizedSignatoryPatch":{"type":"object","properties":{"partyId":{"type":"string","description":"Unique identifier for the party","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"partyRole":{"type":"string","enum":["AUTHORIZEDSIGNATORY"],"description":"Type of party role","example":"AUTHORIZEDSIGNATORY"},"partyType":{"type":"string","enum":["INDIVIDUAL"],"description":"Type of party","example":"INDIVIDUAL"},"personalInformation":{"$ref":"#/components/schemas/PersonalInformationAuthorizedSignerPatch"},"partyCommunication":{"type":"string","enum":["REGULARMAIL","EMAIL","PHONE"]},"identifiers":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/PassportIdentifierPatch"},{"$ref":"#/components/schemas/StateIdIdentifierPatch"},{"$ref":"#/components/schemas/DriversLicenseIdentifierPatch"},{"$ref":"#/components/schemas/SsnIdentifierPatch"},{"$ref":"#/components/schemas/ItinIdentifierPatch"},{"$ref":"#/components/schemas/EinIdentifierPatch"},{"$ref":"#/components/schemas/AlienRegistrationIdentifierPatch"},{"$ref":"#/components/schemas/ExternalPartyIdentifierPatch"}]},"description":"Array of identifiers for this party"},"address":{"type":"object","properties":{"preferredAddressId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/AddressPatch"},"description":"List of addresses associated with this party","example":[]}}},"phoneNumber":{"type":"object","properties":{"preferredPhoneId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberPatch"},"description":"List of phone numbers associated with this party","example":[]}}},"email":{"type":"object","properties":{"preferredEmailId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"emails":{"type":"array","items":{"$ref":"#/components/schemas/EmailPatch"},"description":"List of emails associated with this party","example":[]}}},"signature":{"type":"array","items":{"$ref":"#/components/schemas/SignatureV2Patch"}}}},"AuthorizedSignatoryResponse":{"type":"object","properties":{"partyId":{"type":"string","description":"Unique identifier for the party","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"partyRole":{"type":"string","enum":["AUTHORISEDSIGNER"],"description":"Type of party role","example":"AUTHORISEDSIGNER"},"partyType":{"type":"string","enum":["INDIVIDUAL"],"description":"Type of party","example":"INDIVIDUAL"},"personalInformation":{"$ref":"#/components/schemas/PersonalInformationAuthorizedSignerPatch"},"partyCommunication":{"type":"string","enum":["REGULARMAIL","EMAIL","PHONE"]},"identifiers":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/PassportIdentifierResponse"},{"$ref":"#/components/schemas/StateIdIdentifierResponse"},{"$ref":"#/components/schemas/DriversLicenseIdentifierResponse"},{"$ref":"#/components/schemas/SsnIdentifierResponse"},{"$ref":"#/components/schemas/ItinIdentifierResponse"},{"$ref":"#/components/schemas/EinIdentifierResponse"},{"$ref":"#/components/schemas/AlienRegistrationIdentifierResponse"},{"$ref":"#/components/schemas/ExternalPartyIdentifierResponse"}]},"description":"Array of identifiers for this party"},"address":{"type":"object","properties":{"preferredAddressId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/AddressPatch"},"description":"List of addresses associated with this party","example":[]}}},"phoneNumber":{"type":"object","properties":{"preferredPhoneId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberPatch"},"description":"List of phone numbers associated with this party","example":[]}}},"email":{"type":"object","properties":{"preferredEmailId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"emails":{"type":"array","items":{"$ref":"#/components/schemas/EmailPatch"},"description":"List of emails associated with this party","example":[]}}},"signature":{"type":"array","items":{"$ref":"#/components/schemas/SignatureV2Patch"}}}},"SuccessorOwner":{"type":"object","required":["partyId","partyType","partyRole","personalInformation","relationship","contact"],"properties":{"partyId":{"type":"string","description":"Unique identifier for the party","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"partyRole":{"type":"string","enum":["TBD"],"description":"Type of party role","example":"TBD"},"partyType":{"type":"string","enum":["INDIVIDUAL","ORGANIZATION","TRUST"],"description":"Type of party","example":"INDIVIDUAL"},"relationship":{"$ref":"#/components/schemas/Relationship"},"personalInformation":{"$ref":"#/components/schemas/PersonalInformationSuccessorOwner"},"partyCommunication":{"type":"string","enum":["REGULARMAIL","EMAIL","PHONE"]},"identifiers":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/PassportIdentifier"},{"$ref":"#/components/schemas/StateIdIdentifier"},{"$ref":"#/components/schemas/DriversLicenseIdentifier"},{"$ref":"#/components/schemas/SsnIdentifier"},{"$ref":"#/components/schemas/ItinIdentifier"},{"$ref":"#/components/schemas/EinIdentifier"},{"$ref":"#/components/schemas/AlienRegistrationIdentifier"},{"$ref":"#/components/schemas/ExternalPartyIdentifier"}]},"description":"Array of identifiers for this party"},"address":{"type":"object","properties":{"preferredAddressId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/Address"},"description":"List of addresses associated with this party","example":[]}}},"phoneNumber":{"type":"object","properties":{"preferredPhoneId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumber"},"description":"List of phone numbers associated with this party","example":[]}}},"email":{"type":"object","properties":{"preferredEmailId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"emails":{"type":"array","items":{"$ref":"#/components/schemas/Email"},"description":"List of emails associated with this party","example":[]}}},"employment":{"$ref":"#/components/schemas/Employment"}}},"SuccessorOwnerPatch":{"type":"object","properties":{"partyId":{"type":"string","description":"Unique identifier for the party","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"partyRole":{"type":"string","enum":["TBD"],"description":"Type of party role","example":"TBD"},"partyType":{"type":"string","enum":["INDIVIDUAL","ORGANIZATION","TRUST"],"description":"Type of party","example":"INDIVIDUAL"},"relationship":{"$ref":"#/components/schemas/RelationshipPatch"},"personalInformation":{"$ref":"#/components/schemas/PersonalInformationSuccessorOwnerPatch"},"partyCommunication":{"type":"string","enum":["REGULARMAIL","EMAIL","PHONE"]},"identifiers":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/PassportIdentifierPatch"},{"$ref":"#/components/schemas/StateIdIdentifierPatch"},{"$ref":"#/components/schemas/DriversLicenseIdentifierPatch"},{"$ref":"#/components/schemas/SsnIdentifierPatch"},{"$ref":"#/components/schemas/ItinIdentifierPatch"},{"$ref":"#/components/schemas/EinIdentifierPatch"},{"$ref":"#/components/schemas/AlienRegistrationIdentifierPatch"},{"$ref":"#/components/schemas/ExternalPartyIdentifierPatch"}]},"description":"Array of identifiers for this party"},"address":{"type":"object","properties":{"preferredAddressId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/AddressPatch"},"description":"List of addresses associated with this party","example":[]}}},"phoneNumber":{"type":"object","properties":{"preferredPhoneId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberPatch"},"description":"List of phone numbers associated with this party","example":[]}}},"email":{"type":"object","properties":{"preferredEmailId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"emails":{"type":"array","items":{"$ref":"#/components/schemas/EmailPatch"},"description":"List of emails associated with this party","example":[]}}},"employment":{"$ref":"#/components/schemas/EmploymentPatch"}}},"SuccessorOwnerResponse":{"type":"object","properties":{"partyId":{"type":"string","description":"Unique identifier for the party","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"partyRole":{"type":"string","enum":["TBD"],"description":"Type of party role","example":"TBD"},"partyType":{"type":"string","enum":["INDIVIDUAL","ORGANIZATION","TRUST"],"description":"Type of party","example":"INDIVIDUAL"},"relationship":{"$ref":"#/components/schemas/RelationshipPatch"},"personalInformation":{"$ref":"#/components/schemas/PersonalInformationSuccessorOwnerPatch"},"partyCommunication":{"type":"string","enum":["REGULARMAIL","EMAIL","PHONE"]},"identifiers":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/PassportIdentifierResponse"},{"$ref":"#/components/schemas/StateIdIdentifierResponse"},{"$ref":"#/components/schemas/DriversLicenseIdentifierResponse"},{"$ref":"#/components/schemas/SsnIdentifierResponse"},{"$ref":"#/components/schemas/ItinIdentifierResponse"},{"$ref":"#/components/schemas/EinIdentifierResponse"},{"$ref":"#/components/schemas/AlienRegistrationIdentifierResponse"},{"$ref":"#/components/schemas/ExternalPartyIdentifierResponse"}]},"description":"Array of identifiers for this party"},"address":{"type":"object","properties":{"preferredAddressId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/AddressPatch"},"description":"List of addresses associated with this party","example":[]}}},"phoneNumber":{"type":"object","properties":{"preferredPhoneId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberPatch"},"description":"List of phone numbers associated with this party","example":[]}}},"email":{"type":"object","properties":{"preferredEmailId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"emails":{"type":"array","items":{"$ref":"#/components/schemas/EmailPatch"},"description":"List of emails associated with this party","example":[]}}},"employment":{"$ref":"#/components/schemas/EmploymentPatch"}}},"CoverageInsured":{"type":"object","required":["partyId","partyType","partyRole","personalInformation","relationship","contact"],"properties":{"partyId":{"type":"string","description":"Unique identifier for the party","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"parentPartyId":{"type":"string","description":"Unique identifier for the parent party associated with mentioned party"},"partyRole":{"type":"string","enum":["COVERAGEINSURED"],"description":"Type of party role","example":"COVERAGEINSURED"},"partyType":{"type":"string","enum":["INDIVIDUAL"],"description":"Type of party","example":"INDIVIDUAL"},"relationship":{"$ref":"#/components/schemas/Relationship"},"personalInformation":{"$ref":"#/components/schemas/PersonalInformationCoverageInsured"},"partyCommunication":{"type":"string","enum":["REGULARMAIL","EMAIL","PHONE"]},"identifiers":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/PassportIdentifier"},{"$ref":"#/components/schemas/StateIdIdentifier"},{"$ref":"#/components/schemas/DriversLicenseIdentifier"},{"$ref":"#/components/schemas/SsnIdentifier"},{"$ref":"#/components/schemas/ItinIdentifier"},{"$ref":"#/components/schemas/EinIdentifier"},{"$ref":"#/components/schemas/AlienRegistrationIdentifier"},{"$ref":"#/components/schemas/ExternalPartyIdentifier"}]},"description":"Array of identifiers for this party"},"address":{"type":"object","properties":{"preferredAddressId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/Address"},"description":"List of addresses associated with this party","example":[]}}},"phoneNumber":{"type":"object","properties":{"preferredPhoneId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumber"},"description":"List of phone numbers associated with this party","example":[]}}},"email":{"type":"object","properties":{"preferredEmailId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"emails":{"type":"array","items":{"$ref":"#/components/schemas/Email"},"description":"List of emails associated with this party","example":[]}}},"employment":{"$ref":"#/components/schemas/Employment"}}},"CoverageInsuredPatch":{"type":"object","properties":{"partyId":{"type":"string","description":"Unique identifier for the party","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"parentPartyId":{"type":"string","description":"Unique identifier for the parent party associated with mentioned party"},"partyRole":{"type":"string","enum":["COVERAGEINSURED"],"description":"Type of party role","example":"COVERAGEINSURED"},"partyType":{"type":"string","enum":["INDIVIDUAL"],"description":"Type of party","example":"INDIVIDUAL"},"relationship":{"$ref":"#/components/schemas/RelationshipPatch"},"personalInformation":{"$ref":"#/components/schemas/PersonalInformationCoverageInsuredPatch"},"partyCommunication":{"type":"string","enum":["REGULARMAIL","EMAIL","PHONE"]},"identifiers":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/PassportIdentifierPatch"},{"$ref":"#/components/schemas/StateIdIdentifierPatch"},{"$ref":"#/components/schemas/DriversLicenseIdentifierPatch"},{"$ref":"#/components/schemas/SsnIdentifierPatch"},{"$ref":"#/components/schemas/ItinIdentifierPatch"},{"$ref":"#/components/schemas/EinIdentifierPatch"},{"$ref":"#/components/schemas/AlienRegistrationIdentifierPatch"},{"$ref":"#/components/schemas/ExternalPartyIdentifierPatch"}]},"description":"Array of identifiers for this party"},"address":{"type":"object","properties":{"preferredAddressId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/AddressPatch"},"description":"List of addresses associated with this party","example":[]}}},"phoneNumber":{"type":"object","properties":{"preferredPhoneId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberPatch"},"description":"List of phone numbers associated with this party","example":[]}}},"email":{"type":"object","properties":{"preferredEmailId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"emails":{"type":"array","items":{"$ref":"#/components/schemas/EmailPatch"},"description":"List of emails associated with this party","example":[]}}},"employment":{"$ref":"#/components/schemas/EmploymentPatch"}}},"RiderInsuredResponse":{"type":"object","properties":{"partyId":{"type":"string","description":"Unique identifier for the party","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"parentPartyId":{"type":"string","description":"Unique identifier for the parent party associated with mentioned party"},"partyRole":{"type":"string","enum":["RIDERINSURED"],"description":"Type of party role","example":"RIDERINSURED"},"partyType":{"type":"string","enum":["INDIVIDUAL"],"description":"Type of party","example":"INDIVIDUAL"},"relationship":{"$ref":"#/components/schemas/RelationshipPatch"},"personalInformation":{"$ref":"#/components/schemas/PersonalInformationCoverageInsuredPatch"},"partyCommunication":{"type":"string","enum":["REGULARMAIL","EMAIL","PHONE"]},"identifiers":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/PassportIdentifierResponse"},{"$ref":"#/components/schemas/StateIdIdentifierResponse"},{"$ref":"#/components/schemas/DriversLicenseIdentifierResponse"},{"$ref":"#/components/schemas/SsnIdentifierResponse"},{"$ref":"#/components/schemas/ItinIdentifierResponse"},{"$ref":"#/components/schemas/EinIdentifierResponse"},{"$ref":"#/components/schemas/AlienRegistrationIdentifierResponse"},{"$ref":"#/components/schemas/ExternalPartyIdentifierResponse"}]},"description":"Array of identifiers for this party"},"address":{"type":"object","properties":{"preferredAddressId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/AddressPatch"},"description":"List of addresses associated with this party","example":[]}}},"phoneNumber":{"type":"object","properties":{"preferredPhoneId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberPatch"},"description":"List of phone numbers associated with this party","example":[]}}},"email":{"type":"object","properties":{"preferredEmailId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"emails":{"type":"array","items":{"$ref":"#/components/schemas/EmailPatch"},"description":"List of emails associated with this party","example":[]}}},"employment":{"$ref":"#/components/schemas/EmploymentPatch"}}},"ThirdPartyDesignee":{"type":"object","required":["partyId","partyType","partyRole","personalInformation"],"properties":{"partyId":{"type":"string","description":"Unique identifier for the party","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"partyRole":{"type":"string","enum":["THIRDPARTYDESIGNEE"],"description":"Type of party role","example":"THIRDPARTYDESIGNEE"},"partyType":{"type":"string","enum":["INDIVIDUAL","ORGANIZATION","TRUST"],"description":"Type of party","example":"INDIVIDUAL"},"personalInformation":{"oneOf":[{"$ref":"#/components/schemas/TrustDetails"},{"$ref":"#/components/schemas/OrganizationDetails"},{"$ref":"#/components/schemas/PersonalInformationThirdParty"}]},"partyCommunication":{"type":"string","enum":["REGULARMAIL","EMAIL","PHONE"]},"identifiers":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/PassportIdentifier"},{"$ref":"#/components/schemas/StateIdIdentifier"},{"$ref":"#/components/schemas/DriversLicenseIdentifier"},{"$ref":"#/components/schemas/SsnIdentifier"},{"$ref":"#/components/schemas/ItinIdentifier"},{"$ref":"#/components/schemas/AlienRegistrationIdentifier"},{"$ref":"#/components/schemas/ExternalPartyIdentifier"}]},"description":"Array of identifiers for this party"},"address":{"type":"object","properties":{"preferredAddressId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/Address"},"description":"List of addresses associated with this party","example":[]}}},"phoneNumber":{"type":"object","properties":{"preferredPhoneId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumber"},"description":"List of phone numbers associated with this party","example":[]}}},"email":{"type":"object","properties":{"preferredEmailId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"emails":{"type":"array","items":{"$ref":"#/components/schemas/Email"},"description":"List of emails associated with this party","example":[]}}}}},"ThirdPartyDesigneePatch":{"type":"object","properties":{"partyId":{"type":"string","description":"Unique identifier for the party","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"partyRole":{"type":"string","enum":["THIRDPARTYDESIGNEE"],"description":"Type of party role","example":"THIRDPARTYDESIGNEE"},"partyType":{"type":"string","enum":["INDIVIDUAL","ORGANIZATION","TRUST"],"description":"Type of party","example":"INDIVIDUAL"},"personalInformation":{"oneOf":[{"$ref":"#/components/schemas/TrustDetails"},{"$ref":"#/components/schemas/OrganizationDetails"},{"$ref":"#/components/schemas/PersonalInformationThirdPartyPatch"}]},"partyCommunication":{"type":"string","enum":["REGULARMAIL","EMAIL","PHONE"]},"identifiers":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/PassportIdentifierPatch"},{"$ref":"#/components/schemas/StateIdIdentifierPatch"},{"$ref":"#/components/schemas/DriversLicenseIdentifierPatch"},{"$ref":"#/components/schemas/SsnIdentifierPatch"},{"$ref":"#/components/schemas/ItinIdentifierPatch"},{"$ref":"#/components/schemas/AlienRegistrationIdentifierPatch"},{"$ref":"#/components/schemas/ExternalPartyIdentifierPatch"}]},"description":"Array of identifiers for this party"},"address":{"type":"object","properties":{"preferredAddressId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/AddressPatch"},"description":"List of addresses associated with this party","example":[]}}},"phoneNumber":{"type":"object","properties":{"preferredPhoneId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberPatch"},"description":"List of phone numbers associated with this party","example":[]}}},"email":{"type":"object","properties":{"preferredEmailId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"emails":{"type":"array","items":{"$ref":"#/components/schemas/EmailPatch"},"description":"List of emails associated with this party","example":[]}}}}},"ThirdPartyDesigneeResponse":{"type":"object","properties":{"partyId":{"type":"string","description":"Unique identifier for the party","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"partyRole":{"type":"string","enum":["THIRDPARTYDESIGNEE"],"description":"Type of party role","example":"THIRDPARTYDESIGNEE"},"partyType":{"type":"string","enum":["INDIVIDUAL","ORGANIZATION","TRUST"],"description":"Type of party","example":"INDIVIDUAL"},"personalInformation":{"oneOf":[{"$ref":"#/components/schemas/TrustDetails"},{"$ref":"#/components/schemas/OrganizationDetails"},{"$ref":"#/components/schemas/PersonalInformationThirdPartyResponse"}]},"partyCommunication":{"type":"string","enum":["REGULARMAIL","EMAIL","PHONE"]},"identifiers":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/PassportIdentifierResponse"},{"$ref":"#/components/schemas/StateIdIdentifierResponse"},{"$ref":"#/components/schemas/DriversLicenseIdentifierResponse"},{"$ref":"#/components/schemas/SsnIdentifierResponse"},{"$ref":"#/components/schemas/ItinIdentifierResponse"},{"$ref":"#/components/schemas/EinIdentifierResponse"},{"$ref":"#/components/schemas/AlienRegistrationIdentifierResponse"},{"$ref":"#/components/schemas/ExternalPartyIdentifierResponse"}]},"description":"Array of identifiers for this party"},"address":{"type":"object","properties":{"preferredAddressId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/AddressPatch"},"description":"List of addresses associated with this party","example":[]}}},"phoneNumber":{"type":"object","properties":{"preferredPhoneId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberPatch"},"description":"List of phone numbers associated with this party","example":[]}}},"email":{"type":"object","properties":{"preferredEmailId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"emails":{"type":"array","items":{"$ref":"#/components/schemas/EmailPatch"},"description":"List of emails associated with this party","example":[]}}}}},"Physician":{"type":"object","required":["partyId","partyRole","personalInformation","relationship"],"properties":{"partyId":{"type":"string","description":"Unique identifier for the party","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"partyType":{"type":"string","enum":["INDIVIDUAL"],"description":"Type of party","example":"INDIVIDUAL"},"partyRole":{"type":"string","enum":["PHYSICIAN"],"description":"Type of party role","example":"PHYSICIAN"},"identifiers":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/PassportIdentifier"},{"$ref":"#/components/schemas/StateIdIdentifier"},{"$ref":"#/components/schemas/DriversLicenseIdentifier"},{"$ref":"#/components/schemas/SsnIdentifier"},{"$ref":"#/components/schemas/ItinIdentifier"},{"$ref":"#/components/schemas/EinIdentifier"},{"$ref":"#/components/schemas/AlienRegistrationIdentifier"},{"$ref":"#/components/schemas/ExternalPartyIdentifier"}]},"description":"Array of identifiers for this party"},"personalInformation":{"oneOf":[{"$ref":"#/components/schemas/PersonalInformation"}]},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/Address"},"description":"List of addresses associated with this party","example":[]},"contact":{"$ref":"#/components/schemas/Contact"},"employment":{"$ref":"#/components/schemas/Employment"},"relationship":{"oneOf":[{"$ref":"#/components/schemas/Relationship"}]}}},"PhysicianPatch":{"type":"object","properties":{"partyId":{"type":"string","description":"Unique identifier for the party","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"partyType":{"type":"string","enum":["INDIVIDUAL"],"description":"Type of party","example":"INDIVIDUAL"},"partyRole":{"type":"string","enum":["PHYSICIAN"],"description":"Type of party role","example":"PHYSICIAN"},"identifiers":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/PassportIdentifierPatch"},{"$ref":"#/components/schemas/StateIdIdentifierPatch"},{"$ref":"#/components/schemas/DriversLicenseIdentifierPatch"},{"$ref":"#/components/schemas/SsnIdentifierPatch"},{"$ref":"#/components/schemas/ItinIdentifierPatch"},{"$ref":"#/components/schemas/EinIdentifierPatch"},{"$ref":"#/components/schemas/AlienRegistrationIdentifierPatch"},{"$ref":"#/components/schemas/ExternalPartyIdentifierPatch"}]},"description":"Array of identifiers for this party"},"personalInformation":{"oneOf":[{"$ref":"#/components/schemas/PersonalInformationPatch"}]},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/AddressPatch"},"description":"List of addresses associated with this party","example":[]},"contact":{"$ref":"#/components/schemas/ContactPatch"},"employment":{"$ref":"#/components/schemas/EmploymentPatch"},"relationship":{"oneOf":[{"$ref":"#/components/schemas/RelationshipPatch"}]}}},"PhysicianResponse":{"type":"object","properties":{"partyId":{"type":"string","description":"Unique identifier for the party","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"partyType":{"type":"string","enum":["INDIVIDUAL"],"description":"Type of party","example":"INDIVIDUAL"},"partyRole":{"type":"string","enum":["PHYSICIAN"],"description":"Type of party role","example":"PHYSICIAN"},"identifiers":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/PassportIdentifierResponse"},{"$ref":"#/components/schemas/StateIdIdentifierResponse"},{"$ref":"#/components/schemas/DriversLicenseIdentifierResponse"},{"$ref":"#/components/schemas/SsnIdentifierResponse"},{"$ref":"#/components/schemas/ItinIdentifierResponse"},{"$ref":"#/components/schemas/EinIdentifierResponse"},{"$ref":"#/components/schemas/AlienRegistrationIdentifierResponse"},{"$ref":"#/components/schemas/ExternalPartyIdentifierResponse"}]},"description":"Array of identifiers for this party"},"personalInformation":{"oneOf":[{"$ref":"#/components/schemas/PersonalInformationPatch"}]},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/AddressPatch"},"description":"List of addresses associated with this party","example":[]},"contact":{"$ref":"#/components/schemas/ContactPatch"},"employment":{"$ref":"#/components/schemas/EmploymentPatch"},"relationship":{"oneOf":[{"$ref":"#/components/schemas/RelationshipPatch"}]}}},"SecondaryAddressee":{"type":"object","required":["partyId","partyType","partyRole","personalInformation","relationship"],"properties":{"partyId":{"type":"string","description":"Unique identifier for the party","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"partyType":{"type":"string","enum":["INDIVIDUAL","ORGANIZATION","TRUST"],"description":"Type of party","example":"INDIVIDUAL"},"partyRole":{"type":"string","enum":["SECONDARY_ADDRESSEE"],"description":"Type of party role","example":"SECONDARY_ADDRESSEE"},"identifiers":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/PassportIdentifier"},{"$ref":"#/components/schemas/StateIdIdentifier"},{"$ref":"#/components/schemas/DriversLicenseIdentifier"},{"$ref":"#/components/schemas/SsnIdentifier"},{"$ref":"#/components/schemas/ItinIdentifier"},{"$ref":"#/components/schemas/EinIdentifier"},{"$ref":"#/components/schemas/AlienRegistrationIdentifier"},{"$ref":"#/components/schemas/ExternalPartyIdentifier"}]},"description":"Array of identifiers for this party"},"personalInformation":{"oneOf":[{"$ref":"#/components/schemas/PersonalInformationSecondaryAddressee"}]},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/Address"},"description":"List of addresses associated with this party","example":[]},"contact":{"$ref":"#/components/schemas/Contact"},"employment":{"$ref":"#/components/schemas/Employment"},"relationship":{"oneOf":[{"$ref":"#/components/schemas/Relationship"}]}}},"SecondaryAddresseePatch":{"type":"object","properties":{"partyId":{"type":"string","description":"Unique identifier for the party","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"partyType":{"type":"string","enum":["INDIVIDUAL","ORGANIZATION","TRUST"],"description":"Type of party","example":"INDIVIDUAL"},"partyRole":{"type":"string","enum":["SECONDARY_ADDRESSEE"],"description":"Type of party role","example":"SECONDARY_ADDRESSEE"},"identifiers":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/PassportIdentifierPatch"},{"$ref":"#/components/schemas/StateIdIdentifierPatch"},{"$ref":"#/components/schemas/DriversLicenseIdentifierPatch"},{"$ref":"#/components/schemas/SsnIdentifierPatch"},{"$ref":"#/components/schemas/ItinIdentifierPatch"},{"$ref":"#/components/schemas/EinIdentifierPatch"},{"$ref":"#/components/schemas/AlienRegistrationIdentifierPatch"},{"$ref":"#/components/schemas/ExternalPartyIdentifierPatch"}]},"description":"Array of identifiers for this party"},"personalInformation":{"oneOf":[{"$ref":"#/components/schemas/PersonalInformationSecondaryAddresseePatch"}]},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/AddressPatch"},"description":"List of addresses associated with this party","example":[]},"contact":{"$ref":"#/components/schemas/ContactPatch"},"employment":{"$ref":"#/components/schemas/EmploymentPatch"},"relationship":{"oneOf":[{"$ref":"#/components/schemas/RelationshipPatch"}]}}},"SecondaryAddresseeResponse":{"type":"object","properties":{"partyId":{"type":"string","description":"Unique identifier for the party","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"partyType":{"type":"string","enum":["INDIVIDUAL","ORGANIZATION","TRUST"],"description":"Type of party","example":"INDIVIDUAL"},"partyRole":{"type":"string","enum":["SECONDARY_ADDRESSEE"],"description":"Type of party role","example":"SECONDARY_ADDRESSEE"},"identifiers":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/PassportIdentifierResponse"},{"$ref":"#/components/schemas/StateIdIdentifierResponse"},{"$ref":"#/components/schemas/DriversLicenseIdentifierResponse"},{"$ref":"#/components/schemas/SsnIdentifierResponse"},{"$ref":"#/components/schemas/ItinIdentifierResponse"},{"$ref":"#/components/schemas/EinIdentifierResponse"},{"$ref":"#/components/schemas/AlienRegistrationIdentifierResponse"},{"$ref":"#/components/schemas/ExternalPartyIdentifierResponse"}]},"description":"Array of identifiers for this party"},"personalInformation":{"oneOf":[{"$ref":"#/components/schemas/PersonalInformationSecondaryAddresseeResponse"}]},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/AddressPatch"},"description":"List of addresses associated with this party","example":[]},"contact":{"$ref":"#/components/schemas/ContactPatch"},"employment":{"$ref":"#/components/schemas/EmploymentPatch"},"relationship":{"oneOf":[{"$ref":"#/components/schemas/RelationshipPatch"}]}}},"ChildInsured":{"type":"object","required":["partyId","partyType","partyRole","personalInformation","relationship"],"properties":{"partyId":{"type":"string","description":"Unique identifier for the party","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"partyType":{"type":"string","enum":["INDIVIDUAL"],"description":"Type of party","example":"INDIVIDUAL"},"partyRole":{"type":"string","enum":["CHILD_INSURED"],"description":"Type of party role","example":"CHILD_INSURED"},"identifiers":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/PassportIdentifier"},{"$ref":"#/components/schemas/StateIdIdentifier"},{"$ref":"#/components/schemas/DriversLicenseIdentifier"},{"$ref":"#/components/schemas/SsnIdentifier"},{"$ref":"#/components/schemas/ItinIdentifier"},{"$ref":"#/components/schemas/EinIdentifier"},{"$ref":"#/components/schemas/AlienRegistrationIdentifier"},{"$ref":"#/components/schemas/ExternalPartyIdentifier"}]},"description":"Array of identifiers for this party"},"personalInformation":{"oneOf":[{"$ref":"#/components/schemas/PersonalInformationChild"}]},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/Address"},"description":"List of addresses associated with this party","example":[]},"contact":{"$ref":"#/components/schemas/Contact"},"employment":{"$ref":"#/components/schemas/Employment"},"relationship":{"oneOf":[{"$ref":"#/components/schemas/Relationship"}]},"consentProvider":{"type":"object","description":"Optional consent provider information","properties":{"indicator":{"type":"boolean","description":"Consent indicator","example":true},"state":{"$ref":"#/components/schemas/State"},"submissionType":{"type":"string","enum":["ELECTRONIC","PAPER"],"description":"Method of consent submission","example":"ELECTRONIC"}}},"marketingOptIn":{"type":"boolean","description":"Marketing opt-in preference","example":true},"agreeToTerms":{"type":"boolean","description":"Agreement to terms and conditions","example":true}}},"ChildInsuredPatch":{"type":"object","properties":{"partyId":{"type":"string","description":"Unique identifier for the party","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"partyType":{"type":"string","enum":["INDIVIDUAL"],"description":"Type of party","example":"INDIVIDUAL"},"partyRole":{"type":"string","enum":["CHILD_INSURED"],"description":"Type of party role","example":"CHILD_INSURED"},"identifiers":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/PassportIdentifierPatch"},{"$ref":"#/components/schemas/StateIdIdentifierPatch"},{"$ref":"#/components/schemas/DriversLicenseIdentifierPatch"},{"$ref":"#/components/schemas/SsnIdentifierPatch"},{"$ref":"#/components/schemas/ItinIdentifierPatch"},{"$ref":"#/components/schemas/EinIdentifierPatch"},{"$ref":"#/components/schemas/AlienRegistrationIdentifierPatch"},{"$ref":"#/components/schemas/ExternalPartyIdentifierPatch"}]},"description":"Array of identifiers for this party"},"personalInformation":{"oneOf":[{"$ref":"#/components/schemas/PersonalInformationChildPatch"}]},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/AddressPatch"},"description":"List of addresses associated with this party","example":[]},"contact":{"$ref":"#/components/schemas/ContactPatch"},"employment":{"$ref":"#/components/schemas/EmploymentPatch"},"relationship":{"oneOf":[{"$ref":"#/components/schemas/RelationshipPatch"}]},"consentProvider":{"type":"object","description":"Optional consent provider information","properties":{"indicator":{"type":"boolean","description":"Consent indicator","example":true},"state":{"$ref":"#/components/schemas/State"},"submissionType":{"type":"string","enum":["ELECTRONIC","PAPER"],"description":"Method of consent submission","example":"ELECTRONIC"}}},"marketingOptIn":{"type":"boolean","description":"Marketing opt-in preference","example":true},"agreeToTerms":{"type":"boolean","description":"Agreement to terms and conditions","example":true}}},"ChildInsuredResponse":{"type":"object","properties":{"partyId":{"type":"string","description":"Unique identifier for the party","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"partyType":{"type":"string","enum":["INDIVIDUAL"],"description":"Type of party","example":"INDIVIDUAL"},"partyRole":{"type":"string","enum":["CHILD_INSURED"],"description":"Type of party role","example":"CHILD_INSURED"},"identifiers":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/PassportIdentifierResponse"},{"$ref":"#/components/schemas/StateIdIdentifierResponse"},{"$ref":"#/components/schemas/DriversLicenseIdentifierResponse"},{"$ref":"#/components/schemas/SsnIdentifierResponse"},{"$ref":"#/components/schemas/ItinIdentifierResponse"},{"$ref":"#/components/schemas/EinIdentifierResponse"},{"$ref":"#/components/schemas/AlienRegistrationIdentifierResponse"},{"$ref":"#/components/schemas/ExternalPartyIdentifierResponse"}]},"description":"Array of identifiers for this party"},"personalInformation":{"oneOf":[{"$ref":"#/components/schemas/PersonalInformationChildResponse"}]},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/AddressPatch"},"description":"List of addresses associated with this party","example":[]},"contact":{"$ref":"#/components/schemas/ContactPatch"},"employment":{"$ref":"#/components/schemas/EmploymentPatch"},"relationship":{"oneOf":[{"$ref":"#/components/schemas/RelationshipPatch"}]},"consentProvider":{"type":"object","description":"Optional consent provider information","properties":{"indicator":{"type":"boolean","description":"Consent indicator","example":true},"state":{"$ref":"#/components/schemas/State"},"submissionType":{"type":"string","enum":["ELECTRONIC","PAPER"],"description":"Method of consent submission","example":"ELECTRONIC"}}},"marketingOptIn":{"type":"boolean","description":"Marketing opt-in preference","example":true},"agreeToTerms":{"type":"boolean","description":"Agreement to terms and conditions","example":true}}},"OtherInterestedParty":{"type":"object","required":["partyId","partyType","partyRole","personalInformation"],"properties":{"partyId":{"type":"string","description":"Unique identifier for the party","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"partyRole":{"type":"string","enum":["OTHERINTERESTEDPARTY"],"description":"Type of party role","example":"OTHERINTERESTEDPARTY"},"partyType":{"type":"string","enum":["INDIVIDUAL","ORGANIZATION","TRUST"],"description":"Type of party","example":"INDIVIDUAL"},"personalInformation":{"oneOf":[{"$ref":"#/components/schemas/TrustDetails"},{"$ref":"#/components/schemas/OrganizationDetails"},{"$ref":"#/components/schemas/PersonalInformationOtherInterestedParty"}]},"partyCommunication":{"type":"string","enum":["REGULARMAIL","EMAIL","PHONE"]},"identifiers":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/PassportIdentifier"},{"$ref":"#/components/schemas/StateIdIdentifier"},{"$ref":"#/components/schemas/DriversLicenseIdentifier"},{"$ref":"#/components/schemas/SsnIdentifier"},{"$ref":"#/components/schemas/ItinIdentifier"},{"$ref":"#/components/schemas/AlienRegistrationIdentifier"},{"$ref":"#/components/schemas/ExternalPartyIdentifier"}]},"description":"Array of identifiers for this party"},"address":{"type":"object","properties":{"preferredAddressId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/Address"},"description":"List of addresses associated with this party","example":[]}}},"phoneNumber":{"type":"object","properties":{"preferredPhoneId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumber"},"description":"List of phone numbers associated with this party","example":[]}}},"email":{"type":"object","properties":{"preferredEmailId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"emails":{"type":"array","items":{"$ref":"#/components/schemas/Email"},"description":"List of emails associated with this party","example":[]}}}}},"OtherInterestedPartyPatch":{"type":"object","properties":{"partyId":{"type":"string","description":"Unique identifier for the party","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"partyRole":{"type":"string","enum":["OTHERINTERESTEDPARTY"],"description":"Type of party role","example":"OTHERINTERESTEDPARTY"},"partyType":{"type":"string","enum":["INDIVIDUAL","ORGANIZATION","TRUST"],"description":"Type of party","example":"INDIVIDUAL"},"personalInformation":{"oneOf":[{"$ref":"#/components/schemas/TrustDetails"},{"$ref":"#/components/schemas/OrganizationDetails"},{"$ref":"#/components/schemas/PersonalInformationOtherInterestedPartyPatch"}]},"partyCommunication":{"type":"string","enum":["REGULARMAIL","EMAIL","PHONE"]},"identifiers":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/PassportIdentifierPatch"},{"$ref":"#/components/schemas/StateIdIdentifierPatch"},{"$ref":"#/components/schemas/DriversLicenseIdentifierPatch"},{"$ref":"#/components/schemas/SsnIdentifierPatch"},{"$ref":"#/components/schemas/ItinIdentifierPatch"},{"$ref":"#/components/schemas/AlienRegistrationIdentifierPatch"},{"$ref":"#/components/schemas/ExternalPartyIdentifierPatch"}]},"description":"Array of identifiers for this party"},"address":{"type":"object","properties":{"preferredAddressId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/AddressPatch"},"description":"List of addresses associated with this party","example":[]}}},"phoneNumber":{"type":"object","properties":{"preferredPhoneId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberPatch"},"description":"List of phone numbers associated with this party","example":[]}}},"email":{"type":"object","properties":{"preferredEmailId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"emails":{"type":"array","items":{"$ref":"#/components/schemas/EmailPatch"},"description":"List of emails associated with this party","example":[]}}}}},"OtherInterestedPartyResponse":{"type":"object","properties":{"partyId":{"type":"string","description":"Unique identifier for the party","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"partyRole":{"type":"string","enum":["OTHERINTERESTEDPARTY"],"description":"Type of party role","example":"OTHERINTERESTEDPARTY"},"partyType":{"type":"string","enum":["INDIVIDUAL","ORGANIZATION","TRUST"],"description":"Type of party","example":"INDIVIDUAL"},"personalInformation":{"oneOf":[{"$ref":"#/components/schemas/TrustDetailsResponse"},{"$ref":"#/components/schemas/OrganizationDetailsResponse"},{"$ref":"#/components/schemas/PersonalInformationOtherInterestedPartyResponse"}]},"partyCommunication":{"type":"string","enum":["REGULARMAIL","EMAIL","PHONE"]},"identifiers":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/PassportIdentifierResponse"},{"$ref":"#/components/schemas/StateIdIdentifierResponse"},{"$ref":"#/components/schemas/DriversLicenseIdentifierResponse"},{"$ref":"#/components/schemas/SsnIdentifierResponse"},{"$ref":"#/components/schemas/ItinIdentifierResponse"},{"$ref":"#/components/schemas/EinIdentifierResponse"},{"$ref":"#/components/schemas/AlienRegistrationIdentifierResponse"},{"$ref":"#/components/schemas/ExternalPartyIdentifierResponse"}]},"description":"Array of identifiers for this party"},"address":{"type":"object","properties":{"preferredAddressId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/AddressPatch"},"description":"List of addresses associated with this party","example":[]}}},"phoneNumber":{"type":"object","properties":{"preferredPhoneId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberPatch"},"description":"List of phone numbers associated with this party","example":[]}}},"email":{"type":"object","properties":{"preferredEmailId":{"type":"string","format":"uuid","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"emails":{"type":"array","items":{"$ref":"#/components/schemas/EmailPatch"},"description":"List of emails associated with this party","example":[]}}}}},"TrustDetails":{"type":"object","required":["trustName","trustDate","trustType","authorizedSigner"],"properties":{"trustName":{"type":"string","description":"Name of the trust","example":"Sunshine Family Trust"},"trustType":{"type":"string","enum":["TESTAMENTARYTRUST","INTERVIVOSTRUST","INDIVIDUALTRUST","CORPORATETRUST","GRANTORTRUST"],"description":"Type of trust","example":"INDIVIDUALTRUST"},"trustDate":{"type":"string","format":"date","description":"Original date when the trust was established","example":"2015-08-15"},"amendedTrustDate":{"type":"string","format":"date","description":"Date of last amendment to the trust","example":"2021-04-10"},"governingStateOfTrust":{"$ref":"#/components/schemas/State"}}},"TrustDetailsPatch":{"type":"object","properties":{"trustName":{"type":"string","description":"Name of the trust","example":"Sunshine Family Trust"},"trustType":{"type":"string","enum":["TESTAMENTARYTRUST","INTERVIVOSTRUST","INDIVIDUALTRUST","CORPORATETRUST","GRANTORTRUST"],"description":"Type of trust","example":"INDIVIDUALTRUST"},"trustDate":{"type":"string","format":"date","description":"Original date when the trust was established","example":"2015-08-15"},"amendedTrustDate":{"type":"string","format":"date","description":"Date of last amendment to the trust","example":"2021-04-10"},"governingStateOfTrust":{"$ref":"#/components/schemas/State"}}},"TrustDetailsResponse":{"type":"object","properties":{"trustName":{"type":"string","description":"Name of the trust","example":"Sunshine Family Trust"},"trustType":{"type":"string","enum":["TESTAMENTARYTRUST","INTERVIVOSTRUST","INDIVIDUALTRUST","CORPORATETRUST","GRANTORTRUST"],"description":"Type of trust","example":"INDIVIDUALTRUST"},"trustDate":{"type":"string","format":"date","description":"Original date when the trust was established","example":"2015-08-15"},"amendedTrustDate":{"type":"string","format":"date","description":"Date of last amendment to the trust","example":"2021-04-10"},"governingStateOfTrust":{"$ref":"#/components/schemas/State"}}},"OrganizationDetails":{"type":"object","required":["organizationName","entityType"],"properties":{"organizationName":{"type":"string","description":"Legal name of the organization","example":"Northwest Financial Group LLC"},"organizationDBAName":{"type":"string","description":"Doing Business As (DBA) name of the organization","example":"NWF Group"},"organizationShortName":{"type":"string","description":"Short or abbreviated name of the organization","example":"NWF"},"organizationCode":{"type":"string","description":"Unique code identifying the organization","example":"ORG-00123"},"entityType":{"type":"string","description":"Legal entity type of the organization","enum":["SOLEPROPRIETORSHIP","GENERALPARTNERSHIP","LIMITEDPARTNERSHIP","CCORPORATION","SCORPORATION","LIMITEDLIABILITYCOMPANY","CHARITABLEORGANIZATION","ESTATE","TRUST","CORPORATION","UNKNOWN"],"example":"LIMITEDLIABILITYCOMPANY"}}},"OrganizationDetailsPatch":{"type":"object","properties":{"organizationName":{"type":"string","description":"Legal name of the organization","example":"Northwest Financial Group LLC"},"organizationDBAName":{"type":"string","description":"Doing Business As (DBA) name of the organization","example":"NWF Group"},"organizationShortName":{"type":"string","description":"Short or abbreviated name of the organization","example":"NWF"},"organizationCode":{"type":"string","description":"Unique code identifying the organization","example":"ORG-00123"},"entityType":{"type":"string","description":"Legal entity type of the organization","enum":["SOLEPROPRIETORSHIP","GENERALPARTNERSHIP","LIMITEDPARTNERSHIP","CCORPORATION","SCORPORATION","LIMITEDLIABILITYCOMPANY","CHARITABLEORGANIZATION","ESTATE","TRUST","CORPORATION","UNKNOWN"],"example":"LIMITEDLIABILITYCOMPANY"}}},"OrganizationDetailsResponse":{"type":"object","properties":{"organizationName":{"type":"string","description":"Legal name of the organization","example":"Northwest Financial Group LLC"},"organizationDBAName":{"type":"string","description":"Doing Business As (DBA) name of the organization","example":"NWF Group"},"organizationShortName":{"type":"string","description":"Short or abbreviated name of the organization","example":"NWF"},"organizationCode":{"type":"string","description":"Unique code identifying the organization","example":"ORG-00123"},"entityType":{"type":"string","description":"Legal entity type of the organization","enum":["SOLEPROPRIETORSHIP","GENERALPARTNERSHIP","LIMITEDPARTNERSHIP","CCORPORATION","SCORPORATION","LIMITEDLIABILITYCOMPANY","CHARITABLEORGANIZATION","ESTATE","TRUST","CORPORATION","UNKNOWN"],"example":"LIMITEDLIABILITYCOMPANY"}}},"IdentifierType":{"type":"string","enum":["PASSPORT","STATEPHOTOID","DRIVERLICENSENUMBER","SSN","TIN","EIN","EXTERNAL","OTHER"],"description":"Type of identifier document"},"IdentifierStatus":{"type":"string","enum":["ACTIVE","EXPIRED","SUSPENDED","REVOKED","PENDING"],"description":"Status of the identifier document","example":"ACTIVE"},"Identifier":{"type":"object","required":["type","value"],"properties":{"type":{"$ref":"#/components/schemas/IdentifierType"},"value":{"type":"string","description":"Value of the identifier","example":"123456789"},"description":{"type":"string","description":"Additional description or notes about this identifier","example":"Passport number"},"source":{"type":"string","description":"Source system or organization that issued this identifier","example":"State of California"}}},"ExternalIdentifier":{"type":"object","required":["type","key","value"],"properties":{"type":{"$ref":"#/components/schemas/IdentifierType"},"key":{"type":"string","example":"ecn","description":"name of the identifier document"},"value":{"type":"string","description":"Value of the identifier","example":"123456789"},"description":{"type":"string","description":"Additional description or notes about this identifier","example":"ecn number"},"source":{"type":"string","description":"Source system or organization that issued this identifier","example":"State of California"}}},"ExternalIdentifierPatch":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/IdentifierType"},"key":{"type":"string","example":"ecn","description":"name of the identifier document"},"value":{"type":"string","description":"Value of the identifier","example":"123456789"},"description":{"type":"string","description":"Additional description or notes about this identifier","example":"ecn number"},"source":{"type":"string","description":"Source system or organization that issued this identifier","example":"State of California"}}},"IdentifierPatch":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/IdentifierType"},"value":{"type":"string","description":"Value of the identifier","example":"123456789"},"description":{"type":"string","description":"Additional description or notes about this identifier","example":"identifier description"},"source":{"type":"string","description":"Source system or organization that issued this identifier","example":"State of California"}}},"GovernmentIssuedIdentifier":{"allOf":[{"$ref":"#/components/schemas/Identifier"},{"type":"object","properties":{"issueDate":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","example":"2015-08-15","description":"Date (with pattern \"yyyy-mm-dd\")"},"expirationDate":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","example":"2025-08-15","description":"Date (with pattern \"yyyy-mm-dd\")"},"status":{"$ref":"#/components/schemas/IdentifierStatus"}}}]},"GovernmentIssuedIdentifierPatch":{"allOf":[{"$ref":"#/components/schemas/IdentifierPatch"},{"type":"object","properties":{"issueDate":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","example":"2015-08-15","description":"Date (with pattern \"yyyy-mm-dd\")"},"expirationDate":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","example":"2025-08-15","description":"Date (with pattern \"yyyy-mm-dd\")"},"status":{"$ref":"#/components/schemas/IdentifierStatus"}}}]},"PassportIdentifier":{"allOf":[{"$ref":"#/components/schemas/GovernmentIssuedIdentifier"},{"type":"object","required":["countryOfIssue"],"properties":{"countryOfIssue":{"$ref":"#/components/schemas/CountryV2"}}}]},"PassportIdentifierPatch":{"allOf":[{"$ref":"#/components/schemas/GovernmentIssuedIdentifierPatch"},{"type":"object","properties":{"countryOfIssue":{"$ref":"#/components/schemas/CountryV2"}}}]},"PassportIdentifierResponse":{"allOf":[{"$ref":"#/components/schemas/GovernmentIssuedIdentifierPatch"},{"type":"object","properties":{"countryOfIssue":{"$ref":"#/components/schemas/CountryV2"}}}]},"StateIdIdentifier":{"allOf":[{"$ref":"#/components/schemas/GovernmentIssuedIdentifier"},{"type":"object","required":["jurisdiction"],"properties":{"jurisdiction":{"$ref":"#/components/schemas/State"}}}]},"StateIdIdentifierPatch":{"allOf":[{"$ref":"#/components/schemas/GovernmentIssuedIdentifierPatch"},{"type":"object","properties":{"jurisdiction":{"$ref":"#/components/schemas/State"}}}]},"StateIdIdentifierResponse":{"allOf":[{"$ref":"#/components/schemas/GovernmentIssuedIdentifierPatch"},{"type":"object","properties":{"jurisdiction":{"$ref":"#/components/schemas/State"}}}]},"DriversLicenseIdentifier":{"allOf":[{"$ref":"#/components/schemas/GovernmentIssuedIdentifier"},{"type":"object","required":["jurisdiction","class"],"properties":{"jurisdiction":{"$ref":"#/components/schemas/State"},"restrictions":{"type":"array","items":{"type":"string"},"description":"List of license restrictions"}}}]},"DriversLicenseIdentifierPatch":{"allOf":[{"$ref":"#/components/schemas/GovernmentIssuedIdentifierPatch"},{"type":"object","properties":{"jurisdiction":{"$ref":"#/components/schemas/State"},"restrictions":{"type":"array","items":{"type":"string"},"description":"List of license restrictions"}}}]},"DriversLicenseIdentifierResponse":{"allOf":[{"$ref":"#/components/schemas/GovernmentIssuedIdentifierPatch"},{"type":"object","properties":{"jurisdiction":{"$ref":"#/components/schemas/State"},"restrictions":{"type":"array","items":{"type":"string"},"description":"List of license restrictions"}}}]},"SsnIdentifier":{"allOf":[{"$ref":"#/components/schemas/Identifier"},{"type":"object","properties":{"lastFourOnly":{"type":"boolean","description":"Indicates if only the last four digits are provided","example":true}}}]},"SsnIdentifierPatch":{"allOf":[{"$ref":"#/components/schemas/IdentifierPatch"},{"type":"object","properties":{"lastFourOnly":{"type":"boolean","description":"Indicates if only the last four digits are provided","example":true}}}]},"SsnIdentifierResponse":{"allOf":[{"$ref":"#/components/schemas/IdentifierPatch"},{"type":"object","properties":{"lastFourOnly":{"type":"boolean","description":"Indicates if only the last four digits are provided","example":true}}}]},"ItinIdentifier":{"allOf":[{"$ref":"#/components/schemas/Identifier"},{"type":"object","properties":{"issueYear":{"type":"string","pattern":"^\\d{4}$","description":"Year when the ITIN was issued","example":"2015"}}}]},"ItinIdentifierPatch":{"allOf":[{"$ref":"#/components/schemas/IdentifierPatch"},{"type":"object","properties":{"issueYear":{"type":"string","pattern":"^\\d{4}$","description":"Year when the ITIN was issued","example":"2015"}}}]},"ItinIdentifierResponse":{"allOf":[{"$ref":"#/components/schemas/IdentifierPatch"},{"type":"object","properties":{"issueYear":{"type":"string","pattern":"^\\d{4}$","description":"Year when the ITIN was issued","example":"2015"}}}]},"EinIdentifier":{"allOf":[{"$ref":"#/components/schemas/Identifier"},{"type":"object","properties":{"issueYear":{"type":"string","pattern":"^\\d{4}$","description":"Year when the EIN was issued","example":"2015"}}}]},"EinIdentifierPatch":{"allOf":[{"$ref":"#/components/schemas/IdentifierPatch"},{"type":"object","properties":{"issueYear":{"type":"string","pattern":"^\\d{4}$","description":"Year when the EIN was issued","example":"2015"}}}]},"EinIdentifierResponse":{"allOf":[{"$ref":"#/components/schemas/IdentifierPatch"},{"type":"object","properties":{"issueYear":{"type":"string","pattern":"^\\d{4}$","description":"Year when the EIN was issued","example":"2015"}}}]},"AlienRegistrationIdentifier":{"allOf":[{"$ref":"#/components/schemas/GovernmentIssuedIdentifier"},{"type":"object","required":["countryOfOrigin","category"],"properties":{"countryOfOrigin":{"$ref":"#/components/schemas/CountryV2"},"category":{"type":"string","description":"Immigration category or classification","example":"H-1B"}}}]},"AlienRegistrationIdentifierPatch":{"allOf":[{"$ref":"#/components/schemas/GovernmentIssuedIdentifierPatch"},{"type":"object","properties":{"countryOfOrigin":{"$ref":"#/components/schemas/CountryV2"},"category":{"type":"string","description":"Immigration category or classification","example":"H-1B"}}}]},"AlienRegistrationIdentifierResponse":{"allOf":[{"$ref":"#/components/schemas/GovernmentIssuedIdentifierPatch"},{"type":"object","properties":{"countryOfOrigin":{"$ref":"#/components/schemas/CountryV2"},"category":{"type":"string","description":"Immigration category or classification","example":"H-1B"}}}]},"ExternalPartyIdentifier":{"allOf":[{"$ref":"#/components/schemas/ExternalIdentifier"}]},"ExternalPartyIdentifierPatch":{"allOf":[{"$ref":"#/components/schemas/ExternalIdentifierPatch"}]},"ExternalPartyIdentifierResponse":{"allOf":[{"$ref":"#/components/schemas/ExternalIdentifierPatch"}]},"PersonalInformation":{"type":"object","required":["firstName","lastName"],"properties":{"firstName":{"type":"string","example":"John"},"middleName":{"type":"string","example":"M"},"lastName":{"type":"string","example":"Doe"},"suffix":{"type":"string","description":"Suffix for given party if Applicable","example":"Sr"},"prefix":{"type":"string","description":"Prefix for given party if Applicable","example":"Dr"},"dateOfBirth":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","example":"1990-01-01","description":"Date (with pattern \"yyyy-mm-dd\")"},"gender":{"type":"string","enum":["MALE","FEMALE","OTHER"],"example":"MALE"},"birthState":{"$ref":"#/components/schemas/BirthState"},"birthCountry":{"$ref":"#/components/schemas/CountryV2"},"citizenCountry":{"$ref":"#/components/schemas/CountryV2"}}},"PersonalInformationPatch":{"type":"object","properties":{"firstName":{"type":"string","example":"John"},"middleName":{"type":"string","example":"M"},"lastName":{"type":"string","example":"Doe"},"suffix":{"type":"string","description":"Suffix for given party if Applicable","example":"Sr"},"prefix":{"type":"string","description":"Prefix for given party if Applicable","example":"Dr"},"dateOfBirth":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","example":"1990-01-01","description":"Date (with pattern \"yyyy-mm-dd\")"},"gender":{"type":"string","enum":["MALE","FEMALE","OTHER"],"example":"MALE"},"birthState":{"$ref":"#/components/schemas/BirthState"},"birthCountry":{"$ref":"#/components/schemas/CountryV2"},"citizenCountry":{"$ref":"#/components/schemas/CountryV2"}}},"PersonalInformationInsured":{"type":"object","required":["firstName","lastName","dateOfBirth","birthSex","birthCountry"],"properties":{"firstName":{"type":"string","example":"John"},"middleName":{"type":"string","example":"M"},"lastName":{"type":"string","example":"Doe"},"suffix":{"type":"string","enum":["JR","SR","I","II","III","IV","V","VI","VII"],"description":"Suffix for given party if Applicable","example":"SR"},"prefix":{"type":"string","enum":["MR","MS","MISS","DR.","MRS."],"description":"Prefix for given party if Applicable","example":"MR"},"dateOfBirth":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","example":"1990-01-01","description":"Date (with pattern \"yyyy-mm-dd\")"},"gender":{"type":"string","enum":["MALE","FEMALE","UNISEX","OTHER"],"example":"MALE"},"birthSex":{"type":"string","enum":["MALE","FEMALE","UNISEX"],"example":"MALE"},"birthCountry":{"$ref":"#/components/schemas/CountryV2"},"citizenCountry":{"$ref":"#/components/schemas/CountryV2"}}},"PersonalInformationInsuredPatch":{"type":"object","properties":{"firstName":{"type":"string","example":"John"},"middleName":{"type":"string","example":"M"},"lastName":{"type":"string","example":"Doe"},"suffix":{"type":"string","enum":["JR","SR","I","II","III","IV","V","VI","VII"],"description":"Suffix for given party if Applicable","example":"SR"},"prefix":{"type":"string","enum":["MR","MS","MISS","DR.","MRS."],"description":"Prefix for given party if Applicable","example":"MR"},"dateOfBirth":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","example":"1990-01-01","description":"Date (with pattern \"yyyy-mm-dd\")"},"gender":{"type":"string","enum":["MALE","FEMALE","UNISEX","OTHER"],"example":"MALE"},"birthSex":{"type":"string","enum":["MALE","FEMALE","UNISEX"],"example":"MALE"},"birthCountry":{"$ref":"#/components/schemas/CountryV2"},"citizenCountry":{"$ref":"#/components/schemas/CountryV2"}}},"PersonalInformationPrimary":{"type":"object","required":["firstName","lastName"],"properties":{"firstName":{"type":"string","example":"John"},"middleName":{"type":"string","example":"M"},"lastName":{"type":"string","example":"Doe"},"suffix":{"type":"string","enum":["JR","SR","I","II","III","IV","V","VI","VII"],"description":"Suffix for given party if Applicable","example":"SR"},"prefix":{"type":"string","enum":["MR","MS","MISS","DR.","MRS."],"description":"Prefix for given party if Applicable","example":"MR"},"dateOfBirth":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","example":"1990-01-01","description":"Date (with pattern \"yyyy-mm-dd\")"},"gender":{"type":"string","enum":["MALE","FEMALE","UNISEX"],"example":"MALE"},"birthSex":{"type":"string","enum":["MALE","FEMALE","UNISEX"],"example":"MALE"},"birthState":{"$ref":"#/components/schemas/BirthState"},"birthCountry":{"$ref":"#/components/schemas/CountryV2"},"citizenCountry":{"$ref":"#/components/schemas/CountryV2"}}},"PersonalInformationPrimaryPatch":{"type":"object","properties":{"firstName":{"type":"string","example":"John"},"middleName":{"type":"string","example":"M"},"lastName":{"type":"string","example":"Doe"},"suffix":{"type":"string","enum":["JR","SR","I","II","III","IV","V","VI","VII"],"description":"Suffix for given party if Applicable","example":"SR"},"prefix":{"type":"string","enum":["MR","MS","MISS","DR.","MRS."],"description":"Prefix for given party if Applicable","example":"MR"},"dateOfBirth":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","example":"1990-01-01","description":"Date (with pattern \"yyyy-mm-dd\")"},"gender":{"type":"string","enum":["MALE","FEMALE","UNISEX"],"example":"MALE"},"birthSex":{"type":"string","enum":["MALE","FEMALE","UNISEX"],"example":"MALE"},"birthState":{"$ref":"#/components/schemas/BirthState"},"birthCountry":{"$ref":"#/components/schemas/CountryV2"},"citizenCountry":{"$ref":"#/components/schemas/CountryV2"}}},"PersonalInformationPrimaryResponse":{"type":"object","properties":{"firstName":{"type":"string","example":"John"},"middleName":{"type":"string","example":"M"},"lastName":{"type":"string","example":"Doe"},"suffix":{"type":"string","enum":["JR","SR","I","II","III","IV","V","VI","VII"],"description":"Suffix for given party if Applicable","example":"SR"},"prefix":{"type":"string","enum":["MR","MS","MISS","DR.","MRS."],"description":"Prefix for given party if Applicable","example":"MR"},"dateOfBirth":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","example":"1990-01-01","description":"Date (with pattern \"yyyy-mm-dd\")"},"gender":{"type":"string","enum":["MALE","FEMALE","UNISEX"],"example":"MALE"},"birthState":{"$ref":"#/components/schemas/BirthState"},"birthCountry":{"$ref":"#/components/schemas/CountryV2"},"citizenCountry":{"$ref":"#/components/schemas/CountryV2"}}},"PersonalInformationSecondary":{"type":"object","required":["firstName","lastName"],"properties":{"firstName":{"type":"string","example":"John"},"middleName":{"type":"string","example":"M"},"lastName":{"type":"string","example":"Doe"},"suffix":{"type":"string","enum":["JR","SR","I","II","III","IV","V","VI","VII"],"description":"Suffix for given party if Applicable","example":"SR"},"prefix":{"type":"string","enum":["MR","MS","MISS","DR.","MRS."],"description":"Prefix for given party if Applicable","example":"MR"},"dateOfBirth":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","example":"1990-01-01","description":"Date (with pattern \"yyyy-mm-dd\")"},"gender":{"type":"string","enum":["MALE","FEMALE","UNISEX"],"example":"MALE"},"birthState":{"$ref":"#/components/schemas/BirthState"},"birthCountry":{"$ref":"#/components/schemas/CountryV2"},"citizenCountry":{"$ref":"#/components/schemas/CountryV2"}}},"PersonalInformationSecondaryPatch":{"type":"object","properties":{"firstName":{"type":"string","example":"John"},"middleName":{"type":"string","example":"M"},"lastName":{"type":"string","example":"Doe"},"suffix":{"type":"string","enum":["JR","SR","I","II","III","IV","V","VI","VII"],"description":"Suffix for given party if Applicable","example":"SR"},"prefix":{"type":"string","enum":["MR","MS","MISS","DR.","MRS."],"description":"Prefix for given party if Applicable","example":"MR"},"dateOfBirth":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","example":"1990-01-01","description":"Date (with pattern \"yyyy-mm-dd\")"},"gender":{"type":"string","enum":["MALE","FEMALE","UNISEX"],"example":"MALE"},"birthState":{"$ref":"#/components/schemas/BirthState"},"birthCountry":{"$ref":"#/components/schemas/CountryV2"},"citizenCountry":{"$ref":"#/components/schemas/CountryV2"}}},"PersonalInformationPayee":{"type":"object","required":["firstName","lastName"],"properties":{"firstName":{"type":"string","example":"John"},"middleName":{"type":"string","example":"M"},"lastName":{"type":"string","example":"Doe"},"suffix":{"type":"string","enum":["JR","SR","I","II","III","IV","V","VI","VII"],"description":"Suffix for given party if Applicable","example":"SR"},"prefix":{"type":"string","enum":["MR","MS","MISS","DR.","MRS."],"description":"Prefix for given party if Applicable","example":"MR"},"dateOfBirth":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","example":"1990-01-01","description":"Date (with pattern \"yyyy-mm-dd\")"},"gender":{"type":"string","enum":["MALE","FEMALE","UNISEX","OTHER"],"example":"MALE"},"birthSex":{"type":"string","enum":["MALE","FEMALE","UNISEX"],"example":"MALE"},"birthState":{"$ref":"#/components/schemas/BirthState"},"birthCountry":{"$ref":"#/components/schemas/CountryV2"},"citizenCountry":{"$ref":"#/components/schemas/CountryV2"}}},"PersonalInformationPayeePatch":{"type":"object","properties":{"firstName":{"type":"string","example":"John"},"middleName":{"type":"string","example":"M"},"lastName":{"type":"string","example":"Doe"},"suffix":{"type":"string","enum":["JR","SR","I","II","III","IV","V","VI","VII"],"description":"Suffix for given party if Applicable","example":"SR"},"prefix":{"type":"string","enum":["MR","MS","MISS","DR.","MRS."],"description":"Prefix for given party if Applicable","example":"MR"},"dateOfBirth":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","example":"1990-01-01","description":"Date (with pattern \"yyyy-mm-dd\")"},"gender":{"type":"string","enum":["MALE","FEMALE","UNISEX","OTHER"],"example":"MALE"},"birthSex":{"type":"string","enum":["MALE","FEMALE","UNISEX"],"example":"MALE"},"birthState":{"$ref":"#/components/schemas/BirthState"},"birthCountry":{"$ref":"#/components/schemas/CountryV2"},"citizenCountry":{"$ref":"#/components/schemas/CountryV2"}}},"PersonalInformationPayor":{"type":"object","required":["firstName","lastName"],"properties":{"firstName":{"type":"string","example":"John"},"middleName":{"type":"string","example":"M"},"lastName":{"type":"string","example":"Doe"},"suffix":{"type":"string","enum":["JR","SR","I","II","III","IV","V","VI","VII"],"description":"Suffix for given party if Applicable","example":"SR"},"prefix":{"type":"string","enum":["MR","MS","MISS","DR.","MRS."],"description":"Prefix for given party if Applicable","example":"MR"},"dateOfBirth":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","example":"1990-01-01","description":"Date (with pattern \"yyyy-mm-dd\")"},"birthSex":{"type":"string","enum":["MALE","FEMALE","UNISEX"],"example":"MALE"},"gender":{"type":"string","enum":["MALE","FEMALE","UNISEX","OTHER"],"example":"MALE"},"birthState":{"$ref":"#/components/schemas/BirthState"},"birthCountry":{"$ref":"#/components/schemas/CountryV2"},"citizenCountry":{"$ref":"#/components/schemas/CountryV2"}}},"PersonalInformationPayorPatch":{"type":"object","properties":{"firstName":{"type":"string","example":"John"},"middleName":{"type":"string","example":"M"},"lastName":{"type":"string","example":"Doe"},"suffix":{"type":"string","enum":["JR","SR","I","II","III","IV","V","VI","VII"],"description":"Suffix for given party if Applicable","example":"SR"},"prefix":{"type":"string","enum":["MR","MS","MISS","DR.","MRS."],"description":"Prefix for given party if Applicable","example":"MR"},"dateOfBirth":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","example":"1990-01-01","description":"Date (with pattern \"yyyy-mm-dd\")"},"gender":{"type":"string","enum":["MALE","FEMALE","UNISEX","OTHER"],"example":"MALE"},"birthSex":{"type":"string","enum":["MALE","FEMALE","UNISEX"],"example":"MALE"},"birthState":{"$ref":"#/components/schemas/BirthState"},"birthCountry":{"$ref":"#/components/schemas/CountryV2"},"citizenCountry":{"$ref":"#/components/schemas/CountryV2"}}},"PersonalInformationThirdParty":{"type":"object","required":["firstName","lastName"],"properties":{"firstName":{"type":"string","example":"John"},"middleName":{"type":"string","example":"M"},"lastName":{"type":"string","example":"Doe"},"suffix":{"type":"string","enum":["JR","SR","I","II","III","IV","V","VI","VII"],"description":"Suffix for given party if Applicable","example":"SR"},"prefix":{"type":"string","enum":["MR","MS","MISS","DR.","MRS."],"description":"Prefix for given party if Applicable","example":"MR"},"dateOfBirth":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","example":"1990-01-01","description":"Date (with pattern \"yyyy-mm-dd\")"},"gender":{"type":"string","enum":["MALE","FEMALE","UNISEX","OTHER"],"example":"MALE"},"birthSex":{"type":"string","enum":["MALE","FEMALE","UNISEX"],"example":"MALE"},"birthState":{"$ref":"#/components/schemas/BirthState"},"birthCountry":{"$ref":"#/components/schemas/CountryV2"},"citizenCountry":{"$ref":"#/components/schemas/CountryV2"}}},"PersonalInformationThirdPartyPatch":{"type":"object","properties":{"firstName":{"type":"string","example":"John"},"middleName":{"type":"string","example":"M"},"lastName":{"type":"string","example":"Doe"},"suffix":{"type":"string","enum":["JR","SR","I","II","III","IV","V","VI","VII"],"description":"Suffix for given party if Applicable","example":"SR"},"prefix":{"type":"string","enum":["MR","MS","MISS","DR.","MRS."],"description":"Prefix for given party if Applicable","example":"MR"},"dateOfBirth":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","example":"1990-01-01","description":"Date (with pattern \"yyyy-mm-dd\")"},"gender":{"type":"string","enum":["MALE","FEMALE","UNISEX","OTHER"],"example":"MALE"},"birthSex":{"type":"string","enum":["MALE","FEMALE","UNISEX"],"example":"MALE"},"birthState":{"$ref":"#/components/schemas/BirthState"},"birthCountry":{"$ref":"#/components/schemas/CountryV2"},"citizenCountry":{"$ref":"#/components/schemas/CountryV2"}}},"PersonalInformationThirdPartyResponse":{"type":"object","properties":{"firstName":{"type":"string","example":"John"},"middleName":{"type":"string","example":"M"},"lastName":{"type":"string","example":"Doe"},"suffix":{"type":"string","enum":["JR","SR","I","II","III","IV","V","VI","VII"],"description":"Suffix for given party if Applicable","example":"SR"},"prefix":{"type":"string","enum":["MR","MS","MISS","DR.","MRS."],"description":"Prefix for given party if Applicable","example":"MR"},"dateOfBirth":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","example":"1990-01-01","description":"Date (with pattern \"yyyy-mm-dd\")"},"gender":{"type":"string","enum":["MALE","FEMALE","UNISEX"],"example":"MALE"},"birthState":{"$ref":"#/components/schemas/BirthState"},"birthCountry":{"$ref":"#/components/schemas/CountryV2"},"citizenCountry":{"$ref":"#/components/schemas/CountryV2"}}},"PersonalInformationSecondaryAddressee":{"type":"object","required":["firstName","lastName"],"properties":{"firstName":{"type":"string","example":"John"},"middleName":{"type":"string","example":"M"},"lastName":{"type":"string","example":"Doe"},"suffix":{"type":"string","enum":["JR","SR","I","II","III","IV","V","VI","VII"],"description":"Suffix for given party if Applicable","example":"SR"},"prefix":{"type":"string","enum":["MR","MS","MISS","DR.","MRS."],"description":"Prefix for given party if Applicable","example":"MR"},"dateOfBirth":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","example":"1990-01-01","description":"Date (with pattern \"yyyy-mm-dd\")"},"gender":{"type":"string","enum":["MALE","FEMALE","UNISEX"],"example":"MALE"},"birthState":{"$ref":"#/components/schemas/BirthState"},"birthCountry":{"$ref":"#/components/schemas/CountryV2"},"citizenCountry":{"$ref":"#/components/schemas/CountryV2"}}},"PersonalInformationSecondaryAddresseePatch":{"type":"object","properties":{"firstName":{"type":"string","example":"John"},"middleName":{"type":"string","example":"M"},"lastName":{"type":"string","example":"Doe"},"suffix":{"type":"string","enum":["JR","SR","I","II","III","IV","V","VI","VII"],"description":"Suffix for given party if Applicable","example":"SR"},"prefix":{"type":"string","enum":["MR","MS","MISS","DR.","MRS."],"description":"Prefix for given party if Applicable","example":"MR"},"dateOfBirth":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","example":"1990-01-01","description":"Date (with pattern \"yyyy-mm-dd\")"},"gender":{"type":"string","enum":["MALE","FEMALE","UNISEX"],"example":"MALE"},"birthState":{"$ref":"#/components/schemas/BirthState"},"birthCountry":{"$ref":"#/components/schemas/CountryV2"},"citizenCountry":{"$ref":"#/components/schemas/CountryV2"}}},"PersonalInformationSecondaryAddresseeResponse":{"type":"object","properties":{"firstName":{"type":"string","example":"John"},"middleName":{"type":"string","example":"M"},"lastName":{"type":"string","example":"Doe"},"suffix":{"type":"string","enum":["JR","SR","I","II","III","IV","V","VI","VII"],"description":"Suffix for given party if Applicable","example":"SR"},"prefix":{"type":"string","enum":["MR","MS","MISS","DR.","MRS."],"description":"Prefix for given party if Applicable","example":"MR"},"dateOfBirth":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","example":"1990-01-01","description":"Date (with pattern \"yyyy-mm-dd\")"},"gender":{"type":"string","enum":["MALE","FEMALE","UNISEX"],"example":"MALE"},"birthState":{"$ref":"#/components/schemas/BirthState"},"birthCountry":{"$ref":"#/components/schemas/CountryV2"},"citizenCountry":{"$ref":"#/components/schemas/CountryV2"}}},"PersonalInformationOwner":{"type":"object","required":["firstName","lastName","dateOfBirth","birthSex","birthCountry"],"properties":{"firstName":{"type":"string","example":"John"},"middleName":{"type":"string","example":"M"},"lastName":{"type":"string","example":"Doe"},"suffix":{"type":"string","enum":["JR","SR","I","II","III","IV","V","VI","VII"],"description":"Suffix for given party if Applicable","example":"SR"},"prefix":{"type":"string","enum":["MR","MS","MISS","DR.","MRS."],"description":"Prefix for given party if Applicable","example":"MR"},"dateOfBirth":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","example":"1990-01-01","description":"Date (with pattern \"yyyy-mm-dd\")"},"gender":{"type":"string","enum":["MALE","FEMALE","UNISEX","OTHER"],"example":"MALE"},"birthSex":{"type":"string","enum":["MALE","FEMALE","UNISEX"],"example":"MALE"},"birthState":{"$ref":"#/components/schemas/BirthState"},"birthCountry":{"$ref":"#/components/schemas/CountryV2"},"citizenCountry":{"$ref":"#/components/schemas/CountryV2"}}},"PersonalInformationOwnerPatch":{"type":"object","properties":{"firstName":{"type":"string","example":"John"},"middleName":{"type":"string","example":"M"},"lastName":{"type":"string","example":"Doe"},"suffix":{"type":"string","enum":["JR","SR","I","II","III","IV","V","VI","VII"],"description":"Suffix for given party if Applicable","example":"SR"},"prefix":{"type":"string","enum":["MR","MS","MISS","DR.","MRS."],"description":"Prefix for given party if Applicable","example":"MR"},"dateOfBirth":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","example":"1990-01-01","description":"Date (with pattern \"yyyy-mm-dd\")"},"birthSex":{"type":"string","enum":["MALE","FEMALE","UNISEX"],"example":"MALE"},"gender":{"type":"string","enum":["MALE","FEMALE","UNISEX","OTHER"],"example":"MALE"},"birthState":{"$ref":"#/components/schemas/BirthState"},"birthCountry":{"$ref":"#/components/schemas/CountryV2"},"citizenCountry":{"$ref":"#/components/schemas/CountryV2"}}},"PersonalInformationOwnerResponse":{"type":"object","properties":{"firstName":{"type":"string","example":"John"},"middleName":{"type":"string","example":"M"},"lastName":{"type":"string","example":"Doe"},"suffix":{"type":"string","enum":["JR","SR","I","II","III","IV","V","VI","VII"],"description":"Suffix for given party if Applicable","example":"SR"},"prefix":{"type":"string","enum":["MR","MS","MISS","DR.","MRS."],"description":"Prefix for given party if Applicable","example":"MR"},"dateOfBirth":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","example":"1990-01-01","description":"Date (with pattern \"yyyy-mm-dd\")"},"gender":{"type":"string","enum":["MALE","FEMALE","UNISEX"],"example":"MALE"},"birthState":{"$ref":"#/components/schemas/BirthState"},"birthCountry":{"$ref":"#/components/schemas/CountryV2"},"citizenCountry":{"$ref":"#/components/schemas/CountryV2"}}},"PersonalInformationGrantor":{"type":"object","required":["firstName","lastName"],"properties":{"firstName":{"type":"string","example":"John"},"middleName":{"type":"string","example":"M"},"lastName":{"type":"string","example":"Doe"},"suffix":{"type":"string","enum":["JR","SR","I","II","III","IV","V","VI","VII"],"description":"Suffix for given party if Applicable","example":"SR"},"prefix":{"type":"string","enum":["MR","MS","MISS","DR.","MRS."],"description":"Prefix for given party if Applicable","example":"MR"},"dateOfBirth":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","example":"1990-01-01","description":"Date (with pattern \"yyyy-mm-dd\")"},"gender":{"type":"string","enum":["MALE","FEMALE","UNISEX","OTHER"],"example":"MALE"},"birthSex":{"type":"string","enum":["MALE","FEMALE","UNISEX"],"example":"MALE"},"birthState":{"$ref":"#/components/schemas/BirthState"},"birthCountry":{"$ref":"#/components/schemas/CountryV2"},"citizenCountry":{"$ref":"#/components/schemas/CountryV2"}}},"PersonalInformationGrantorPatch":{"type":"object","properties":{"firstName":{"type":"string","example":"John"},"middleName":{"type":"string","example":"M"},"lastName":{"type":"string","example":"Doe"},"suffix":{"type":"string","enum":["JR","SR","I","II","III","IV","V","VI","VII"],"description":"Suffix for given party if Applicable","example":"SR"},"prefix":{"type":"string","enum":["MR","MS","MISS","DR.","MRS."],"description":"Prefix for given party if Applicable","example":"MR"},"dateOfBirth":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","example":"1990-01-01","description":"Date (with pattern \"yyyy-mm-dd\")"},"gender":{"type":"string","enum":["MALE","FEMALE","UNISEX","OTHER"],"example":"MALE"},"birthSex":{"type":"string","enum":["MALE","FEMALE","UNISEX"],"example":"MALE"},"birthState":{"$ref":"#/components/schemas/BirthState"},"birthCountry":{"$ref":"#/components/schemas/CountryV2"},"citizenCountry":{"$ref":"#/components/schemas/CountryV2"}}},"PersonalInformationAuthorizedSigner":{"type":"object","required":["firstName","lastName"],"properties":{"firstName":{"type":"string","example":"John"},"middleName":{"type":"string","example":"M"},"lastName":{"type":"string","example":"Doe"},"suffix":{"type":"string","enum":["JR","SR","I","II","III","IV","V","VI","VII"],"description":"Suffix for given party if Applicable","example":"SR"},"prefix":{"type":"string","enum":["MR","MS","MISS","DR.","MRS."],"description":"Prefix for given party if Applicable","example":"MR"},"dateOfBirth":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","example":"1990-01-01","description":"Date (with pattern \"yyyy-mm-dd\")"},"gender":{"type":"string","enum":["MALE","FEMALE","UNISEX","OTHER"],"example":"MALE"},"birthSex":{"type":"string","enum":["MALE","FEMALE","UNISEX"],"example":"MALE"},"birthState":{"$ref":"#/components/schemas/BirthState"},"birthCountry":{"$ref":"#/components/schemas/CountryV2"},"citizenCountry":{"$ref":"#/components/schemas/CountryV2"}}},"PersonalInformationAuthorizedSignerPatch":{"type":"object","properties":{"firstName":{"type":"string","example":"John"},"middleName":{"type":"string","example":"M"},"lastName":{"type":"string","example":"Doe"},"suffix":{"type":"string","enum":["JR","SR","I","II","III","IV","V","VI","VII"],"description":"Suffix for given party if Applicable","example":"SR"},"prefix":{"type":"string","enum":["MR","MS","MISS","DR.","MRS."],"description":"Prefix for given party if Applicable","example":"MR"},"dateOfBirth":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","example":"1990-01-01","description":"Date (with pattern \"yyyy-mm-dd\")"},"gender":{"type":"string","enum":["MALE","FEMALE","UNISEX","OTHER"],"example":"MALE"},"birthSex":{"type":"string","enum":["MALE","FEMALE","UNISEX"],"example":"MALE"},"birthState":{"$ref":"#/components/schemas/BirthState"},"birthCountry":{"$ref":"#/components/schemas/CountryV2"},"citizenCountry":{"$ref":"#/components/schemas/CountryV2"}}},"PersonalInformationSuccessorOwner":{"type":"object","required":["firstName","lastName","dateOfBirth","birthSex","birthCountry"],"properties":{"firstName":{"type":"string","example":"John"},"middleName":{"type":"string","example":"M"},"lastName":{"type":"string","example":"Doe"},"suffix":{"type":"string","enum":["JR","SR","I","II","III","IV","V","VI","VII"],"description":"Suffix for given party if Applicable","example":"SR"},"prefix":{"type":"string","enum":["MR","MS","MISS","DR.","MRS."],"description":"Prefix for given party if Applicable","example":"MR"},"dateOfBirth":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","example":"1990-01-01","description":"Date (with pattern \"yyyy-mm-dd\")"},"gender":{"type":"string","enum":["MALE","FEMALE","UNISEX","OTHER"],"example":"MALE"},"birthSex":{"type":"string","enum":["MALE","FEMALE","UNISEX"],"example":"MALE"},"birthState":{"$ref":"#/components/schemas/BirthState"},"birthCountry":{"$ref":"#/components/schemas/CountryV2"},"citizenCountry":{"$ref":"#/components/schemas/CountryV2"}}},"PersonalInformationSuccessorOwnerPatch":{"type":"object","properties":{"firstName":{"type":"string","example":"John"},"middleName":{"type":"string","example":"M"},"lastName":{"type":"string","example":"Doe"},"suffix":{"type":"string","enum":["JR","SR","I","II","III","IV","V","VI","VII"],"description":"Suffix for given party if Applicable","example":"SR"},"prefix":{"type":"string","enum":["MR","MS","MISS","DR.","MRS."],"description":"Prefix for given party if Applicable","example":"MR"},"dateOfBirth":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","example":"1990-01-01","description":"Date (with pattern \"yyyy-mm-dd\")"},"gender":{"type":"string","enum":["MALE","FEMALE","UNISEX","OTHER"],"example":"MALE"},"birthSex":{"type":"string","enum":["MALE","FEMALE","UNISEX"],"example":"MALE"},"birthState":{"$ref":"#/components/schemas/BirthState"},"birthCountry":{"$ref":"#/components/schemas/CountryV2"},"citizenCountry":{"$ref":"#/components/schemas/CountryV2"}}},"PersonalInformationTrustee":{"type":"object","required":["firstName","lastName"],"properties":{"firstName":{"type":"string","example":"John"},"middleName":{"type":"string","example":"M"},"lastName":{"type":"string","example":"Doe"},"suffix":{"type":"string","enum":["JR","SR","I","II","III","IV","V","VI","VII"],"description":"Suffix for given party if Applicable","example":"SR"},"prefix":{"type":"string","enum":["MR","MS","MISS","DR.","MRS."],"description":"Prefix for given party if Applicable","example":"MR"},"dateOfBirth":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","example":"1990-01-01","description":"Date (with pattern \"yyyy-mm-dd\")"},"gender":{"type":"string","enum":["MALE","FEMALE","UNISEX","OTHER"],"example":"MALE"},"birthSex":{"type":"string","enum":["MALE","FEMALE","UNISEX"],"example":"MALE"},"birthState":{"$ref":"#/components/schemas/BirthState"},"birthCountry":{"$ref":"#/components/schemas/CountryV2"},"citizenCountry":{"$ref":"#/components/schemas/CountryV2"}}},"PersonalInformationTrusteePatch":{"type":"object","properties":{"firstName":{"type":"string","example":"John"},"middleName":{"type":"string","example":"M"},"lastName":{"type":"string","example":"Doe"},"suffix":{"type":"string","enum":["JR","SR","I","II","III","IV","V","VI","VII"],"description":"Suffix for given party if Applicable","example":"SR"},"prefix":{"type":"string","enum":["MR","MS","MISS","DR.","MRS."],"description":"Prefix for given party if Applicable","example":"MR"},"dateOfBirth":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","example":"1990-01-01","description":"Date (with pattern \"yyyy-mm-dd\")"},"gender":{"type":"string","enum":["MALE","FEMALE","UNISEX","OTHER"],"example":"MALE"},"birthSex":{"type":"string","enum":["MALE","FEMALE","UNISEX"],"example":"MALE"},"birthState":{"$ref":"#/components/schemas/BirthState"},"birthCountry":{"$ref":"#/components/schemas/CountryV2"},"citizenCountry":{"$ref":"#/components/schemas/CountryV2"}}},"PersonalInformationCoverageInsured":{"type":"object","required":["firstName","lastName","dateOfBirth","birthSex"],"properties":{"firstName":{"type":"string","example":"John"},"middleName":{"type":"string","example":"M"},"lastName":{"type":"string","example":"Doe"},"suffix":{"type":"string","enum":["JR","SR","I","II","III","IV","V","VI","VII"],"description":"Suffix for given party if Applicable","example":"SR"},"prefix":{"type":"string","enum":["MR","MS","MISS","DR.","MRS."],"description":"Prefix for given party if Applicable","example":"MR"},"dateOfBirth":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","example":"1990-01-01","description":"Date (with pattern \"yyyy-mm-dd\")"},"birthSex":{"type":"string","enum":["MALE","FEMALE","UNISEX"],"example":"MALE"},"gender":{"type":"string","enum":["MALE","FEMALE","UNISEX","OTHER"],"example":"MALE"},"birthState":{"$ref":"#/components/schemas/BirthState"},"birthCountry":{"$ref":"#/components/schemas/CountryV2"},"citizenCountry":{"$ref":"#/components/schemas/CountryV2"}}},"PersonalInformationCoverageInsuredPatch":{"type":"object","properties":{"firstName":{"type":"string","example":"John"},"middleName":{"type":"string","example":"M"},"lastName":{"type":"string","example":"Doe"},"suffix":{"type":"string","enum":["JR","SR","I","II","III"],"description":"Suffix for given party if Applicable","example":"SR"},"prefix":{"type":"string","enum":["MR","MS","MISS","DR.","MRS."],"description":"Prefix for given party if Applicable","example":"MR"},"dateOfBirth":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","example":"1990-01-01","description":"Date (with pattern \"yyyy-mm-dd\")"},"birthSex":{"type":"string","enum":["MALE","FEMALE","UNISEX"],"example":"MALE"},"gender":{"type":"string","enum":["MALE","FEMALE","UNISEX","OTHER"],"example":"MALE"},"birthState":{"$ref":"#/components/schemas/BirthState"},"birthCountry":{"$ref":"#/components/schemas/CountryV2"},"citizenCountry":{"$ref":"#/components/schemas/CountryV2"}}},"PersonalInformationAgent":{"type":"object","required":["firstName","lastName"],"properties":{"firstName":{"type":"string","example":"John"},"middleName":{"type":"string","example":"M"},"lastName":{"type":"string","example":"Doe"},"suffix":{"type":"string","enum":["JR","SR","I","II","III","IV","V","VI","VII"],"description":"Suffix for given party if Applicable","example":"SR"},"prefix":{"type":"string","enum":["MR","MS","MISS","DR.","MRS."],"description":"Prefix for given party if Applicable","example":"MR"},"dateOfBirth":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","example":"1990-01-01","description":"Date (with pattern \"yyyy-mm-dd\")"},"gender":{"type":"string","enum":["MALE","FEMALE","UNISEX","OTHER"],"example":"MALE"},"birthSex":{"type":"string","enum":["MALE","FEMALE","UNISEX"],"example":"MALE"},"birthState":{"$ref":"#/components/schemas/BirthState"},"birthCountry":{"$ref":"#/components/schemas/CountryV2"},"citizenCountry":{"$ref":"#/components/schemas/CountryV2"}}},"PersonalInformationAgentPatch":{"type":"object","properties":{"firstName":{"type":"string","example":"John"},"middleName":{"type":"string","example":"M"},"lastName":{"type":"string","example":"Doe"},"suffix":{"type":"string","enum":["JR","SR","I","II","III","IV","V","VI","VII"],"description":"Suffix for given party if Applicable","example":"SR"},"prefix":{"type":"string","enum":["MR","MS","MISS","DR.","MRS."],"description":"Prefix for given party if Applicable","example":"MR"},"dateOfBirth":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","example":"1990-01-01","description":"Date (with pattern \"yyyy-mm-dd\")"},"gender":{"type":"string","enum":["MALE","FEMALE","UNISEX","OTHER"],"example":"MALE"},"birthSex":{"type":"string","enum":["MALE","FEMALE","UNISEX"],"example":"MALE"},"birthState":{"$ref":"#/components/schemas/BirthState"},"birthCountry":{"$ref":"#/components/schemas/CountryV2"},"citizenCountry":{"$ref":"#/components/schemas/CountryV2"}}},"PersonalInformationAgentResponse":{"type":"object","properties":{"firstName":{"type":"string","example":"John"},"middleName":{"type":"string","example":"M"},"lastName":{"type":"string","example":"Doe"},"suffix":{"type":"string","enum":["JR","SR","I","II","III","IV","V","VI","VII"],"description":"Suffix for given party if Applicable","example":"SR"},"prefix":{"type":"string","enum":["MR","MS","MISS","DR.","MRS."],"description":"Prefix for given party if Applicable","example":"MR"},"dateOfBirth":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","example":"1990-01-01","description":"Date (with pattern \"yyyy-mm-dd\")"},"gender":{"type":"string","enum":["MALE","FEMALE","UNISEX"],"example":"MALE"},"birthState":{"$ref":"#/components/schemas/BirthState"},"birthCountry":{"$ref":"#/components/schemas/CountryV2"},"citizenCountry":{"$ref":"#/components/schemas/CountryV2"}}},"PersonalInformationChild":{"allOf":[{"$ref":"#/components/schemas/PersonalInformation"}],"required":["firstName","lastName","dateOfBirth","gender","birthCountry"],"properties":{"dateOfBirth":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","example":"1990-01-01","description":"Date (with pattern \"yyyy-mm-dd\")"},"gender":{"type":"string","enum":["MALE","FEMALE","OTHER"]}}},"PersonalInformationChildPatch":{"allOf":[{"$ref":"#/components/schemas/PersonalInformationPatch"}],"properties":{"dateOfBirth":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","example":"1990-01-01","description":"Date (with pattern \"yyyy-mm-dd\")"},"gender":{"type":"string","enum":["MALE","FEMALE","OTHER"],"example":"MALE"}}},"PersonalInformationChildResponse":{"allOf":[{"$ref":"#/components/schemas/PersonalInformationPatch"}],"properties":{"dateOfBirth":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","example":"1990-01-01","description":"Date (with pattern \"yyyy-mm-dd\")"},"gender":{"type":"string","enum":["MALE","FEMALE","OTHER"],"example":"MALE"}}},"PersonalInformationOtherInterestedParty":{"type":"object","required":["firstName","lastName"],"properties":{"firstName":{"type":"string","example":"John"},"middleName":{"type":"string","example":"M"},"lastName":{"type":"string","example":"Doe"},"suffix":{"type":"string","enum":["JR","SR","I","II","III","IV","V","VI","VII"],"description":"Suffix for given party if Applicable","example":"SR"},"prefix":{"type":"string","enum":["MR","MS","MISS","DR.","MRS."],"description":"Prefix for given party if Applicable","example":"MR"},"dateOfBirth":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","example":"1990-01-01","description":"Date (with pattern \"yyyy-mm-dd\")"},"gender":{"type":"string","enum":["MALE","FEMALE","UNISEX","OTHER"],"example":"MALE"},"birthSex":{"type":"string","enum":["MALE","FEMALE","UNISEX"],"example":"MALE"},"birthState":{"$ref":"#/components/schemas/BirthState"},"birthCountry":{"$ref":"#/components/schemas/CountryV2"},"citizenCountry":{"$ref":"#/components/schemas/CountryV2"}}},"PersonalInformationOtherInterestedPartyPatch":{"type":"object","properties":{"firstName":{"type":"string","example":"John"},"middleName":{"type":"string","example":"M"},"lastName":{"type":"string","example":"Doe"},"suffix":{"type":"string","enum":["JR","SR","I","II","III","IV","V","VI","VII"],"description":"Suffix for given party if Applicable","example":"SR"},"prefix":{"type":"string","enum":["MR","MS","MISS","DR.","MRS."],"description":"Prefix for given party if Applicable","example":"MR"},"dateOfBirth":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","example":"1990-01-01","description":"Date (with pattern \"yyyy-mm-dd\")"},"gender":{"type":"string","enum":["MALE","FEMALE","UNISEX","OTHER"],"example":"MALE"},"birthSex":{"type":"string","enum":["MALE","FEMALE","UNISEX"],"example":"MALE"},"birthState":{"$ref":"#/components/schemas/BirthState"},"birthCountry":{"$ref":"#/components/schemas/CountryV2"},"citizenCountry":{"$ref":"#/components/schemas/CountryV2"}}},"PersonalInformationOtherInterestedPartyResponse":{"type":"object","properties":{"firstName":{"type":"string","example":"John"},"middleName":{"type":"string","example":"M"},"lastName":{"type":"string","example":"Doe"},"suffix":{"type":"string","enum":["JR","SR","I","II","III","IV","V","VI","VII"],"description":"Suffix for given party if Applicable","example":"SR"},"prefix":{"type":"string","enum":["MR","MS","MISS","DR.","MRS."],"description":"Prefix for given party if Applicable","example":"MR"},"dateOfBirth":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","example":"1990-01-01","description":"Date (with pattern \"yyyy-mm-dd\")"},"gender":{"type":"string","enum":["MALE","FEMALE","UNISEX"],"example":"MALE"},"birthState":{"$ref":"#/components/schemas/BirthState"},"birthCountry":{"$ref":"#/components/schemas/CountryV2"},"citizenCountry":{"$ref":"#/components/schemas/CountryV2"}}},"Address":{"required":["id","addressType","addressLine1","city","state","zipCode","country"],"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the address","example":"123e4567-e89b-12d3-a456-426614174000"},"addressType":{"type":"string","enum":["RESIDENCE","BUSINESS","POBOX","SEASONAL","SECONDARY","MAILING"],"description":"Type of address","example":"RESIDENCE"},"addressLine1":{"type":"string","description":"Primary address line","example":"123 Main St"},"addressLine2":{"type":"string","description":"Secondary address line (optional)","example":"Apt 4B"},"addressLine3":{"type":"string","description":"Secondary address line (optional)","example":"suite 123"},"city":{"type":"string","description":"City name","example":"San Francisco"},"state":{"$ref":"#/components/schemas/State"},"zipCode":{"type":"string","pattern":"^\\d{5}?$","description":"ZIP code (5 digits)","example":"94105"},"zipCodeExt":{"type":"string","description":"ZIP code extension","example":"4465"},"country":{"type":"string","description":"Country Code","enum":["US"]}}},"AddressPatch":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the address","example":"123e4567-e89b-12d3-a456-426614174000"},"addressType":{"type":"string","enum":["RESIDENCE","BUSINESS","POBOX","SEASONAL","SECONDARY","MAILING"],"description":"Type of address","example":"RESIDENCE"},"addressLine1":{"type":"string","description":"Primary address line","example":"123 Main St"},"addressLine2":{"type":"string","description":"Secondary address line (optional)","example":"Apt 4B"},"addressLine3":{"type":"string","description":"Secondary address line (optional)","example":"suite 123"},"city":{"type":"string","description":"City name","example":"San Francisco"},"state":{"$ref":"#/components/schemas/State"},"zipCode":{"type":"string","pattern":"^\\d{5}?$","description":"ZIP code (5 digits)","example":"94105"},"zipCodeExt":{"type":"string","description":"ZIP code extension","example":"4465"},"country":{"type":"string","description":"Country Code","enum":["US"]}}},"AddressDetail":{"type":"object","properties":{"addressType":{"type":"string","enum":["RESIDENCE","BUSINESS","POBOX","SEASONAL","SECONDARY","MAILING"],"description":"Type of address","example":"RESIDENCE"},"addressLine1":{"type":"string","description":"Primary address line","example":"123 Main St"},"addressLine2":{"type":"string","description":"Secondary address line (optional)","example":"Apt 4B"},"addressLine3":{"type":"string","description":"Secondary address line (optional)","example":"suite 123"},"city":{"type":"string","description":"City name","example":"San Francisco"},"state":{"$ref":"#/components/schemas/State"},"zipCode":{"type":"string","pattern":"^\\d{5}?$","description":"ZIP code (5 digits)","example":"94105"},"zipCodeExt":{"type":"string","description":"ZIP code extension","example":"4465"},"country":{"type":"string","description":"Country Code","enum":["US"]}}},"InsuranceHistoryAddressDetail":{"required":["addressType","addressLine1","city","state","zipCode","country"],"type":"object","properties":{"addressType":{"type":"string","enum":["RESIDENCE","BUSINESS","POBOX","SEASONAL","SECONDARY","MAILING"],"description":"Type of address","example":"RESIDENCE"},"addressLine1":{"type":"string","description":"Primary address line","example":"123 Main St"},"addressLine2":{"type":"string","description":"Secondary address line (optional)","example":"Apt 4B"},"addressLine3":{"type":"string","description":"Secondary address line (optional)","example":"suite 123"},"city":{"type":"string","description":"City name","example":"San Francisco"},"state":{"$ref":"#/components/schemas/State"},"zipCode":{"type":"string","pattern":"^\\d{5}?$","description":"ZIP code (5 digits)","example":"94105"},"zipCodeExt":{"type":"string","description":"ZIP code extension","example":"4465"},"country":{"type":"string","description":"Country Code","enum":["US"]}}},"PaymentAddress":{"type":"object","properties":{"addressType":{"type":"string","enum":["RESIDENCE","BUSINESS","POBOX","SEASONAL","SECONDARY","MAILING"],"description":"Type of address","example":"RESIDENCE"},"addressLine1":{"type":"string","description":"Primary address line","example":"123 Main St"},"addressLine2":{"type":"string","description":"Secondary address line (optional)","example":"Apt 4B"},"addressLine3":{"type":"string","description":"Third address line (optional)","example":"Apt 4B"},"city":{"type":"string","description":"City name","example":"San Francisco"},"state":{"$ref":"#/components/schemas/State"},"zipCode":{"type":"string","pattern":"^\\d{5}?$","description":"ZIP code (5 digits)","example":"94105"},"zipCodeExt":{"type":"string","description":"ZIP code extension","example":"4465"},"country":{"$ref":"#/components/schemas/CountryV2"}}},"PaymentAddressPatch":{"type":"object","properties":{"addressType":{"type":"string","enum":["RESIDENCE","BUSINESS","POBOX","SEASONAL","SECONDARY","MAILING"],"description":"Type of address","example":"RESIDENCE"},"addressLine1":{"type":"string","description":"Primary address line","example":"123 Main St"},"addressLine2":{"type":"string","description":"Secondary address line (optional)","example":"Apt 4B"},"addressLine3":{"type":"string","description":"Third address line (optional)","example":"Apt 4B"},"city":{"type":"string","description":"City name","example":"San Francisco"},"state":{"$ref":"#/components/schemas/State"},"zipCode":{"type":"string","pattern":"^\\d{5}?$","description":"ZIP code (5 digits)","example":"94105"},"zipCodeExt":{"type":"string","description":"ZIP code extension","example":"4465"},"country":{"$ref":"#/components/schemas/CountryV2"}}},"Contact":{"type":"object","properties":{"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumber"}},"emails":{"type":"array","items":{"$ref":"#/components/schemas/Email"}},"preferredContactMethod":{"type":"string","enum":["EMAIL","PHONE","MAIL"],"example":"EMAIL"}}},"ContactPatch":{"type":"object","properties":{"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberPatch"}},"emails":{"type":"array","items":{"$ref":"#/components/schemas/EmailPatch"}},"preferredContactMethod":{"type":"string","enum":["EMAIL","PHONE","MAIL"],"example":"EMAIL"}}},"PhoneNumber":{"type":"object","required":["id","type","number","countryCode","dialNumber"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the phone","example":"123e4567-e89b-12d3-a456-426614174000"},"type":{"type":"string","enum":["MOBILE","HOME","BUSINESS","CLAIMCENTER","CUSTOMERSERVICE","CORPORATEOFFICE","FAX","UNKNOWN","OTHER"],"example":"MOBILE"},"countryCode":{"$ref":"#/components/schemas/CountryCallingCodes"},"areaCode":{"type":"string","example":"123"},"dialNumber":{"type":"string","example":"12345, 1234567890"},"extension":{"type":"string","example":"1234"},"bestTime":{"type":"string","description":"Best time","example":"Morning"},"timezone":{"type":"string","description":"Timezone for the entered phone details","example":"EST"}}},"PhoneNumberPatch":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the phone","example":"123e4567-e89b-12d3-a456-426614174000"},"type":{"type":"string","enum":["MOBILE","HOME","BUSINESS","CLAIMCENTER","CUSTOMERSERVICE","CORPORATEOFFICE","FAX","UNKNOWN","OTHER"],"example":"MOBILE"},"countryCode":{"$ref":"#/components/schemas/CountryCallingCodes"},"areaCode":{"type":"string","example":"123"},"dialNumber":{"type":"string","example":"12345, 1234567890"},"extension":{"type":"string","example":"1234"},"bestTime":{"type":"string","description":"Best time","example":"Morning"},"timezone":{"type":"string","description":"Timezone for the entered phone details","example":"EST"}}},"Email":{"type":"object","required":["id","type","address"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the email","example":"123e4567-e89b-12d3-a456-426614174000"},"type":{"type":"string","enum":["PERSONAL","BUSINESS","CUSTOMERSERVICE","OTHER"],"example":"PERSONAL"},"address":{"type":"string","format":"email","example":"j4TlS@example.com"}}},"EmailPatch":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the email","example":"123e4567-e89b-12d3-a456-426614174000"},"type":{"type":"string","enum":["PERSONAL","BUSINESS","CUSTOMERSERVICE","OTHER"],"example":"PERSONAL"},"address":{"type":"string","format":"email","example":"j4TlS@example.com"}}},"Employment":{"type":"object","required":["employed","status"],"properties":{"employed":{"type":"boolean","default":true},"status":{"type":"string","enum":["FULL_TIME","PART_TIME","SELF_EMPLOYED","UNEMPLOYED","RETIRED","DISABLED","LAID_OFF","LEAVE_DUE_TO_CHILDBIRTH","LEAVE_DUE_TO_MILITARY_SERVICE","LEAVE_OF_ABSENCE","RESIGNED","SHORT_TERM_DISABILITY","TERMINATED","UNKNOWN","OTHER"],"example":"FULL_TIME"},"occupation":{"type":"string","example":"Engineer"},"householdIncome":{"type":"number","format":"double","minimum":0,"example":250000},"netAnnualIncome":{"type":"number","format":"double","minimum":0,"example":250000}}},"EmploymentPatch":{"type":"object","properties":{"employed":{"type":"boolean","default":true},"status":{"type":"string","enum":["FULL_TIME","PART_TIME","SELF_EMPLOYED","UNEMPLOYED","RETIRED","DISABLED","LAID_OFF","LEAVE_DUE_TO_CHILDBIRTH","LEAVE_DUE_TO_MILITARY_SERVICE","LEAVE_OF_ABSENCE","RESIGNED","SHORT_TERM_DISABILITY","TERMINATED","UNKNOWN","OTHER"],"example":"FULL_TIME"},"occupation":{"type":"string","example":"Engineer"},"householdIncome":{"type":"number","format":"double","minimum":0,"example":250000},"netAnnualIncome":{"type":"number","format":"double","minimum":0,"example":250000}}},"Relationship":{"type":"object","properties":{"type":{"type":"string","enum":["TRUSTEE","TRUSTEEOFMINOR","TRUSTEEOFINCOMPETENT","POWEROFATTORNEY","CONTROLLINGPERSONOFENTITY","BROTHER","CHILD","DAUGHTER","DOMESTICPARTNER","EXECUTORS","FATHER","FIANCE","GRANDCHILD","GRANDPARENT","LIFEPARTNER","MOTHER","PARENT","SIBLING","SISTER","SON","SPOUSE","STEPFATHER","STEPMOTHER","STEPPARENT","SELF","LEGALGUARDIAN","BUSINESS","BUSINESSASSOCIATE","PARTNER","EMPLOYER","FORMERSPOUSE","OWNER","STEPCHILD","CUSTODIAN","OTHER"],"example":"SPOUSE"},"percentage":{"type":"integer","minimum":0,"maximum":100,"example":50}}},"RelationshipPatch":{"type":"object","properties":{"type":{"type":"string","enum":["TRUSTEE","TRUSTEEOFMINOR","TRUSTEEOFINCOMPETENT","POWEROFATTORNEY","CONTROLLINGPERSONOFENTITY","BROTHER","CHILD","DAUGHTER","DOMESTICPARTNER","EXECUTORS","FATHER","FIANCE","GRANDCHILD","GRANDPARENT","LIFEPARTNER","MOTHER","PARENT","SIBLING","SISTER","SON","SPOUSE","STEPFATHER","STEPMOTHER","STEPPARENT","SELF","LEGALGUARDIAN","BUSINESS","BUSINESSASSOCIATE","PARTNER","EMPLOYER","FORMERSPOUSE","OWNER","STEPCHILD","CUSTODIAN","OTHER"],"example":"SPOUSE"},"percentage":{"type":"integer","minimum":0,"maximum":100,"example":50}}},"Coverage":{"type":"object","required":["faceAmount","plannedPremiumAmount"],"properties":{"faceAmount":{"type":"number","format":"double","minimum":0,"description":"Face amount of the policy","example":250000},"deathBenefitOption":{"type":"string","enum":["LEVEL","INCREASING"],"description":"Death benefit option type","example":"LEVEL"},"deathBenefitComplianceTest":{"type":"string","enum":["GPT","CVAT"],"description":"Death benefit compliance test type","example":"GPT"},"plannedPremiumAmount":{"type":"number","format":"double","description":"Planned premium amount","example":2500},"fixedCostPeriod":{"type":"integer","enum":[10,15,20,25,30,65],"description":"Fixed cost period duration. Required only for TERM & TERM ROP plan codes.","example":10},"tableRatings":{"type":"object","properties":{"tableRating":{"type":"string","enum":["TABLEA","TABLEB","TABLEC","TABLED","TABLEE","TABLEF","TABLEG","TABLEH","TABLEI","TABLEJ","TABLEK","TABLEL","TABLEM","TABLEN","TABLEO","TABLEP","NONETABLE"],"description":"Table rating classification","example":"TABLEA"},"flatExtras":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/FlatExtraPermanent"},{"$ref":"#/components/schemas/FlatExtraTemporary"}]}}},"description":"Table ratings and flat extras for the coverage"},"party":{"type":"array","items":{"type":"string","description":"Associated PartyIds for given coverage","example":"5f8f2f5c-6c3b-4e3b-8f2f-5c6c3b4e3b8f"}}}},"CoveragePatch":{"type":"object","properties":{"faceAmount":{"type":"number","format":"double","minimum":0,"description":"Face amount of the policy","example":250000},"deathBenefitOption":{"type":"string","enum":["LEVEL","INCREASING"],"description":"Death benefit option type","example":"LEVEL"},"deathBenefitComplianceTest":{"type":"string","enum":["GPT","CVAT"],"description":"Death benefit compliance test type","example":"GPT"},"plannedPremiumAmount":{"type":"number","format":"double","description":"Planned premium amount","example":2500},"fixedCostPeriod":{"type":"integer","enum":[10,15,20,25,30,65],"description":"Fixed cost period duration","example":10},"tableRatings":{"type":"object","properties":{"tableRating":{"type":"string","enum":["TABLEA","TABLEB","TABLEC","TABLED","TABLEE","TABLEF","TABLEG","TABLEH","TABLEI","TABLEJ","TABLEK","TABLEL","TABLEM","TABLEN","TABLEO","TABLEP","NONETABLE"],"description":"Table rating classification","example":"TABLEA"},"flatExtras":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/FlatExtraPatchPermanent"},{"$ref":"#/components/schemas/FlatExtraPatchTemporary"}]}}},"description":"Table ratings and flat extras for the coverage"},"party":{"type":"array","items":{"type":"string","description":"Associated PartyIds for given coverage","example":"5f8f2f5c-6c3b-4e3b-8f2f-5c6c3b4e3b8f"}}}},"Indicator":{"anyOf":[{"$ref":"#/components/schemas/Discount"},{"$ref":"#/components/schemas/RiskFactor"},{"$ref":"#/components/schemas/PolicyRestriction"}],"discriminator":{"propertyName":"type","mapping":{"DISCOUNT":"#/components/schemas/Discount","RISK_FACTOR":"#/components/schemas/RiskFactor","POLICY_RESTRICTION":"#/components/schemas/PolicyRestriction"}}},"BaseIndicator":{"type":"object","properties":{}},"Discount":{"type":"object","properties":{"discountType":{"type":"string","enum":["MULTIPRODUCT","NON"],"description":"Type of discount","example":"MULTIPRODUCT"}}},"RiskFactor":{"allOf":[{"$ref":"#/components/schemas/BaseIndicator"},{"type":"object","properties":{"factorType":{"type":"string","description":"Type of risk factor","example":"PREMIUM"},"severity":{"type":"string","enum":["LOW","MEDIUM","HIGH"],"description":"Severity of the risk factor","example":"LOW"}}}]},"UnderwritingRequirement":{"allOf":[{"$ref":"#/components/schemas/BaseIndicator"},{"type":"object","properties":{"requirementType":{"type":"string","description":"Type of underwriting requirement","example":"PREMIUM"},"dueDate":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","description":"Date (with pattern \"yyyy-mm-dd\")","example":"2020-01-01"}}}]},"UnderwritingReview":{"type":"object","required":["decision","underwritingRiskClass","decisionRiskClass","approvedFaceAmount","approvedFaceAmountMaximum"],"properties":{"underwritingCaseId":{"type":"string","description":"Underwriting case identifier","example":"CA1234567890"},"decision":{"type":"string","enum":["APPROVED","PENDING_DECISION","PENDING_REVIEW","DECLINED","RISK_NOT_ACCEPTABLE"],"description":"Underwriting decision","example":"APPROVED"},"status":{"type":"string","enum":["CLEAN_CASE","DECLINED","MODIFIED","ADVERSE"],"description":"Status of UW case","example":"CLEAN_CASE"},"underwritingSourceName":{"type":"string","description":"UW Source Details","example":"Source Details"},"underwritingRiskClass":{"type":"string","enum":["ULTRANONTOBACCO","ELITENONTOBACCO","PREFERREDNONTOBACCO","STANDARDNONTOBACCO","STANDARDTOBACCO","STANDARDAGGREGATE","SUBSTANDARDNONTOBACCO","SUBSTANDARDTOBACCO","STANDARDPLUSNONTOBACCO","PREFERREDTOBACCO","STANDARDCONVERSIONNONTOBACCO","STANDARDCONVERSIONTOBACCO"],"description":"Risk Class Configured at Underwriting System.","example":"ULTRANONTOBACCO"},"decisionRiskClass":{"type":"string","enum":["ULTRANONTOBACCO","ELITENONTOBACCO","PREFERREDNONTOBACCO","STANDARDNONTOBACCO","STANDARDTOBACCO","STANDARDAGGREGATE","SUBSTANDARDNONTOBACCO","SUBSTANDARDTOBACCO","STANDARDPLUSNONTOBACCO","PREFERREDTOBACCO","STANDARDCONVERSIONNONTOBACCO","STANDARDCONVERSIONTOBACCO"],"description":"Decision Risk Class","example":"ULTRANONTOBACCO"},"underwritingMethod":{"type":"string","enum":["FULLUNDERWRITING","ATTESTATIONVALIDATION","ADDITIONALUNDERWRITING","SIMPLIFIED","REDUCEDUNDERWRITING","GUARANTEEISSUE","EXPRESSUNDERWRITING","MASSUNDERWRITING","AVIATION"],"description":"Underwriting methods","example":"FULLUNDERWRITING"},"tobaccoPremiumBasis":{"type":"string","enum":["SMOKER","NON_SMOKER"],"description":"Premium basis","example":"SMOKER"},"approvedFaceAmount":{"type":"number","format":"double","description":"Approved Face Amount","example":250000},"approvedFaceAmountMaximum":{"type":"number","format":"double","description":"Approved Maximum Face Amount","example":250000},"riders":{"type":"array","items":{"$ref":"#/components/schemas/Riders"}},"exclusionReview":{"type":"array","items":{"$ref":"#/components/schemas/ExclusionReview"}}}},"UnderwritingReviewPatch":{"type":"object","properties":{"underwritingCaseId":{"type":"string","description":"Underwriting case identifier","example":"CA1234567890"},"decision":{"type":"string","enum":["APPROVED","PENDING_DECISION","PENDING_REVIEW","DECLINED","RISK_NOT_ACCEPTABLE"],"description":"Underwriting decision","example":"APPROVED"},"status":{"type":"string","enum":["CLEAN_CASE","DECLINED","MODIFIED","ADVERSE"],"description":"Status of UW case","example":"CLEAN_CASE"},"underwritingSourceName":{"type":"string","description":"UW Source Details","example":"Source Details"},"underwritingRiskClass":{"type":"string","enum":["ULTRANONTOBACCO","ELITENONTOBACCO","PREFERREDNONTOBACCO","STANDARDNONTOBACCO","STANDARDTOBACCO","STANDARDAGGREGATE","SUBSTANDARDNONTOBACCO","SUBSTANDARDTOBACCO","STANDARDPLUSNONTOBACCO","PREFERREDTOBACCO","STANDARDCONVERSIONNONTOBACCO","STANDARDCONVERSIONTOBACCO"],"description":"Risk Class Configured at Underwriting System.","example":"ULTRANONTOBACCO"},"decisionRiskClass":{"type":"string","enum":["ULTRANONTOBACCO","ELITENONTOBACCO","PREFERREDNONTOBACCO","STANDARDNONTOBACCO","STANDARDTOBACCO","STANDARDAGGREGATE","SUBSTANDARDNONTOBACCO","SUBSTANDARDTOBACCO","STANDARDPLUSNONTOBACCO","PREFERREDTOBACCO","STANDARDCONVERSIONNONTOBACCO","STANDARDCONVERSIONTOBACCO"],"description":"Decision Risk Class","example":"ULTRANONTOBACCO"},"underwritingMethod":{"type":"string","enum":["FULLUNDERWRITING","ATTESTATIONVALIDATION","ADDITIONALUNDERWRITING","SIMPLIFIED","REDUCEDUNDERWRITING","GUARANTEEISSUE","EXPRESSUNDERWRITING","MASSUNDERWRITING","AVIATION"],"description":"Underwriting methods","example":"FULLUNDERWRITING"},"tobaccoPremiumBasis":{"type":"string","enum":["SMOKER","NON_SMOKER"],"description":"Premium basis","example":"SMOKER"},"approvedFaceAmount":{"type":"number","format":"double","description":"Approved Face Amount","example":250000},"approvedFaceAmountMaximum":{"type":"number","format":"double","description":"Approved Maximum Face Amount","example":250000},"riders":{"type":"array","items":{"$ref":"#/components/schemas/Riders"}},"exclusionReview":{"type":"array","items":{"$ref":"#/components/schemas/ExclusionReview"}}}},"ExclusionReview":{"type":"object","properties":{"description":{"type":"string","description":"Result description","example":"Aviation Activities"},"reasonCode":{"type":"string","enum":["AVIATION","SCUBA"],"description":"Reason code","example":"AVIATION"}}},"NonforfeitureOption":{"allOf":[{"type":"object","properties":{"nonForFeitureOption":{"type":"string","enum":["AUTOMATICPOLICYLOAN","REDUCEDPAIDUP"],"description":"Type of policy restriction","example":"REDUCEDPAIDUP"}}}]},"PolicyRestriction":{"allOf":[{"$ref":"#/components/schemas/BaseIndicator"},{"type":"object","properties":{"restrictionType":{"type":"string","description":"Type of policy restriction","example":"nonForfeitureProvisionOption"},"duration":{"type":"string","description":"Duration of the restriction","example":"2020-01-01"}}}]},"RateClassQualifier":{"allOf":[{"$ref":"#/components/schemas/BaseIndicator"},{"type":"object","properties":{"rateClass":{"type":"string","description":"Rate class qualification","example":"PREMIUM"},"reason":{"type":"string","description":"Reason for rate class qualification","example":"PREMIUM"}}}]},"FlatExtraPermanent":{"type":"object","required":["type","amount"],"properties":{"type":{"type":"string","enum":["PERMANENT"],"description":"Type of flat extra (permanent or temporary)","example":"PERMANENT"},"amount":{"type":"number","format":"double","minimum":0,"description":"Amount of flat extra per 1000 of face amount","example":250000},"duration":{"type":"integer","minimum":1,"description":"Duration of flat extra","example":250000},"durationType":{"type":"string","enum":["YEARS","MONTHS"],"description":"Unit of duration measurement","example":"YEARS"}}},"FlatExtraTemporary":{"type":"object","required":["type","amount","duration","durationType"],"properties":{"type":{"type":"string","enum":["TEMPORARY"],"description":"Type of flat extra (permanent or temporary)","example":"TEMPORARY"},"amount":{"type":"number","format":"double","minimum":0,"description":"Amount of flat extra per 1000 of face amount","example":250000},"duration":{"type":"integer","minimum":1,"description":"Duration of flat extra","example":250000},"durationType":{"type":"string","enum":["YEARS","MONTHS"],"description":"Unit of duration measurement","example":"YEARS"}}},"FlatExtraPatchPermanent":{"type":"object","properties":{"type":{"type":"string","enum":["PERMANENT"],"description":"Type of flat extra (permanent or temporary)","example":"PERMANENT"},"amount":{"type":"number","format":"double","minimum":0,"description":"Amount of flat extra per 1000 of face amount","example":250000},"duration":{"type":"integer","minimum":1,"description":"Duration of flat extra","example":250000},"durationType":{"type":"string","enum":["YEARS","MONTHS"],"description":"Unit of duration measurement","example":"YEARS"}}},"FlatExtraPatchTemporary":{"type":"object","properties":{"type":{"type":"string","enum":["TEMPORARY"],"description":"Type of flat extra (permanent or temporary)","example":"TEMPORARY"},"amount":{"type":"number","format":"double","minimum":0,"description":"Amount of flat extra per 1000 of face amount","example":250000},"duration":{"type":"integer","minimum":1,"description":"Duration of flat extra","example":250000},"durationType":{"type":"string","enum":["YEARS","MONTHS"],"description":"Unit of duration measurement","example":"YEARS"}}},"RiderDetail":{"type":"object","required":["type","status","optedForPolicy"],"properties":{"type":{"type":"string","enum":["Rider_OWP","Rider_ABRTRM","Rider_CTR","Rider_ABRCHR","Rider_ADR","Rider_WPR","Rider_CGR","Rider_GIBR","Rider_OPR","Rider_OWDR","Rider_WDR","Rider_NHR","Rider_ABRCRI"],"description":"Type of rider","example":"Rider_ABRTRM"},"faceAmount":{"type":"number","format":"double","minimum":0,"description":"Face amount for the rider opted by owner","example":250000},"premium":{"type":"number","format":"double","minimum":0,"description":"Premium amount for the rider","example":250000},"status":{"type":"string","enum":["ACTIVE","TERMINATED","PENDING","SUSPENDED"],"description":"Status of the rider. It should be always APPROVED.","example":"ACTIVE"},"optedForPolicy":{"type":"string","enum":["YES","NO"],"description":"Whether the rider is opted for this policy or not.","example":"YES"},"tableRating":{"type":"string","enum":["TABLEA","TABLEB","TABLEC","TABLED","TABLEE","TABLEF","TABLEG","TABLEH","TABLEI","TABLEJ","TABLEK","TABLEL","TABLEM","TABLEN","TABLEO","TABLEP","NONETABLE"],"description":"Table rating classification","example":"TABLEA"},"party":{"type":"array","items":{"type":"string","description":"Associated PartyIds for given rider","example":"5f8f2f5c-6c3b-4e3b-8f2f-5c6c3b4e3b8f"}}}},"RiderDetailPatch":{"type":"object","properties":{"type":{"type":"string","enum":["Rider_OWP","Rider_ABRTRM","Rider_CTR","Rider_ABRCHR","Rider_ADR","Rider_WPR","Rider_CGR","Rider_GIBR","Rider_OPR","Rider_OWDR","Rider_WDR","Rider_NHR","Rider_ABRCRI"],"description":"Type of rider","example":"Rider_ABRTRM"},"faceAmount":{"type":"number","format":"double","minimum":0,"description":"Face amount for the rider opted by owner","example":250000},"premium":{"type":"number","format":"double","minimum":0,"description":"Premium amount for the rider","example":250000},"status":{"type":"string","enum":["ACTIVE","TERMINATED","PENDING","SUSPENDED"],"description":"Status of the rider. It should be always APPROVED.","example":"ACTIVE"},"optedForPolicy":{"type":"string","enum":["YES","NO"],"description":"Whether the rider is opted for this policy or not.","example":"YES"},"tableRating":{"type":"string","enum":["TABLEA","TABLEB","TABLEC","TABLED","TABLEE","TABLEF","TABLEG","TABLEH","TABLEI","TABLEJ","TABLEK","TABLEL","TABLEM","TABLEN","TABLEO","TABLEP","NONETABLE"],"description":"Table rating classification","example":"TABLEA"},"party":{"type":"array","items":{"type":"string","description":"Associated PartyIds for given rider","example":"5f8f2f5c-6c3b-4e3b-8f2f-5c6c3b4e3b8f"}}}},"Beneficiaries":{"type":"object","required":["primary"],"properties":{"primary":{"type":"array","items":{"$ref":"#/components/schemas/BeneficiaryDetail"},"description":"List of primary beneficiaries"},"contingent":{"type":"array","items":{"$ref":"#/components/schemas/BeneficiaryDetail"},"description":"List of contingent beneficiaries"}}},"BeneficiariesPatch":{"type":"object","properties":{"primary":{"type":"array","items":{"$ref":"#/components/schemas/BeneficiaryDetail"},"description":"List of primary beneficiaries"},"contingent":{"type":"array","items":{"$ref":"#/components/schemas/BeneficiaryDetail"},"description":"List of contingent beneficiaries"}}},"BeneficiaryDetail":{"type":"object","required":["partyId","percentage"],"properties":{"partyId":{"type":"string","format":"uuid","description":"Reference to the beneficiary party ID","example":"5f8f2f5c-6c3b-4e3b-8f2f-5c6c3b4e3b8f"},"percentage":{"type":"integer","minimum":0,"maximum":100,"description":"Percentage share of the benefit","example":50},"irrevocable":{"type":"boolean","description":"Indicates if the beneficiary designation is irrevocable","example":true}}},"BeneficiaryDetailPatch":{"type":"object","properties":{"partyId":{"type":"string","format":"uuid","description":"Reference to the beneficiary party ID","example":"5f8f2f5c-6c3b-4e3b-8f2f-5c6c3b4e3b8f"},"percentage":{"type":"integer","minimum":0,"maximum":100,"description":"Percentage share of the benefit","example":50},"irrevocable":{"type":"boolean","description":"Indicates if the beneficiary designation is irrevocable","example":true}}},"PaymentV2":{"type":"object","required":["referenceNumber","method","frequency","amount","paymentDate","draftDate","automaticPayment"],"properties":{"referenceNumber":{"type":"string","example":"5f2e0c1a-6b3d-4d3f-8b7f-3f7b6d5e4c3a"},"method":{"type":"string","enum":["CREDITCARD","ACH","CHECK","WIRE","EXCHANGE","DTCC"],"example":"ACH"},"frequency":{"type":"string","enum":["DAILY","EVERYTWOWEEKS","MONTHLY","SEMIANNUAL","QUARTERLY","ANNUAL","SINGLEPAYMENT"],"description":"Frequency of premium payments","example":"MONTHLY"},"amount":{"type":"number","format":"double","example":250000},"automaticPayment":{"type":"boolean","default":true,"example":true},"draftDate":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","description":"Date (with pattern \"yyyy-mm-dd\")","example":"2023-01-01"},"paymentDate":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","description":"Date (with pattern \"yyyy-mm-dd\")","example":"2023-01-01"},"externalTransactionId":{"type":"string","description":"Transaction ID from external system","example":"A12345"},"externalArrangementId":{"type":"string","description":"Arrangement ID from external system","example":"B45678"},"party":{"type":"array","items":{"type":"string","description":"Associated PartyIds for given payment","example":"5f8f2f5c-6c3b-4e3b-8f2f-5c6c3b4e3b8f"}},"bankInformation":{"$ref":"#/components/schemas/BankInformationV2"}}},"PaymentV2Patch":{"type":"object","properties":{"referenceNumber":{"type":"string","example":"5f2e0c1a-6b3d-4d3f-8b7f-3f7b6d5e4c3a"},"method":{"type":"string","enum":["CREDITCARD","ACH","CHECK","WIRE","EXCHANGE","DTCC"],"example":"ACH"},"frequency":{"type":"string","enum":["DAILY","EVERYTWOWEEKS","MONTHLY","SEMIANNUAL","QUARTERLY","ANNUAL","SINGLEPAYMENT"],"description":"Frequency of premium payments","example":"MONTHLY"},"amount":{"type":"number","format":"double","example":250000},"automaticPayment":{"type":"boolean","default":true,"example":true},"draftDate":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","description":"Date (with pattern \"yyyy-mm-dd\")","example":"2023-01-01"},"paymentDate":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","description":"Date (with pattern \"yyyy-mm-dd\")","example":"2023-01-01"},"externalTransactionId":{"type":"string","description":"Transaction ID from external system","example":"A12345"},"externalArrangementId":{"type":"string","description":"Arrangement ID from external system","example":"A12345"},"party":{"type":"array","items":{"type":"string","description":"Associated PartyIds for given payment","example":"5f8f2f5c-6c3b-4e3b-8f2f-5c6c3b4e3b8f"}},"bankInformation":{"$ref":"#/components/schemas/BankInformationV2Patch"}}},"BankInformationV2":{"type":"object","properties":{"nameOnAccount":{"type":"string","example":"abc"},"accountStatus":{"type":"string","example":"Active"},"accountNumber":{"type":"string","example":"1234567890"},"routingNumber":{"type":"string","example":"123456789"},"accountType":{"type":"string","enum":["CHECKING","SAVINGS","CREDITCARD","DEBITCARD","BROKERAGEACCOUNT","CERTIFICATEOFDEPOSIT","WIRE"],"example":"CHECKING"},"ibaNumber":{"type":"string","example":"123456789"},"branchName":{"type":"string","example":"XYZ Branch"},"address":{"$ref":"#/components/schemas/PaymentAddress"}}},"BankInformationV2Patch":{"type":"object","properties":{"nameOnAccount":{"type":"string","example":"abc"},"accountStatus":{"type":"string","example":"Active"},"accountNumber":{"type":"string","example":"1234567890"},"routingNumber":{"type":"string","example":"123456789"},"accountType":{"type":"string","enum":["CHECKING","SAVINGS","CREDITCARD","DEBITCARD","BROKERAGEACCOUNT","CERTIFICATEOFDEPOSIT","WIRE"],"example":"CHECKING"},"ibaNumber":{"type":"string","example":"123456789"},"branchName":{"type":"string","example":"XYZ Branch"},"address":{"$ref":"#/components/schemas/PaymentAddressPatch"}}},"AccountHolder":{"type":"object","required":["partyId","name","type"],"properties":{"partyId":{"type":"string","format":"uuid","example":"5f8f2f5c-6c3b-4e3b-8f2f-5c6c3b4e3b8f"},"name":{"type":"string","example":"John Doe"},"type":{"type":"string","enum":["INDIVIDUAL","CORPORATE","TRUST"],"example":"INDIVIDUAL"}}},"AccountHolderPatch":{"type":"object","properties":{"partyId":{"type":"string","format":"uuid","example":"5f8f2f5c-6c3b-4e3b-8f2f-5c6c3b4e3b8f"},"name":{"type":"string","example":"John Doe"},"type":{"type":"string","enum":["INDIVIDUAL","CORPORATE","TRUST"],"example":"INDIVIDUAL"}}},"DocumentsV2":{"type":"array","items":{"$ref":"#/components/schemas/Document"}},"DocumentsV2Patch":{"type":"array","items":{"$ref":"#/components/schemas/DocumentPatch"}},"Location":{"type":"object","required":["city","state"],"properties":{"city":{"type":"string","example":"San Francisco"},"state":{"$ref":"#/components/schemas/State"}}},"Replacement":{"type":"object","required":["type","policyNumber","status","replacement","useExistingPolicyFunds","amount","issueDate","replacementCoverageAmount","carrier","productType","exchangeType","addressDetail","qualificationType","mecIndicator","replacementType","exchangeDate","existingLifeInsuranceIndicator"],"properties":{"type":{"type":"string","description":"Identifies the type of  transaction being processed for a policy or application. This key helps categorize and route replacement or conversion cases appropriately within the systems.","enum":["REPLACEMENT","NONREPLACEMENT","CONVERSION"],"example":"REPLACEMENT"},"useExistingPolicyFunds":{"type":"boolean","description":"Use funds from existing policies","example":true},"policyNumber":{"type":"string","description":"Existing policy number","example":"1234567890"},"productCode":{"type":"string","description":"Product code for mentioned policy","example":"1234567890"},"amount":{"type":"number","format":"double","description":"Policy amount","example":100},"status":{"type":"string","enum":["ACTIVE","LAPSED","TERMINATED"],"description":"Policy status","example":"ACTIVE"},"replacementCoverageAmount":{"type":"number","format":"double","description":"Represents the anticipated cash value expected to be transferred from the existing policy being replaced.","example":100},"carrier":{"type":"string","description":"Name of the ceding carrier. It should be same as mentioned in the form.","example":"CarrierName_1"},"issueDate":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","description":"The official date on which the policy is issued and becomes effective.","example":"2022-01-01"},"policyEffectiveDate":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","description":"Date (with pattern \"yyyy-mm-dd\")","example":"2022-01-01"},"productType":{"type":"string","enum":["LIFE","ANNUITY"],"description":"Indicates the category of the insurance product associated with the policy","example":"ANNUITY"},"tin":{"type":"string","description":"Tax Id for given company","example":"123456789"},"exchangeType":{"type":"string","enum":["EXTERNAL1035","INTERNAL1035","EXTERNALDIRECTTRANSFER","INTERNALDIRECTTRANSFER","EXTERNALROLLOVERQUALIFIED","INTERNALROLLOVERQUALIFIED","EXTERNALROTHROLLOVER","INTERNALROTHROLLOVER","EXTERNALROTHDIRECTTRANSFER","INTERNALROTHDIRECTTRANSFER","BENEFITPROCEEDS","CASHCONTRIBUTIONS","EXTERNAL1035PARTIAL","INTERNAL1035PARTIAL","EXTERNALDIRECTTRANSFERREPLACEMENT","INTERNALDIRECTTRANSFERREPLACEMENT","CLIENTINITIATEDTRANSFER","BIRTHORADOPTIONREPAYMENT"],"description":"Specifies the type of policy exchange or replacement transaction being performed.","example":"EXTERNAL1035"},"addressDetail":{"$ref":"#/components/schemas/InsuranceHistoryAddressDetail"},"costBasis":{"type":"number","format":"double","description":"The default value is 0.Represents the total amount of premiums paid or invested into the existing policy being replaced, excluding gains or interest."},"qualificationType":{"type":"string","enum":["IRA_REGULAR","IRA_SPOUSAL","IRA_ROLLOVER","ROTH_IRA","CUSTODIAL_IRA","CUSTODIAL_ROTH_IRA","CUSTODIAL_ROLLOVER_IRA","SEP_IRA","INHERITED_IRA","INHERITED_ROTH_IRA","NQ_STRETCH","403B","NON_QUALIFIED","IRA_SIMPLE","Q401K","Q401A","Q457B","PENSION_PLAN"],"description":"Indicates the tax qualification status of the policy or account.","example":"IRA_REGULAR"},"mecIndicator":{"type":"boolean","description":"- Indicates whether the policy is classified as a Modified Endowment Contract (MEC) or not\n- Default = False\n","example":false},"replacementType":{"type":"string","enum":["PARTIAL","FULL_SURRENDER"],"description":"Policy replacement type","example":"PARTIAL"},"exchangeDate":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","description":"Date on which the old policy is replaced by the new one.","example":"2022-01-01"},"existingLifeInsuranceIndicator":{"type":"boolean","description":"Indicates if there is existing life insurance policies.","default":false,"example":false}}},"Conversion":{"type":"object","required":["type","policyNumber","carrier"],"properties":{"type":{"type":"string","description":"Identifies the type of  transaction being processed for a policy or application. This key helps categorize and route replacement or conversion cases appropriately within the systems.","enum":["REPLACEMENT","NONREPLACEMENT","CONVERSION"],"example":"CONVERSION"},"policyNumber":{"type":"string","description":"Existing policy number","example":"1234567890"},"productCode":{"type":"string","description":"Product code for mentioned policy","example":"1234567890"},"amount":{"type":"number","format":"double","description":"Policy amount","example":100},"status":{"type":"string","enum":["ACTIVE","LAPSED","TERMINATED"],"description":"Policy status","example":"ACTIVE"},"carrier":{"type":"string","description":"Name of the ceeding carrier. It should be same as mentioned in the form.","example":"CarrierName_1"},"issueDate":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","description":"The official date on which the policy is issued and becomes effective.","example":"2022-01-01"},"productType":{"type":"string","enum":["LIFE","ANNUITY"],"description":"Indicates the category of the insurance product associated with the policy","example":"ANNUITY"},"tin":{"type":"string","description":"Tax Id for given company","example":"123456789"},"exchangeType":{"type":"string","enum":["EXTERNAL1035","INTERNAL1035","EXTERNALDIRECTTRANSFER","INTERNALDIRECTTRANSFER","EXTERNALROLLOVERQUALIFIED","INTERNALROLLOVERQUALIFIED","EXTERNALROTHROLLOVER","INTERNALROTHROLLOVER","EXTERNALROTHDIRECTTRANSFER","INTERNALROTHDIRECTTRANSFER","BENEFITPROCEEDS","CASHCONTRIBUTIONS","EXTERNAL1035PARTIAL","INTERNAL1035PARTIAL","EXTERNALDIRECTTRANSFERREPLACEMENT","INTERNALDIRECTTRANSFERREPLACEMENT","CLIENTINITIATEDTRANSFER","BIRTHORADOPTIONREPAYMENT"],"description":"Specifies the type of policy exchange or replacement transaction being performed.","example":"EXTERNAL1035"},"addressDetail":{"$ref":"#/components/schemas/InsuranceHistoryAddressDetail"},"costBasis":{"type":"number","format":"double","description":"The default value is 0.Represents the total amount of premiums paid or invested into the existing policy being replaced, excluding gains or interest."},"qualificationType":{"type":"string","enum":["IRA_REGULAR","IRA_SPOUSAL","IRA_ROLLOVER","ROTH_IRA","CUSTODIAL_IRA","CUSTODIAL_ROTH_IRA","CUSTODIAL_ROLLOVER_IRA","SEP_IRA","INHERITED_IRA","INHERITED_ROTH_IRA","NQ_STRETCH","403B","NON_QUALIFIED","IRA_SIMPLE","Q401K","Q401A","Q457B","PENSION_PLAN"],"description":"Indicates the tax qualification status of the policy or account.","example":"IRA_REGULAR"},"mecIndicator":{"type":"boolean","description":"- Indicates whether the policy is classified as a Modified Endowment Contract (MEC) or not\n- Default = False\n","example":false},"restrictionIndicator":{"type":"boolean","description":"Indicates if there is a collateral assignee on existing policy.Default = False.","example":false}}},"NonReplacement":{"type":"object","required":["type","policyNumber","status","amount","carrier","productType"],"properties":{"type":{"type":"string","description":"Identifies the type of  transaction being processed for a policy or application. This key helps categorize and route replacement or conversion cases appropriately within the systems.","enum":["REPLACEMENT","NONREPLACEMENT","CONVERSION"],"example":"NONREPLACEMENT"},"useExistingPolicyFunds":{"type":"boolean","description":"Use funds from existing policies","example":true},"policyNumber":{"type":"string","description":"Existing policy number","example":"1234567890"},"productCode":{"type":"string","description":"Product code for mentioned policy","example":"1234567890"},"amount":{"type":"number","format":"double","description":"Policy amount","example":100},"status":{"type":"string","enum":["ACTIVE","LAPSED","TERMINATED"],"description":"Policy status","example":"ACTIVE"},"replacementCoverageAmount":{"type":"number","format":"double","description":"Represents the anticipated cash value expected to be transferred from the existing policy being replaced.","example":100},"carrier":{"type":"string","description":"Name of the ceeding carrier. It should be same as mentioned in the form.","example":"CarrierName_1"},"issueDate":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","description":"The official date on which the policy is issued and becomes effective.","example":"2022-01-01"},"policyEffectiveDate":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","description":"Date (with pattern \"yyyy-mm-dd\")","example":"2022-01-01"},"productType":{"type":"string","enum":["LIFE","ANNUITY"],"description":"Indicates the category of the insurance product associated with the policy","example":"ANNUITY"},"tin":{"type":"string","description":"Tax Id for given company","example":"123456789"},"exchangeType":{"type":"string","enum":["EXTERNAL1035","INTERNAL1035","EXTERNALDIRECTTRANSFER","INTERNALDIRECTTRANSFER","EXTERNALROLLOVERQUALIFIED","INTERNALROLLOVERQUALIFIED","EXTERNALROTHROLLOVER","INTERNALROTHROLLOVER","EXTERNALROTHDIRECTTRANSFER","INTERNALROTHDIRECTTRANSFER","BENEFITPROCEEDS","CASHCONTRIBUTIONS","EXTERNAL1035PARTIAL","INTERNAL1035PARTIAL","EXTERNALDIRECTTRANSFERREPLACEMENT","INTERNALDIRECTTRANSFERREPLACEMENT","CLIENTINITIATEDTRANSFER","BIRTHORADOPTIONREPAYMENT"],"description":"Specifies the type of policy exchange or replacement transaction being performed.","example":"EXTERNAL1035"},"addressDetail":{"$ref":"#/components/schemas/InsuranceHistoryAddressDetail"},"costBasis":{"type":"number","format":"double","description":"The default value is 0.Represents the total amount of premiums paid or invested into the existing policy being replaced, excluding gains or interest."},"qualificationType":{"type":"string","enum":["IRA_REGULAR","IRA_SPOUSAL","IRA_ROLLOVER","ROTH_IRA","CUSTODIAL_IRA","CUSTODIAL_ROTH_IRA","CUSTODIAL_ROLLOVER_IRA","SEP_IRA","INHERITED_IRA","INHERITED_ROTH_IRA","NQ_STRETCH","403B","NON_QUALIFIED","IRA_SIMPLE","Q401K","Q401A","Q457B","PENSION_PLAN"],"description":"Indicates the tax qualification status of the policy or account.","example":"IRA_REGULAR"},"mecIndicator":{"type":"boolean","description":"- Indicates whether the policy is classified as a Modified Endowment Contract (MEC) or not\n- Default = False\n","example":false},"replacementType":{"type":"string","enum":["PARTIAL","FULL_SURRENDER"],"description":"Policy replacement type","example":"PARTIAL"},"exchangeDate":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","description":"Date on which the old policy is replaced by the new one.","example":"2022-01-01"},"existingLifeInsuranceIndicator":{"type":"boolean","description":"Indicates if there is existing life insurance policies.","default":false,"example":false}}},"ReplacementPatch":{"type":"object","properties":{"type":{"type":"string","description":"Identifies the type of  transaction being processed for a policy or application. This key helps categorize and route replacement or conversion cases appropriately within the systems.","enum":["REPLACEMENT","NONREPLACEMENT","CONVERSION"],"example":"REPLACEMENT"},"useExistingPolicyFunds":{"type":"boolean","description":"Use funds from existing policies","example":true},"policyNumber":{"type":"string","description":"Existing policy number","example":"1234567890"},"productCode":{"type":"string","description":"Product code for mentioned policy","example":"1234567890"},"amount":{"type":"number","format":"double","description":"Policy amount","example":100},"status":{"type":"string","enum":["ACTIVE","LAPSED","TERMINATED"],"description":"Policy status","example":"ACTIVE"},"replacementCoverageAmount":{"type":"number","format":"double","description":"Represents the anticipated cash value expected to be transferred from the existing policy being replaced.","example":100},"carrier":{"type":"string","description":"Name of the ceeding carrier. It should be same as mentioned in the form.","example":"CarrierName_1"},"issueDate":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","description":"The official date on which the policy is issued and becomes effective.","example":"2022-01-01"},"policyEffectiveDate":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","description":"Date (with pattern \"yyyy-mm-dd\")","example":"2022-01-01"},"productType":{"type":"string","enum":["LIFE","ANNUITY"],"description":"Indicates the category of the insurance product associated with the policy","example":"ANNUITY"},"tin":{"type":"string","description":"Tax Id for given company","example":"123456789"},"exchangeType":{"type":"string","enum":["EXTERNAL1035","INTERNAL1035","EXTERNALDIRECTTRANSFER","INTERNALDIRECTTRANSFER","EXTERNALROLLOVERQUALIFIED","INTERNALROLLOVERQUALIFIED","EXTERNALROTHROLLOVER","INTERNALROTHROLLOVER","EXTERNALROTHDIRECTTRANSFER","INTERNALROTHDIRECTTRANSFER","BENEFITPROCEEDS","CASHCONTRIBUTIONS","EXTERNAL1035PARTIAL","INTERNAL1035PARTIAL","EXTERNALDIRECTTRANSFERREPLACEMENT","INTERNALDIRECTTRANSFERREPLACEMENT","CLIENTINITIATEDTRANSFER","BIRTHORADOPTIONREPAYMENT"],"description":"Specifies the type of policy exchange or replacement transaction being performed.","example":"EXTERNAL1035"},"addressDetail":{"$ref":"#/components/schemas/InsuranceHistoryAddressDetail"},"costBasis":{"type":"number","format":"double","description":"The default value is 0.Represents the total amount of premiums paid or invested into the existing policy being replaced, excluding gains or interest."},"qualificationType":{"type":"string","enum":["IRA_REGULAR","IRA_SPOUSAL","IRA_ROLLOVER","ROTH_IRA","CUSTODIAL_IRA","CUSTODIAL_ROTH_IRA","CUSTODIAL_ROLLOVER_IRA","SEP_IRA","INHERITED_IRA","INHERITED_ROTH_IRA","NQ_STRETCH","403B","NON_QUALIFIED","IRA_SIMPLE","Q401K","Q401A","Q457B","PENSION_PLAN"],"description":"Indicates the tax qualification status of the policy or account.","example":"IRA_REGULAR"},"mecIndicator":{"type":"boolean","description":"- Indicates whether the policy is classified as a Modified Endowment Contract (MEC) or not\n- Default = False\n","example":false},"replacementType":{"type":"string","enum":["PARTIAL","FULL_SURRENDER"],"description":"Policy replacement type","example":"PARTIAL"},"exchangeDate":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","description":"Date on which the old policy is replaced by the new one.","example":"2022-01-01"},"existingLifeInsuranceIndicator":{"type":"boolean","description":"Indicates if there is existing life insurance policies.","default":false,"example":false}}},"ConversionPatch":{"type":"object","properties":{"type":{"type":"string","description":"Identifies the type of  transaction being processed for a policy or application. This key helps categorize and route replacement or conversion cases appropriately within the systems.","enum":["REPLACEMENT","NONREPLACEMENT","CONVERSION"],"example":"CONVERSION"},"policyNumber":{"type":"string","description":"Existing policy number","example":"1234567890"},"productCode":{"type":"string","description":"Product code for mentioned policy","example":"1234567890"},"amount":{"type":"number","format":"double","description":"Policy amount","example":100},"status":{"type":"string","enum":["ACTIVE","LAPSED","TERMINATED"],"description":"Policy status","example":"ACTIVE"},"carrier":{"type":"string","description":"Name of the ceeding carrier. It should be same as mentioned in the form.","example":"CarrierName_1"},"issueDate":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","description":"The official date on which the policy is issued and becomes effective.","example":"2022-01-01"},"productType":{"type":"string","enum":["LIFE","ANNUITY"],"description":"Indicates the category of the insurance product associated with the policy","example":"ANNUITY"},"tin":{"type":"string","description":"Tax Id for given company","example":"123456789"},"exchangeType":{"type":"string","enum":["EXTERNAL1035","INTERNAL1035","EXTERNALDIRECTTRANSFER","INTERNALDIRECTTRANSFER","EXTERNALROLLOVERQUALIFIED","INTERNALROLLOVERQUALIFIED","EXTERNALROTHROLLOVER","INTERNALROTHROLLOVER","EXTERNALROTHDIRECTTRANSFER","INTERNALROTHDIRECTTRANSFER","BENEFITPROCEEDS","CASHCONTRIBUTIONS","EXTERNAL1035PARTIAL","INTERNAL1035PARTIAL","EXTERNALDIRECTTRANSFERREPLACEMENT","INTERNALDIRECTTRANSFERREPLACEMENT","CLIENTINITIATEDTRANSFER","BIRTHORADOPTIONREPAYMENT"],"description":"Specifies the type of policy exchange or replacement transaction being performed.","example":"EXTERNAL1035"},"addressDetail":{"$ref":"#/components/schemas/InsuranceHistoryAddressDetail"},"costBasis":{"type":"number","format":"double","description":"The default value is 0.Represents the total amount of premiums paid or invested into the existing policy being replaced, excluding gains or interest."},"qualificationType":{"type":"string","enum":["IRA_REGULAR","IRA_SPOUSAL","IRA_ROLLOVER","ROTH_IRA","CUSTODIAL_IRA","CUSTODIAL_ROTH_IRA","CUSTODIAL_ROLLOVER_IRA","SEP_IRA","INHERITED_IRA","INHERITED_ROTH_IRA","NQ_STRETCH","403B","NON_QUALIFIED","IRA_SIMPLE","Q401K","Q401A","Q457B","PENSION_PLAN"],"description":"Indicates the tax qualification status of the policy or account.","example":"IRA_REGULAR"},"mecIndicator":{"type":"boolean","description":"- Indicates whether the policy is classified as a Modified Endowment Contract (MEC) or not\n- Default = False\n","example":false},"restrictionIndicator":{"type":"boolean","description":"Indicates if there is a collateral assignee on existing policy.Default = False.","example":false}}},"NonReplacementPatch":{"type":"object","required":["type","policyNumber","status","amount","carrier","productType"],"properties":{"type":{"type":"string","description":"Identifies the type of  transaction being processed for a policy or application. This key helps categorize and route replacement or conversion cases appropriately within the systems.","enum":["REPLACEMENT","NONREPLACEMENT","CONVERSION"],"example":"NONREPLACEMENT"},"useExistingPolicyFunds":{"type":"boolean","description":"Use funds from existing policies","example":true},"policyNumber":{"type":"string","description":"Existing policy number","example":"1234567890"},"productCode":{"type":"string","description":"Product code for mentioned policy","example":"1234567890"},"amount":{"type":"number","format":"double","description":"Policy amount","example":100},"status":{"type":"string","enum":["ACTIVE","LAPSED","TERMINATED"],"description":"Policy status","example":"ACTIVE"},"replacementCoverageAmount":{"type":"number","format":"double","description":"Represents the anticipated cash value expected to be transferred from the existing policy being replaced.","example":100},"carrier":{"type":"string","description":"Name of the ceeding carrier. It should be same as mentioned in the form.","example":"CarrierName_1"},"issueDate":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","description":"The official date on which the policy is issued and becomes effective.","example":"2022-01-01"},"policyEffectiveDate":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","description":"Date (with pattern \"yyyy-mm-dd\")","example":"2022-01-01"},"productType":{"type":"string","enum":["LIFE","ANNUITY"],"description":"Indicates the category of the insurance product associated with the policy","example":"ANNUITY"},"tin":{"type":"string","description":"Tax Id for given company","example":"123456789"},"exchangeType":{"type":"string","enum":["EXTERNAL1035","INTERNAL1035","EXTERNALDIRECTTRANSFER","INTERNALDIRECTTRANSFER","EXTERNALROLLOVERQUALIFIED","INTERNALROLLOVERQUALIFIED","EXTERNALROTHROLLOVER","INTERNALROTHROLLOVER","EXTERNALROTHDIRECTTRANSFER","INTERNALROTHDIRECTTRANSFER","BENEFITPROCEEDS","CASHCONTRIBUTIONS","EXTERNAL1035PARTIAL","INTERNAL1035PARTIAL","EXTERNALDIRECTTRANSFERREPLACEMENT","INTERNALDIRECTTRANSFERREPLACEMENT","CLIENTINITIATEDTRANSFER","BIRTHORADOPTIONREPAYMENT"],"description":"Specifies the type of policy exchange or replacement transaction being performed.","example":"EXTERNAL1035"},"addressDetail":{"$ref":"#/components/schemas/InsuranceHistoryAddressDetail"},"costBasis":{"type":"number","format":"double","description":"The default value is 0.Represents the total amount of premiums paid or invested into the existing policy being replaced, excluding gains or interest."},"qualificationType":{"type":"string","enum":["IRA_REGULAR","IRA_SPOUSAL","IRA_ROLLOVER","ROTH_IRA","CUSTODIAL_IRA","CUSTODIAL_ROTH_IRA","CUSTODIAL_ROLLOVER_IRA","SEP_IRA","INHERITED_IRA","INHERITED_ROTH_IRA","NQ_STRETCH","403B","NON_QUALIFIED","IRA_SIMPLE","Q401K","Q401A","Q457B","PENSION_PLAN"],"description":"Indicates the tax qualification status of the policy or account.","example":"IRA_REGULAR"},"mecIndicator":{"type":"boolean","description":"- Indicates whether the policy is classified as a Modified Endowment Contract (MEC) or not\n- Default = False\n","example":false},"replacementType":{"type":"string","enum":["PARTIAL","FULL_SURRENDER"],"description":"Policy replacement type","example":"PARTIAL"},"exchangeDate":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","description":"Date on which the old policy is replaced by the new one.","example":"2022-01-01"},"existingLifeInsuranceIndicator":{"type":"boolean","description":"Indicates if there is existing life insurance policies.","default":false,"example":false}}},"Application":{"type":"object","required":["startDate","submissionType","state","country"],"properties":{"startDate":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","description":"Date (with pattern \"yyyy-mm-dd\")","example":"2022-01-01"},"submissionType":{"type":"string","enum":["ELECTRONIC","PAPER"],"description":"Method of submission","example":"ELECTRONIC"},"formNumber":{"type":"string","description":"Form number for the application","example":"12345"},"versionNumber":{"type":"string","description":"Version number of the application form","example":"1.0"},"expirationDate":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","description":"Date (with pattern \"yyyy-mm-dd\")","example":"2022-01-01"},"replacementIndicator":{"type":"boolean","description":"Default = False If set = True then need to fill respective data under PolicyHistory section.","default":false},"policyHistory":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/Replacement"},{"$ref":"#/components/schemas/NonReplacement"},{"$ref":"#/components/schemas/Conversion"}]}}}},"ApplicationPatch":{"type":"object","properties":{"startDate":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","description":"Date (with pattern \"yyyy-mm-dd\")","example":"2022-01-01"},"submissionType":{"type":"string","enum":["ELECTRONIC","PAPER"],"description":"Method of submission","example":"ELECTRONIC"},"applicationStatus":{"type":"string","description":"Application status. When abandoned or declined, the case will be marked cancelled","enum":["ABANDONED","DECLINED"],"example":"ABANDONED"},"formNumber":{"type":"string","description":"Form number for the application","example":"12345"},"versionNumber":{"type":"string","description":"Version number of the application form","example":"1.0"},"expirationDate":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","description":"Date (with pattern \"yyyy-mm-dd\")","example":"2022-01-01"},"replacementIndicator":{"type":"boolean","description":"Default = False If set = True then need to fill respective data under PolicyHistory Section.","default":false},"policyHistory":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/ReplacementPatch"},{"$ref":"#/components/schemas/NonReplacementPatch"},{"$ref":"#/components/schemas/ConversionPatch"}]}}}},"ZinniaIllustration":{"type":"object","required":["illustrationId","source"],"properties":{"source":{"type":"string","description":"Illustration Source","enum":["ZINNIA"],"default":"ZINNIA","example":"ZINNIA"},"illustrationId":{"type":"string","description":"Unique identifier for the illustration","example":"Q12345"},"customIdentifiers":{"type":"array","items":{"$ref":"#/components/schemas/CustomIdentifier"}}}},"ZinniaIllustrationPatch":{"type":"object","properties":{"source":{"type":"string","description":"Illustration Source","enum":["ZINNIA"],"default":"ZINNIA","example":"ZINNIA"},"illustrationId":{"type":"string","description":"Unique identifier for the illustration","example":"Q12345"},"customIdentifiers":{"type":"array","items":{"$ref":"#/components/schemas/CustomIdentifier"}}}},"ZinniaIllustrationResponse":{"type":"object","properties":{"source":{"type":"string","description":"Illustration Source","enum":["ZINNIA"],"default":"ZINNIA","example":"ZINNIA"},"illustrationId":{"type":"string","description":"Unique identifier for the illustration","example":"Q12345"},"customIdentifiers":{"type":"array","items":{"$ref":"#/components/schemas/CustomIdentifier"}}}},"ExternalIllustration":{"type":"object","required":["source","details"],"properties":{"source":{"type":"string","description":"Illustration Source","enum":["EXTERNAL"],"default":"EXTERNAL","example":"EXTERNAL"},"illustrationId":{"type":"string","description":"Unique identifier for the illustration","example":"Q12345"},"customIdentifiers":{"type":"array","items":{"$ref":"#/components/schemas/CustomIdentifier"}},"details":{"$ref":"#/components/schemas/illustrationDetailsPatch"}}},"ExternalIllustrationResponse":{"type":"object","properties":{"source":{"type":"string","description":"Illustration Source","enum":["EXTERNAL"],"default":"EXTERNAL","example":"EXTERNAL"},"illustrationId":{"type":"string","description":"Unique identifier for the illustration","example":"Q12345"},"customIdentifiers":{"type":"array","items":{"$ref":"#/components/schemas/CustomIdentifier"}},"details":{"$ref":"#/components/schemas/illustrationDetailsPatch"}}},"ExternalIllustrationPatch":{"type":"object","properties":{"source":{"type":"string","description":"Illustration Source","enum":["EXTERNAL"],"default":"EXTERNAL","example":"EXTERNAL"},"illustrationId":{"type":"string","description":"Unique identifier for the illustration","example":"Q12345"},"customIdentifiers":{"type":"array","items":{"$ref":"#/components/schemas/CustomIdentifier"}},"details":{"$ref":"#/components/schemas/illustrationDetailsPatch"}}},"illustrationDetails":{"type":"object","required":["illustrationId","riskClass","faceAmount","premiumAmount"],"properties":{"leadId":{"type":"string","description":"Associated lead identifier","example":"L12345"},"riskClass":{"type":"string","enum":["ULTRANONTOBACCO","ELITENONTOBACCO","PREFERREDNONTOBACCO","STANDARDNONTOBACCO","STANDARDTOBACCO","STANDARDAGGREGATE","SUBSTANDARDNONTOBACCO","SUBSTANDARDTOBACCO","STANDARDPLUSNONTOBACCO","PREFERREDTOBACCO","STANDARDCONVERSIONNONTOBACCO","STANDARDCONVERSIONTOBACCO"],"description":"Risk classification for the illustration","example":"ULTRANONTOBACCO"},"email":{"type":"string","format":"email","description":"Contact email for the illustration","example":"tKU3e@example.com"},"state":{"$ref":"#/components/schemas/State"},"faceAmount":{"type":"number","format":"double","minimum":0,"description":"Face amount of the policy","example":100},"premiumAmount":{"type":"number","format":"double","minimum":0,"description":"Premium amount","example":100},"paymentTerm":{"type":"string","description":"Term of payment","example":"MONTHLY"},"premiumFrequency":{"type":"string","enum":["DAILY","EVERYTWOWEEKS","MONTHLY","SEMIANNUAL","QUARTERLY","ANNUAL","SINGLEPAYMENT"],"description":"Frequency of premium payments","example":"MONTHLY"},"dateOfBirth":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","description":"Date (with pattern \"yyyy-mm-dd\")","example":"1990-01-01"},"ageAsOfDate":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","description":"Date (with pattern \"yyyy-mm-dd\")","example":"2022-01-01"},"gender":{"type":"string","enum":["MALE","FEMALE","OTHER"],"description":"Gender of the insured","example":"MALE"},"smoker":{"type":"boolean","description":"Smoking status","example":false},"health":{"type":"string","description":"General health status","example":"Good"},"underwritingMethod":{"type":"string","enum":["FULL_UNDERWRITING","SIMPLIFIED_ISSUE","GUARANTEED_ISSUE"],"description":"Method of underwriting","example":"SIMPLIFIED_ISSUE"},"issueAge":{"type":"string","description":"Age at policy issuance","example":"25"},"illustrationDate":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","description":"Date (with pattern \"yyyy-mm-dd\")","example":"2022-01-01"},"cashValue":{"type":"number","format":"double","description":"Cash value of the policy","example":1000},"success":{"type":"boolean","description":"illustration generation success indicator","example":true},"annualIncome":{"type":"number","format":"double","minimum":0,"description":"Annual income of the insured","example":10000},"annualPolicyMgmtFee":{"type":"number","format":"double","minimum":0,"description":"Annual policy management fee","example":100},"additionalPaymentAmount":{"type":"number","format":"double","minimum":0,"description":"Additional payment amount if any","example":100},"pricingVersion":{"type":"string","description":"Version of pricing engine used","example":"1.0"},"matchVersion":{"type":"string","description":"Version of matching algorithm used","example":"1.0"},"matchPercent":{"type":"integer","minimum":0,"maximum":100,"description":"Percentage match for the illustration","example":90},"averageMonthlyCOI":{"type":"number","format":"double","minimum":0,"description":"Average monthly cost of insurance","example":100},"firstMonthCOI":{"type":"number","format":"double","minimum":0,"description":"First month's cost of insurance","example":100},"adminFee":{"type":"number","format":"double","minimum":0,"description":"Administrative fee","example":10},"firstMonthSavings":{"type":"number","format":"double","description":"First month's savings","example":0},"monthlySavings":{"type":"object","required":["minSavings","maxSavings","targetSavings"],"properties":{"minSavings":{"type":"number","format":"double","description":"Minimum monthly savings","example":0},"maxSavings":{"type":"number","format":"double","description":"Maximum monthly savings","example":10000},"targetSavings":{"type":"number","format":"double","description":"Target monthly savings","example":5000}}},"illustrationQuestions":{"type":"array","items":{"type":"object","required":["id","code"],"properties":{"id":{"type":"string","description":"Question identifier","example":"1234567890"},"code":{"type":"string","description":"Question code","example":"1234567890"},"description":{"type":"array","items":{"type":"string"},"description":"Question descriptions","example":["Option 1","Option 2","Option 3"]}}}}}},"illustrationDetailsPatch":{"type":"object","properties":{"leadId":{"type":"string","description":"Associated lead identifier","example":"L12345"},"riskClass":{"type":"string","enum":["ULTRANONTOBACCO","ELITENONTOBACCO","PREFERREDNONTOBACCO","STANDARDNONTOBACCO","STANDARDTOBACCO","STANDARDAGGREGATE","SUBSTANDARDNONTOBACCO","SUBSTANDARDTOBACCO","STANDARDPLUSNONTOBACCO","PREFERREDTOBACCO","STANDARDCONVERSIONNONTOBACCO","STANDARDCONVERSIONTOBACCO"],"description":"Risk classification for the quote","example":"ULTRANONTOBACCO"},"email":{"type":"string","format":"email","description":"Contact email for the quote","example":"tKU3e@example.com"},"state":{"$ref":"#/components/schemas/State"},"faceAmount":{"type":"number","nullable":true,"format":"double","minimum":0,"description":"Face amount of the policy","example":100},"premiumAmount":{"type":"number","nullable":true,"format":"double","minimum":0,"description":"Premium amount","example":100},"paymentTerm":{"type":"string","description":"Term of payment","example":"MONTHLY"},"premiumFrequency":{"type":"string","enum":["DAILY","EVERYTWOWEEKS","MONTHLY","SEMIANNUAL","QUARTERLY","ANNUAL","SINGLEPAYMENT"],"description":"Frequency of premium payments","example":"MONTHLY"},"dateOfBirth":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","description":"Date (with pattern \"yyyy-mm-dd\")","example":"1990-01-01"},"ageAsOfDate":{"type":"string","format":"date","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","description":"Date (with pattern \"yyyy-mm-dd\")","example":"2022-01-01"},"gender":{"type":"string","enum":["MALE","FEMALE","OTHER"],"description":"Gender of the insured","example":"MALE"},"smoker":{"type":"boolean","nullable":true,"description":"Smoking status","example":false},"health":{"type":"string","description":"General health status","example":"Good"},"underwritingMethod":{"type":"string","enum":["FULL_UNDERWRITING","SIMPLIFIED_ISSUE","GUARANTEED_ISSUE"],"description":"Method of underwriting","example":"SIMPLIFIED_ISSUE"},"issueAge":{"type":"string","description":"Age at policy issuance","example":"25"},"quoteDate":{"type":"string","format":"date-time","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})$","description":"Date and time in ISO-8601 format (YYYY-MM-DDTHH:mm:ss.sssZ)","example":"2022-01-01T00:00:00.000Z"},"cashValue":{"type":"number","nullable":true,"format":"double","description":"Cash value of the policy","example":1000},"success":{"type":"boolean","nullable":true,"description":"Quote generation success indicator","example":true},"annualIncome":{"type":"number","nullable":true,"format":"double","minimum":0,"description":"Annual income of the insured","example":10000},"annualPolicyMgmtFee":{"type":"number","nullable":true,"format":"double","minimum":0,"description":"Annual policy management fee","example":100},"additionalPaymentAmount":{"type":"number","nullable":true,"format":"double","minimum":0,"description":"Additional payment amount if any","example":100},"pricingVersion":{"type":"string","description":"Version of pricing engine used","example":"1.0"},"matchVersion":{"type":"string","description":"Version of matching algorithm used","example":"1.0"},"matchPercent":{"type":"integer","nullable":true,"minimum":0,"maximum":100,"description":"Percentage match for the quote","example":90},"averageMonthlyCOI":{"type":"number","nullable":true,"format":"double","minimum":0,"description":"Average monthly cost of insurance","example":100},"firstMonthCOI":{"type":"number","nullable":true,"format":"double","minimum":0,"description":"First month's cost of insurance","example":100},"adminFee":{"type":"number","nullable":true,"format":"double","minimum":0,"description":"Administrative fee","example":10},"firstMonthSavings":{"type":"number","nullable":true,"format":"double","description":"First month's savings","example":0},"monthlySavings":{"type":"object","required":["minSavings","maxSavings","targetSavings"],"properties":{"minSavings":{"type":"number","nullable":true,"format":"double","description":"Minimum monthly savings","example":0},"maxSavings":{"type":"number","nullable":true,"format":"double","description":"Maximum monthly savings","example":10000},"targetSavings":{"type":"number","nullable":true,"format":"double","description":"Target monthly savings","example":5000}}},"quoteQuestions":{"type":"array","items":{"type":"object","required":["id","code"],"properties":{"id":{"type":"string","description":"Question identifier","example":"1234567890"},"code":{"type":"string","description":"Question code","example":"1234567890"},"description":{"type":"array","items":{"type":"string"},"description":"Question descriptions","example":["Option 1","Option 2","Option 3"]}}}}}},"Document":{"type":"object","properties":{"externalDocumentId":{"type":"string","description":"External document identifier","example":"1234567890"},"type":{"type":"string","enum":["NB_APPLICATION","COST_DISCLOSURE","NON_CONTRACTUAL","AGENT_REPORT","ACCELERATED_BENEFIT_RIDER","SURRENDER_COMPARISION","CONSENT_PAPERLESS","TERMS_OF_USE","TERMS_CONDITIONS","CHARITY_ELECTION_FORMS","AUTHORIZATION_FORMS","HIPPA","HIV_CONSENT_FORM_ALL_STATE","AMENDMENT","DISCLOSURES","NB_STATE_REPLACEMENT_NOTICE","TRUSTEE_STATEMENT","TERMS_OF_USE","NOTICE_AND_CONSENT","PRIVACY_POLICY","GLBA_PRIVACY_NOTICE","FCRA","MIB_PRE_NOTICE","ID_VERIFICATION_NOTICE","HIPAA","ACCELERATED_BENEFIT_RIDER","BUYER_GUIDE","ILLUSTRATION","SUITABILITY","APPLICATION","SIGNED_APPLICATION","REPLACEMENTS_ACKNOWLEDGEMENT","1035_EXCHANGE_SURRENDER","EVIDENCE_DOCUMENT","AMENDMENT","ELECTRONIC_FUNDS_TRANSFER","SUPPLEMENTAL_APPLICATION","CONFORMING_ILLUSTRATION","SIGNED_ILLUSTRATION","OVERFLOW_ADDITIONAL_INFORMATION"],"example":"TERMS_OF_USE"},"category":{"type":"string","example":"APPLICATION"}}},"DocumentPatch":{"type":"object","properties":{"externalDocumentId":{"type":"string","description":"External document identifier","example":"1234567890"},"type":{"type":"string","enum":["NB_APPLICATION","COST_DISCLOSURE","NON_CONTRACTUAL","AGENT_REPORT","ACCELERATED_BENEFIT_RIDER","SURRENDER_COMPARISION","CONSENT_PAPERLESS","TERMS_OF_USE","TERMS_CONDITIONS","CHARITY_ELECTION_FORMS","AUTHORIZATION_FORMS","HIPPA","HIV_CONSENT_FORM_ALL_STATE","AMENDMENT","DISCLOSURES","NB_STATE_REPLACEMENT_NOTICE","TRUSTEE_STATEMENT","TERMS_OF_USE","NOTICE_AND_CONSENT","PRIVACY_POLICY","GLBA_PRIVACY_NOTICE","FCRA","MIB_PRE_NOTICE","ID_VERIFICATION_NOTICE","HIPAA","ACCELERATED_BENEFIT_RIDER","BUYER_GUIDE","ILLUSTRATION","SUITABILITY","APPLICATION","SIGNED_APPLICATION","REPLACEMENTS_ACKNOWLEDGEMENT","1035_EXCHANGE_SURRENDER","EVIDENCE_DOCUMENT","AMENDMENT","ELECTRONIC_FUNDS_TRANSFER","SUPPLEMENTAL_APPLICATION","CONFORMING_ILLUSTRATION","SIGNED_ILLUSTRATION","OVERFLOW_ADDITIONAL_INFORMATION"],"example":"TERMS_OF_USE"},"category":{"type":"string","example":"APPLICATION"}}},"Country":{"type":"string","description":"ISO Country Code https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes","enum":["US","CA","RU","EG","ZA","GR","NL","BE","FR","ES","HU","IT","RO","CH","AT","GB","DK","SE","NO","PL","DE","PE","MX","CU","AR","BR","CL","CO","VE","MY","AU","ID","PH","NZ","SG","TH","JP","VN","CN","TR","IN","PK","AF","LK","IR","MA","DZ","TN","LY","GM","SN","MR","ML","GN","BF","NE","TG","BJ","MU","LR","SL","GH","NG","CF","TD","CM","CV","ST","GQ","GA","BS","AO","BB","AX","SD","RW","ET","SO","DJ","KE","TZ","UG","BI","MZ","ZM","MG","RE","ZW","NA","MW","LS","BW","AG","KM","GW","CD","VG","SH","AW","FO","GL","KY","GI","PT","LU","IE","IS","AL","MT","CY","FI","BG","GG","LT","LV","EE","MD","AM","BY","AD","SM","UA","HR","SI","BA","MK","XK","CZ","SK","LI","BM","GD","FK","BZ","GT","SV","HN","NI","CR","PM","HT","PR","VI","GS","SX","BQ","GP","BO","GY","EC","GF","PY","MQ","SR","UY","AN","TC","BL","MF","MS","GU","AQ","BN","NR","PG","TO","SB","VU","FJ","WF","CK","NU","AS","KI","NC","TV","PF","MP","PW","MH","FM","SS","LC","DM","VC","DO","HK","MO","KH","LA","TT","KN","JM","BD","TW","MM","KR","KP","LB","JO","SY","IQ","KW","SA","YE","OM","AE","IL","BH","QA","BT","NP","TJ","TM","AZ","GE","UZ","AI","PA","CI","ER","KZ","KG","CC","MN","BV","SC","IO","WS","TL","TF","YT","PN","SJ","TK","UM","EH","MV","CX","NF","CW","CG","MC","VA","SZ","PS","JE","IM","RS","ME","HM"]},"CountryV2":{"type":"string","example":"US","description":"ISO Country Code https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes","enum":["US","AF","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","CV","KH","CM","CA","KY","CF","TD","CL","CN","CX","CC","CO","KM","CD","CG","CK","CR","HR","CU","CW","CY","CZ","CI","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","SZ","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","MK","RO","RU","RW","RE","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","UY","UZ","VU","VE","VN","VG","VI","WF","XK","EH","YE","ZM","ZW","AX"]},"CountryCallingCodes":{"type":"string","description":"ISO Country calling Code https://en.wikipedia.org/wiki/List_of_telephone_country_codes","enum":["1","93","355","213","1-684","376","244","1-264","672","1-268","54","374","297","61","43","994","1-242","973","880","1-246","375","32","501","229","1-441","975","591","387","267","55","246","673","359","226","257","855","237","238","1-345","236","235","56","86","53","61","57","269","243","242","682","506","225","385","53","357","420","45","253","1-767","1-809","1-829","670","593 ","20","503","240","291","372","251","500","298","679","358","33","594","689","262","241","220","995","49","233","350","44","30","299","1-473","590","1-671","502","224","245","592","509","672","39","504","852","36","354","91","62","98","964","353","972","39","1-876","81","962","7","254","686","850","82","965","996","856","371","961","266","231","218","423","370","352","853","389","261","265","60","960","223","356","692","596","222","230","269","52","691","373","377","976","1-664","212","258","95","264","674","977","31","599","687","64","505","227","234","683","672","1-670","47","968","92","680","970","507","675","595","51","63","64","48","351","1-787","1-939","974 ","262","40","7","7","250","290","1-869","1-758","508","1-784","685","378","239","966","381","221","248","232","65","421","386","677","252","27","500","34","94","249","597","47","268","46","41","963","886","992","255","66","228","690","676","1-868","216","90","993","1-649","688","256","380","971","44","1","246","598","998","678","418","58","84","1-284","1-340","681","212","967","243","260","263"]},"CustomIdentifier":{"type":"object","properties":{"key":{"type":"string","description":"Custom identifier key","example":"ApexQuoteId"},"value":{"type":"string","description":"The value associated with the key","example":"12345"}}},"State":{"type":"string","example":"CA","enum":["AL","AK","AZ","AR","AS","AA","AE","AP","CA","CO","CT","DC","DE","FL","GA","GU","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","MP","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","PR","RI","SC","SD","TN","TX","UT","UM","VT","VA","VI","WA","WV","WI","WY"],"description":"Abbreviated names for states"},"BirthState":{"type":"string","example":"CA","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","AN","XK"],"description":"Only applicable for US born party"},"SignatureV2":{"required":["state","date"],"type":"object","properties":{"date":{"type":"string","description":"Sign Date","example":"2021-01-12"},"city":{"type":"string","description":"City name","example":"Quincy"},"state":{"$ref":"#/components/schemas/State"}}},"SignatureV2Patch":{"type":"object","properties":{"date":{"type":"string","description":"Sign Date","example":"2021-01-12"},"city":{"type":"string","description":"City name","example":"Quincy"},"state":{"$ref":"#/components/schemas/State"}}},"DocumentSuccessResponse":{"type":"object","required":["caseId","correlationId","eappId","documentId"],"properties":{"caseId":{"type":"string","example":"CA000000536"},"correlationId":{"type":"string","example":"15ea7582-262f-4dfe-8a60-1e8b8e763fd4"},"eappId":{"type":"string","example":"15ea7582-262f-4dfe-8a60-1e8b8e763fd4"},"documentId":{"type":"string","example":"67334f4882c412621f9ab7cc"}}}},"examples":{"successTransactionResponse":{"value":{"status":"success","quoteResponse":{"status":"Success","message":"Request successful","data":{"correlationId":"657b717dcf55411abf9ef067","transactionAmounts":{"requestedAmount":25,"calculatedAmount":null,"appliedAmount":25},"policy":{"id":"659fdafc075b950b7bd00feb","event":"InterestCreditMatch","carrierID":"ABC","tpaID":"tpa-12345","lineOfBusiness":"LIFE","planName":"ABC Premium Match","productType":"UNIVERSALLIFE","marketingName":"Everly Life","shortName":"ABCD","distribution":"THIRDPARTYDIRECTTOCONSUMER","banding":"NOPREMIUMBANDING","planCode":"ABC001","glPlanCode":"V2201","holdingForm":"INDIVIDUAL","renewable":null,"qualificationType":"NONQUALIFIED","policyTerm":20,"policyYear":1,"monthOfYear":1,"policyNumber":"BPM0000001","policyStatus":"ACTIVE","nonforfeitureOption":null,"issueType":"FULLUNDERWRITING","residenceState":"VT","issueState":"VT","premiumFrequency":"MONTHLY","currency":"USD","policyStartDate":"2023-12-27","applicationDate":"2023-12-27","issueDate":"2023-12-27","effectiveDate":"2024-01-11T00:00:00.000Z","contestabilityStartDate":"2023-12-27","contestabilityEndDate":"2025-12-26","policyDeliveryDate":"2023-12-27","previousPolicyAnniversaryDate":"2023-12-27","previousPolicyMonthiversaryDate":"2023-12-27","nextAnniversaryDate":"2024-12-27","maturityDate":"2125-12-26","policyTerminationDate":null,"dateOfDeath":null,"initialPaymentExpiryDate":"2024-01-10","nextMonthivesaryDate":"2024-01-27","costBasis":105,"costBasisDate":"2024-11-04","conversionDate":null,"policyValues":{"beginningAcctValue":35.759837,"endingAcctValue":60.759837,"minRequiredAcctValue":0,"acctValueByPolicyYear":0,"unloanedPortionOfAcctValue":60.759837,"loanedPortionOfAcctValue":0,"surrenderValue":60.759837,"netAmountAtRisk":499920,"initialPremiumRequestAmount":80,"initialPremiumAppliedAmount":80,"initialPaymentAmountReceivedDate":"2023-12-27","cumulativePremSinceIssue":105,"totalYTDPremiumAmount":105,"mecAuthorization":false,"projectedLapseIndicator":null,"policyGainAmount":0},"loanValues":{"totalLoanBalance":0,"totalLoanPrincipal":0,"loanPayoffAmount":0,"maxLoanAmount":60.759837,"minLoanAmount":0,"totalLoanAccruedInterest":0,"lastLoanInterestDueDate":null,"totalNumberOfLoan":0,"loanInterestMethod":"ARREARS","totalYTDLoanTaken":0,"loanRepaymentType":null,"minLoanRepayment":1},"withDrawalValues":{"totalWithdrawalAmount":0,"freeWithdrawalAmount":null,"minWithdrawalAmount":1,"maxWithdrawalAmount":60.759837,"annualWithLimNoCovDecrease":null,"maxWithdrawalRequestDuringVestingPeriod":1,"maxWithdrawalRequestAfterVestingPeriod":12,"totalYTDWithdrawalTaken":0,"numberOfWithdrawal":0,"withdrawalAllowedStartDate":"2023-12-27"},"testValues":{"guidelinePremiumTestDate":"2024-11-04","definitionOfLifeInsurance":"GPT","guidelineSinglePremium":68933.997746,"guidelineLevelPremium":5122.813261,"amountExcessToGuideline":0,"totalGuidelineLevelPremiumSinceIssue":5122.813261,"mecTestDate":"2024-11-04","amountExcessToMEC":0,"mecStatusDate":null,"mecStatus":false,"sevenPayTestBasis":185,"sevenPayPremium":25074.702628,"sevenPayStartDate":"2023-12-27","sevenPayPeriod":"2030-12-26","sevenPayLimit":25074.702628,"yearInPeriod":1},"timestamp":"2024-01-11T12:11:40.723Z","deathBenefit":{"deathBenefitOption":"LEVEL","dboEffectiveDate":"2023-12-27","dboChangedEffectiveDate":null,"deathBenefitAgeGuarantee":38},"coverage":{"id":null,"policyDetailsId":null,"ledgerDocId":null,"timestamp":"2024-01-11T12:11:40.731Z","totalCoverageAmount":500000,"cumGrossDeathBenefitAmount":500000,"minCoverageAmount":10000,"maxCoverageAmount":10000000,"coverageChangeEffectiveDate":"2024-12-27","coverageBand":"BAND3","maxAnnualCoverageChangeAllowedPerPolicy":1,"minCoverageDecreaseAmount":10000,"maxCoverageDecreaseAmount":490000,"maxAgeNoCovAmountDecrease":120,"coverageAmountDecreaseAllowed":1,"minCoverageIncreaseAmount":1,"maxCoverageIncreaseAmount":9500000,"maxAgeNoCovAmountIncrease":50,"coverageAmountIncreaseAllowed":1,"coverageLayers":[{"coverageID":"Base_Coverage","coverageType":"Base","coverageName":"ABC Premium Match","productCode":"ABC001","currentAmount":500000,"orignalCoverageAmount":500000,"minCoverageAmount":10000,"maxCoverageAmount":10000000,"grossDeathBenefitAmount":500000,"lowDeathBenefitAmount":500000,"coverageChangeAmount":0,"coverageEffectiveDate":"2023-12-27","coverageChangeEffectiveDate":null,"coverageTerminationDate":null,"unitOfCoverage":500,"valuePerUnitOfCoverage":1000,"premiumFrequency":null,"guidelineSinglePremium":68933.997746,"guidelineLevelPremium":5122.813261,"sevenPayPremium":25074.702628,"coverageParticipants":[{"partyID":"Party_PI_1","issueAge":18,"riskClass":"Standard Tobacco","subStandardRating":"None","flatExtra":[{"flatExtraType":null,"flatExtraDuration":0,"flatExtraAmount":0,"flatExtraStartDate":null}]}]},{"coverageID":"Rider_ABCLCHR","coverageType":"RIDER","coverageName":"Chronic Illness Accelerated Death Benefit Rider","productCode":"ABCLCHR","currentAmount":null,"orignalCoverageAmount":null,"minCoverageAmount":null,"maxCoverageAmount":null,"grossDeathBenefitAmount":null,"lowDeathBenefitAmount":null,"coverageChangeAmount":0,"coverageEffectiveDate":"2023-12-27","coverageChangeEffectiveDate":null,"coverageTerminationDate":"2125-12-26","unitOfCoverage":null,"valuePerUnitOfCoverage":null,"premiumFrequency":null,"guidelineSinglePremium":null,"guidelineLevelPremium":null,"sevenPayPremium":null,"coverageParticipants":[{"partyID":"Party_PI_1","issueAge":18,"riskClass":null,"subStandardRating":null,"flatExtra":[]}]},{"coverageID":"Rider_ABCLCRI","coverageType":"RIDER","coverageName":"Critical Illness Accelerated Death Benefit Rider","productCode":"ABCLCRI","currentAmount":null,"orignalCoverageAmount":null,"minCoverageAmount":null,"maxCoverageAmount":null,"grossDeathBenefitAmount":null,"lowDeathBenefitAmount":null,"coverageChangeAmount":0,"coverageEffectiveDate":"2023-12-27","coverageChangeEffectiveDate":null,"coverageTerminationDate":"2125-12-26","unitOfCoverage":null,"valuePerUnitOfCoverage":null,"premiumFrequency":null,"guidelineSinglePremium":null,"guidelineLevelPremium":null,"sevenPayPremium":null,"coverageParticipants":[{"partyID":"Party_PI_1","issueAge":18,"riskClass":null,"subStandardRating":null,"flatExtra":[]}]},{"coverageID":"Rider_ABCLTRM","coverageType":"RIDER","coverageName":"Terminal Illness Accelerated Death Benefit Rider","productCode":"ABCLTRM","currentAmount":null,"orignalCoverageAmount":null,"minCoverageAmount":null,"maxCoverageAmount":null,"grossDeathBenefitAmount":null,"lowDeathBenefitAmount":null,"coverageChangeAmount":0,"coverageEffectiveDate":"2023-12-27","coverageChangeEffectiveDate":null,"coverageTerminationDate":"2125-12-26","unitOfCoverage":null,"valuePerUnitOfCoverage":null,"premiumFrequency":null,"guidelineSinglePremium":null,"guidelineLevelPremium":null,"sevenPayPremium":null,"coverageParticipants":[{"partyID":"Party_PI_1","issueAge":18,"riskClass":null,"subStandardRating":null,"flatExtra":[]}]},{"coverageID":"Rider_OPR","coverageType":"RIDER","coverageName":"Overloan Protection Rider","productCode":"ABCLOPR","currentAmount":null,"orignalCoverageAmount":null,"minCoverageAmount":null,"maxCoverageAmount":null,"grossDeathBenefitAmount":null,"lowDeathBenefitAmount":null,"coverageChangeAmount":0,"coverageEffectiveDate":"2023-12-27","coverageChangeEffectiveDate":null,"coverageTerminationDate":"2125-12-26","unitOfCoverage":null,"valuePerUnitOfCoverage":null,"premiumFrequency":null,"guidelineSinglePremium":null,"guidelineLevelPremium":null,"sevenPayPremium":null,"coverageParticipants":[{"partyID":"Party_PI_1","issueAge":18,"riskClass":null,"subStandardRating":null,"flatExtra":[]}]}],"version":1},"riders":[{"id":null,"policyDetailsId":null,"ledgerDocId":null,"timestamp":"2024-01-11T12:11:40.729Z","type":"RIDER","riderName":"Chronic Illness Accelerated Death Benefit Rider","riderElected":"ELECTED","riderCode":"ABCLCHR","effectiveDate":"2023-12-27","terminationDate":"2125-12-26","status":"ACTIVE","coverageID":"Rider_ABCLCHR","amount":null,"riderParticipant":[{"insuredID":"Party_PI_1","insuredAgeAtIssue":18}],"charge":{"chargeID":null,"value":null,"effectiveRate":null,"nextEvaluationDate":null},"riderExerciseCharge":null,"maxChronicIllnessBenefitPct":50,"maxPeriodicPaymentPeriod":120,"claimStatus":null,"riderExerciseChargeRate":null,"nextEvaluationDate":null,"riderPaymentDate":null,"riderPaymentAmount":null,"paymentMode":null,"paymentOption":null,"maxCriticalIllnessBenefitPct":null,"t1MaxCriticalIllnessBenefitPct":null,"t1MaxCriticalIllnessBenefitAmount":null,"t2MaxCriticalIllnessBenefitPct":null,"t2MaxCriticalIllnessBenefitAmount":null,"t1CriticalRiderPaymentDate":null,"t1CriticalRiderPaymentAmount":null,"t2CriticalRiderPaymentDate":null,"t2CriticalRiderPaymentAmount":null,"terminalRiderPaymentAmount":null,"version":1},{"id":null,"policyDetailsId":null,"ledgerDocId":null,"timestamp":"2024-01-11T12:11:40.729Z","type":"RIDER","riderName":"Critical Illness Accelerated Death Benefit Rider","riderElected":"ELECTED","riderCode":"ABCLCRI","effectiveDate":"2023-12-27","terminationDate":"2125-12-26","status":"ACTIVE","coverageID":"Rider_ABCLCRI","amount":null,"riderParticipant":[{"insuredID":"Party_PI_1","insuredAgeAtIssue":18}],"charge":{"chargeID":null,"value":null,"effectiveRate":null,"nextEvaluationDate":null},"riderExerciseCharge":null,"maxChronicIllnessBenefitPct":null,"maxPeriodicPaymentPeriod":null,"claimStatus":null,"riderExerciseChargeRate":null,"nextEvaluationDate":null,"riderPaymentDate":null,"riderPaymentAmount":null,"paymentMode":null,"paymentOption":null,"maxCriticalIllnessBenefitPct":50,"t1MaxCriticalIllnessBenefitPct":5,"t1MaxCriticalIllnessBenefitAmount":5000,"t2MaxCriticalIllnessBenefitPct":50,"t2MaxCriticalIllnessBenefitAmount":500000,"t1CriticalRiderPaymentDate":null,"t1CriticalRiderPaymentAmount":null,"t2CriticalRiderPaymentDate":null,"t2CriticalRiderPaymentAmount":null,"terminalRiderPaymentAmount":null,"version":1},{"id":null,"policyDetailsId":null,"ledgerDocId":null,"timestamp":"2024-01-11T12:11:40.729Z","type":"RIDER","riderName":"Overloan Protection Rider","riderElected":"ELECTED","riderCode":"ABCLOPR","effectiveDate":"2023-12-27","terminationDate":"2125-12-26","status":"ACTIVE","coverageID":"Rider_ABCLOPR","amount":null,"riderParticipant":[{"insuredID":"Party_PI_1","insuredAgeAtIssue":18}],"charge":{"chargeID":null,"value":null,"effectiveRate":null,"nextEvaluationDate":null},"riderExerciseCharge":null,"maxChronicIllnessBenefitPct":null,"maxPeriodicPaymentPeriod":null,"claimStatus":null,"riderExerciseChargeRate":null,"nextEvaluationDate":null,"riderPaymentDate":null,"riderPaymentAmount":null,"paymentMode":null,"paymentOption":null,"maxCriticalIllnessBenefitPct":null,"t1MaxCriticalIllnessBenefitPct":null,"t1MaxCriticalIllnessBenefitAmount":null,"t2MaxCriticalIllnessBenefitPct":null,"t2MaxCriticalIllnessBenefitAmount":null,"t1CriticalRiderPaymentDate":null,"t1CriticalRiderPaymentAmount":null,"t2CriticalRiderPaymentDate":null,"t2CriticalRiderPaymentAmount":null,"terminalRiderPaymentAmount":null,"version":1},{"id":null,"policyDetailsId":null,"ledgerDocId":null,"timestamp":"2024-01-11T12:11:40.729Z","type":"RIDER","riderName":"Terminal Illness Accelerated Death Benefit Rider","riderElected":"ELECTED","riderCode":"ABCLTRM","effectiveDate":"2023-12-27","terminationDate":"2125-12-26","status":"ACTIVE","coverageID":"Rider_ABCLTRM","amount":null,"riderParticipant":[{"insuredID":"Party_PI_1","insuredAgeAtIssue":18}],"charge":{"chargeID":null,"value":null,"effectiveRate":null,"nextEvaluationDate":null},"riderExerciseCharge":null,"maxChronicIllnessBenefitPct":null,"maxPeriodicPaymentPeriod":null,"claimStatus":null,"riderExerciseChargeRate":null,"nextEvaluationDate":null,"riderPaymentDate":null,"riderPaymentAmount":null,"paymentMode":null,"paymentOption":null,"maxCriticalIllnessBenefitPct":null,"t1MaxCriticalIllnessBenefitPct":null,"t1MaxCriticalIllnessBenefitAmount":null,"t2MaxCriticalIllnessBenefitPct":null,"t2MaxCriticalIllnessBenefitAmount":null,"t1CriticalRiderPaymentDate":null,"t1CriticalRiderPaymentAmount":null,"t2CriticalRiderPaymentDate":null,"t2CriticalRiderPaymentAmount":null,"terminalRiderPaymentAmount":null,"version":1}],"systematicPrograms":[{"id":null,"policyDetailsId":null,"ledgerDocId":null,"timestamp":"2024-01-11T12:11:40.730Z","arrType":"PAYMENT","arrangementID":"Arr_1","allocationOptionType":"DOLLAR","reason":"PREMIUMREASON","numberOfOccurrence":null,"loanRepaymentType":null,"disbursementType":null,"status":"ACTIVE","paymentForm":"EFT","frequency":"MONTHLY","requestedDate":"2023-12-27","startDate":"2024-01-27","endDate":"2043-11-27","lastActivityDate":"2023-12-27","nextActivityDate":"2024-01-27","amountType":"AMOUNT","amount":80,"payors":[{"partyRole":"Payee","partyID":"Party_PI_1","bankId":"Bank_1","percentage":100}],"payees":null,"version":1}],"policyFeatures":[{"id":null,"policyDetailsId":null,"ledgerDocId":null,"timestamp":"2024-01-11T12:11:40.733Z","featureType":"freeLook","startDate":null,"endDate":"2024-01-26","status":null,"period":30,"effectiveDate":null,"totalRequiredAmount":null,"totalMinRequiredAmount":null,"paymentAmount":null,"totalPaymentAmount":null,"uwDecision":null,"approvalDate":null,"version":1},{"id":null,"policyDetailsId":null,"ledgerDocId":null,"timestamp":"2024-01-11T12:11:40.733Z","featureType":"lapseAssessment","startDate":null,"endDate":null,"status":false,"period":null,"effectiveDate":null,"totalRequiredAmount":null,"totalMinRequiredAmount":null,"paymentAmount":null,"totalPaymentAmount":null,"uwDecision":null,"approvalDate":null,"version":1},{"id":null,"policyDetailsId":null,"ledgerDocId":null,"timestamp":"2024-01-11T12:11:40.733Z","featureType":"lapseProtection","startDate":"2023-12-27","endDate":"2043-12-26","status":null,"period":20,"effectiveDate":null,"totalRequiredAmount":null,"totalMinRequiredAmount":null,"paymentAmount":51.78,"totalPaymentAmount":51.78,"uwDecision":null,"approvalDate":null,"version":1},{"id":null,"policyDetailsId":null,"ledgerDocId":null,"timestamp":"2024-01-11T12:11:40.733Z","featureType":"reinstatement","startDate":null,"endDate":null,"status":null,"period":null,"effectiveDate":null,"totalRequiredAmount":null,"totalMinRequiredAmount":null,"paymentAmount":null,"totalPaymentAmount":null,"uwDecision":null,"approvalDate":null,"version":1}],"allocation":{"id":null,"policyDetailsId":null,"ledgerDocId":null,"timestamp":"2024-01-11T12:11:40.732Z","investmentType":"INVESTMENTFUND","modelName":null,"modelID":null,"fundAllocationsInvestments":[{"fundID":"FundAccount1","fundName":"Fixed Fund 2","fundAccountType":null,"allocPercent":100,"startDate":"2023-12-27","endDate":null}],"funds":[{"fundAccountType":null,"fundID":"FundAccount1","fundName":"Fixed Fund","glFundCode":"V2201","totalFundValue":60.759837,"fundSegments":[{"segmentID":"1","fundID":null,"originalDepositAmount":80,"originalDepositDate":"2023-12-27","depositDate":"2024-11-04","depositAmount":25,"currentAmount":60.759837,"renewalDate":null,"numberOfUnits":null,"sweepAccountID":null,"startDate":"2023-12-27","endDate":null}]}],"matchSegment":{"segmentID":"Match1","matchAccountValue":1.05129,"cumulativeMatchPaymentAmount":1.05,"ytdMatchValue":1.05,"maxLifeTimeVestingAmount":500,"maxAnnVestingAmount":500,"minPaymentsForMatch":0,"matchVestingDate":"2034-12-26","glFundCode":"V2201","vestingPeriod":10},"loanSegments":[],"version":1},"version":40}},"error":null}}},"failureTransactionResponse":{"value":{"status":"failure","validationResult":[{"errorCode":"BPM.NM.005","attribute":null,"error":"Amount request is invalid.","resolution":"Please check the One Time Premium Amount and submit the request again."},{"errorCode":"BPM.NM.003","attribute":null,"error":"Party information does not match with information in the Zahara system.","resolution":"Please validate the party information and submit the request again."}]}},"validationFailureResponse":{"value":{"timestamp":"2024-10-08T13:23:10.124Z","errorId":"a4a57ed0-2c1b-4922-9959-3b85dd8a96d3","message":"JSON Valdiation fails with error","error":["attribute can not be null","attribute should be in proper format"]}},"successTransactionResponsewithoutQuote":{"value":{"status":"success"}}},"securitySchemes":{"Auth0":{"type":"openIdConnect","openIdConnectUrl":"https://login.dev.zinnia.com/.well-known/openid-configuration","x-kong-security-openid-connect":{"config":{"run_on_preflight":true,"scopes_claim":["https://dev.api.zinnia.io/permissions"],"audience_claim":["aud"],"audience_required":["https://dev.api.zinnia.io"],"client_id":["client_id"],"auth_methods":["bearer"]},"enabled":true,"protocols":["grpc","grpcs","http","https"]}}}}}
```
