--- title: "ApplicationResponse" url: "https://developers.zinnia.com/apis/new-business/versions/b8532e16-b28e-4393-9305-def50b91e40e/schemas/ApplicationResponse" --- > Full API specification: https://developers.zinnia.com/apis/new-business/versions/b8532e16-b28e-4393-9305-def50b91e40e.md # ApplicationResponse ## OpenAPI definition ```yaml openapi: 3.1.0 info: title: Zinnia New Business API. version: 0.9.8 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 components: schemas: 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" 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" 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" 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'] - 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'] - If fundType VARIABLE, allowed fundName any string example: Fixed Account percentage: type: string description: Percentage example: "100" payment: $ref: "#/components/schemas/PaymentV2Patch" 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. 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" 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 - Default = False 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 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 - Default = False 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 - Default = False example: false restrictionIndicator: type: boolean description: Indicates if there is a collateral assignee on existing policy.Default = False. example: false 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" 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 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 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 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 NonforfeitureOption: allOf: - type: object properties: nonForFeitureOption: type: string enum: - AUTOMATICPOLICYLOAN - REDUCEDPAIDUP description: Type of policy restriction example: REDUCEDPAIDUP 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" 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: [] 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 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: [] 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" 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: [] 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: [] 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" 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" 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" 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" 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: [] 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: [] 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 ExclusionReview: type: object properties: description: type: string description: Result description example: Aviation Activities reasonCode: type: string enum: - AVIATION - SCUBA description: Reason code example: AVIATION 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 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 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" 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 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" 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" 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 PassportIdentifierResponse: allOf: - $ref: "#/components/schemas/GovernmentIssuedIdentifierPatch" - type: object properties: countryOfIssue: $ref: "#/components/schemas/CountryV2" StateIdIdentifierResponse: allOf: - $ref: "#/components/schemas/GovernmentIssuedIdentifierPatch" - type: object properties: jurisdiction: $ref: "#/components/schemas/State" 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 SsnIdentifierResponse: allOf: - $ref: "#/components/schemas/IdentifierPatch" - type: object properties: lastFourOnly: type: boolean description: Indicates if only the last four digits are provided example: true ItinIdentifierResponse: allOf: - $ref: "#/components/schemas/IdentifierPatch" - type: object properties: issueYear: type: string pattern: ^\d{4}$ description: Year when the ITIN 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" 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 ExternalPartyIdentifierResponse: allOf: - $ref: "#/components/schemas/ExternalIdentifierPatch" 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 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 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 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" 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 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" 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" 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" 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" 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" 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" 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" 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" 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" 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" 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 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" 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" 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" 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 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 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" 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 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 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" IdentifierStatus: type: string enum: - ACTIVE - EXPIRED - SUSPENDED - REVOKED - PENDING description: Status of the identifier document example: ACTIVE IdentifierType: type: string enum: - PASSPORT - STATEPHOTOID - DRIVERLICENSENUMBER - SSN - TIN - EIN - EXTERNAL - OTHER description: Type of identifier document 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" ```