--- title: "FormMetadataModel" url: "https://developers.zinnia.com/apis/case-management-1-0-0/versions/0091226b-6452-4e75-93ce-4bbfe022aad5/schemas/FormMetadataModel" --- > Full API specification: https://developers.zinnia.com/apis/case-management-1-0-0/versions/0091226b-6452-4e75-93ce-4bbfe022aad5.md # FormMetadataModel ## OpenAPI definition ```yaml openapi: 3.0.3 info: title: Case Management API version: 1.0.0 servers: - url: https://dev.api.zinnia.io/ description: Dev Environment - url: https://qa.api.zinnia.io/ description: QA Environment - url: https://uat.api.zinnia.io/ description: UAT Environment - url: https://api.zinnia.io/ description: PROD Environment components: schemas: FormMetadataModel: type: object properties: formId: type: string example: 67056202d7795c98bf36f5f1 process: type: string example: New Business carrier: type: string example: Carrier_1 taskType: type: string example: Suitability formSchema: type: object properties: $schema: type: string example: http://json-schema.org/draft-07/schema# title: type: string example: Suitability form type: type: string example: object properties: applicantInformation: type: object properties: applicantNameFirst: type: string title: First name pattern: ^[a-zA-Z]+$ applicantNameMI: type: string title: MI maxLength: 1 applicantNameLast: type: string title: Last name applicantAge: type: number title: Age minimum: 0 stateSignedAt: type: string title: State Signed at* enum: - Colorado - Wyoming description: "*Non-resident form is required if different than resident state." ssnTaxId: type: string title: "SSN/Tax ID #" pattern: ^\d{3}-\d{2}-\d{4}$ employment: type: object properties: employmentStatus: type: array title: Employment Status items: type: string enum: - Employed - Unemployed - Retired - Disabled uniqueItems: true required: - employmentStatus jointApplicantInformation: type: object properties: jointApplicantNameFirst: type: string title: First Name jointApplicantNameMI: type: string title: MI maxLength: 1 jointApplicantNameLast: type: string title: Last Name jointApplicantAge: type: number title: Age minimum: 0 employment: type: object properties: jointEmploymentStatus: type: array title: Employment Status items: type: string enum: - Employed - Unemployed - Retired - Disabled uniqueItems: true required: - jointEmploymentStatus annuityInformation: type: object properties: annuityProductName: type: string title: Annuity Product Name anticipatedAmount: type: number title: Anticipated Amount $ annuityType: type: string title: Annuity Type enum: - Qualified - Non-qualified financialInformation: type: object properties: approximateAnnualIncome: type: number title: Approximate annual income $ sourceOfIncome: type: string title: Source of Income approximateAnnualLivingExpenses: type: number title: Approximate annual living expenses $ disposableIncome: type: number title: Disposable income (question a. minus question b.) anticipatedExpenseIncomeChange: type: object properties: anticipated: type: boolean title: Do you anticipate a significant increase in living expenses or decrease in annual income or liquid assets during the surrender charge period of the annuity? totalAssets: type: number title: Approximate total assets totalDebt: type: number title: Approximate total debt description: Includes mortgages on properties (excluding any mortgages or debt owed on the Applicant's primary residence), credit card debt, automobile loan or lease payments, student loans, and the outstanding balances of any other amounts owed. netWorth: type: number title: Approximate net worth description: Question e. minus question f. residenceType: type: string title: Where do you currently reside? enum: - Personal residence - With family members - Nursing home - Assisted living facility sufficientFunds: type: object properties: hasSufficientFunds: type: string title: Do you have sufficient funds or other assets available, without penalty, for living expenses and in case of emergencies? enum: - Yes - No federalIncomeTaxBracket: type: object properties: taxBracket: type: string title: Federal income tax bracket enum: - 0% - 10% - 12% - 22% - 24% - 32% - 35% - 37% - Other liquidAssetsAfterPurchase: type: number title: Approximate liquid assets after annuity purchase appliedForGovrnmentBenefits: type: boolean title: California Residents Only - Has the Applicant applied, or does the Applicant intend to apply for, means-tested government benefits, including, but not limited to, Medi-Cal or the veterans' aid and attendance benefit? basisOfRecommendation: type: object properties: reason: type: string title: Explain your reasons for recommending to the Applicant that they purchase this annuity, including how the annuity and its features will effectively address the Applicant`s insurance needs and financial objectives. Include the advantages and disadvantages considered as part of the recommendation. uiSchema: type: object properties: applicantInformation: type: object properties: applicantNameFirst: type: object properties: ui: type: object properties: placeholder: type: string example: First name helpText: type: string example: Applicant's first name applicantNameLast: type: object properties: ui: type: object properties: placeholder: type: string example: Last name helpText: type: string example: Applicant's last name basisOfRecommendation: type: object properties: reason: type: object properties: ui: type: object properties: widget: type: string example: textarea schemaContent: type: object additionalProperties: true description: Additional data related to the task example: {} ```