{
  "type": "object",
  "required": [
    "month",
    "numberOfCredits",
    "totalCreditsAmount",
    "largestCredit",
    "numberOfCreditsLessTransfers",
    "totalCreditsAmountLessTransfers",
    "averageCreditAmount",
    "estimatedNumberOfLoanDeposits",
    "estimatedLoanDepositAmount"
  ],
  "properties": {
    "month": {
      "type": "integer",
      "format": "int64",
      "example": 1512111600,
      "description": "One instance for each complete calendar month in the report"
    },
    "largestCredit": {
      "type": "number",
      "example": 3000.49,
      "description": "Largest credit by month across all accounts"
    },
    "numberOfCredits": {
      "type": "string",
      "example": "57",
      "description": "Number of credits by month across all accounts"
    },
    "totalCreditsAmount": {
      "type": "number",
      "example": 3479.39,
      "description": "Total amount of credits by month across all accounts"
    },
    "averageCreditAmount": {
      "type": "number",
      "example": 500,
      "description": "The average credit amount"
    },
    "estimatedLoanDepositAmount": {
      "type": "number",
      "example": 0,
      "description": "The estimated loan deposit amount by month"
    },
    "numberOfCreditsLessTransfers": {
      "type": "string",
      "example": "5",
      "description": "Number of credits by month (less transfers) across all accounts"
    },
    "estimatedNumberOfLoanDeposits": {
      "type": "string",
      "example": "0",
      "description": "The estimated number of loan deposits by month"
    },
    "totalCreditsAmountLessTransfers": {
      "type": "number",
      "example": 25.46,
      "description": "Total amount of credits by month (less transfers) across all accounts"
    }
  }
}

{
  "type": "object",
  "required": [
    "month",
    "numberOfCredits",
    "totalCreditsAmount",
    "largestCredit",
    "numberOfCreditsLessTransfers",
    "totalCreditsAmountLessTransfers",
    "averageCreditAmount",
    "estimatedNumberOfLoanDeposits",
    "estimatedLoanDepositAmount"
  ],
  "properties": {
    "month": {
      "type": "integer",
      "format": "int64",
      "example": 1512111600,
      "description": "One instance for each complete calendar month in the report"
    },
    "largestCredit": {
      "type": "number",
      "example": 2000,
      "description": "Largest credit by month"
    },
    "numberOfCredits": {
      "type": "string",
      "example": "3",
      "description": "Number of credits by month"
    },
    "totalCreditsAmount": {
      "type": "number",
      "example": 5000,
      "description": "Total amount of credits by month"
    },
    "averageCreditAmount": {
      "type": "number",
      "example": 500,
      "description": "The average credit amount"
    },
    "estimatedLoanDepositAmount": {
      "type": "number",
      "example": 0,
      "description": "The estimated loan deposit amount"
    },
    "numberOfCreditsLessTransfers": {
      "type": "string",
      "example": "2",
      "description": "Number of credits by month (less transfers)"
    },
    "estimatedNumberOfLoanDeposits": {
      "type": "string",
      "example": "0",
      "description": "The estimated number of loan deposits"
    },
    "totalCreditsAmountLessTransfers": {
      "type": "number",
      "example": 4000,
      "description": "Total amount of credits by month (less transfers)"
    }
  }
}

{
  "type": "object",
  "required": [
    "month",
    "numberOfDebits",
    "totalDebitsAmount",
    "largestDebit",
    "numberOfDebitsLessTransfers",
    "totalDebitsAmountLessTransfers",
    "averageDebitAmount"
  ],
  "properties": {
    "month": {
      "type": "integer",
      "format": "int64",
      "example": 1512111600,
      "description": "One instance for each complete calendar month in the report"
    },
    "largestDebit": {
      "type": "number",
      "example": -20000,
      "description": "Largest Debit by month"
    },
    "numberOfDebits": {
      "type": "string",
      "example": "1500",
      "description": "Number of Debits by month across all accounts"
    },
    "totalDebitsAmount": {
      "type": "number",
      "example": -12345.46,
      "description": "Total Amount of Debits by month across all accounts"
    },
    "averageDebitAmount": {
      "type": "number",
      "example": 500,
      "description": "The average debit amount"
    },
    "numberOfDebitsLessTransfers": {
      "type": "string",
      "example": "5",
      "description": "Number of Debits by month (less transfers)"
    },
    "totalDebitsAmountLessTransfers": {
      "type": "number",
      "example": -2000,
      "description": "Total amount of debits by month (less transfers)"
    }
  }
}

{
  "type": "object",
  "required": [
    "month",
    "numberOfDebits",
    "totalDebitsAmount",
    "largestDebit",
    "numberOfDebitsLessTransfers",
    "totalDebitsAmountLessTransfers",
    "averageDebitAmount"
  ],
  "properties": {
    "month": {
      "type": "integer",
      "format": "int64",
      "example": 1512111600,
      "description": "One instance for each complete calendar month in the report"
    },
    "largestDebit": {
      "type": "number",
      "example": -2000,
      "description": "Largest Debit by month"
    },
    "numberOfDebits": {
      "type": "string",
      "example": "5",
      "description": "Number of Debits by month"
    },
    "totalDebitsAmount": {
      "type": "number",
      "example": -12345,
      "description": "Total Amount of Debits by month"
    },
    "averageDebitAmount": {
      "type": "number",
      "example": 500,
      "description": "The average debit amount"
    },
    "numberOfDebitsLessTransfers": {
      "type": "string",
      "example": "3",
      "description": "Number of Debits by month (less transfers)"
    },
    "totalDebitsAmountLessTransfers": {
      "type": "number",
      "example": -2000,
      "description": "Total amount of debits by month (less transfers)"
    }
  }
}

{
  "type": "object",
  "properties": {
    "insufficientFundFees": {
      "$ref": "#/components/schemas/CashFlowInsufficientFundsFees"
    }
  },
  "description": "Transactions that may be warning signs of bad creditworthiness"
}

{
  "type": "object",
  "required": [
    "historicNumberOfWeeksZeroTransactions",
    "historicNumberOfWeeksWithDataAvailable",
    "historicWeeksWithZeroTransactions"
  ],
  "properties": {
    "historicWeeksWithZeroTransactions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ObbWeekOfYear"
      },
      "description": "List of weeks with zero reported transactions"
    },
    "historicNumberOfWeeksZeroTransactions": {
      "type": "integer",
      "example": 5,
      "description": "Number of weeks during known history of account where zero transactions were posted"
    },
    "historicNumberOfWeeksWithDataAvailable": {
      "type": "integer",
      "example": 10,
      "description": "Number of weeks during known history of account in which data was available"
    }
  },
  "description": "Weeks with zero transactions during the known history of the account"
}

{
  "type": "object",
  "required": [
    "minimumWithdrawalByMonthForTheReportTimePeriod",
    "maximumWithdrawalByMonthForTheReportTimePeriod",
    "sumWithdrawalsByMonthForTheReportTimePeriod",
    "countWithdrawalsByMonthForTheReportTimePeriod",
    "historicCountOfWithdrawalTransactions"
  ],
  "properties": {
    "historicSumOfWithdrawals": {
      "type": "number",
      "example": 925.66,
      "description": "Sum of ALL withdrawals over entire known history of the account (may exceed requested length of report)"
    },
    "historicCountOfWithdrawalTransactions": {
      "type": "integer",
      "example": 20,
      "description": "Count of ALL withdrawals over entire known history of the account (may exceed requested length of report)"
    },
    "sumWithdrawalsByMonthForTheReportTimePeriod": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ObbDateRangeAndAmount"
      },
      "description": "Sum of all withdrawals during periods in the report"
    },
    "countWithdrawalsByMonthForTheReportTimePeriod": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ObbDateRangeAndCount"
      },
      "description": "Count of all withdrawals during periods in the report"
    },
    "averageWithdrawalByMonthForTheReportTimePeriod": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ObbDateRangeAndAmount"
      },
      "description": "Average value of withdrawals during periods in the report"
    },
    "maximumWithdrawalByMonthForTheReportTimePeriod": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ObbDateRangeAndAmount"
      },
      "description": "Maximum withdrawal value for different periods in the report"
    },
    "minimumWithdrawalByMonthForTheReportTimePeriod": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ObbDateRangeAndAmount"
      },
      "description": "Minimum withdrawal value for different periods in the report"
    }
  },
  "description": "Outflow attributes"
}

{
  "type": "object",
  "required": [
    "institutions"
  ],
  "properties": {
    "institutions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CashFlowPossibleLoanDepositsInstitutions"
      },
      "description": "A list of loan deposit institutions"
    }
  }
}

{
  "type": "object",
  "required": [
    "id",
    "ownerName",
    "ownerAddress",
    "name",
    "number",
    "type",
    "aggregationStatusCode",
    "currentBalance",
    "availableBalance",
    "balanceDate",
    "transactions"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "6681984",
      "description": "Finicity account ID"
    },
    "name": {
      "type": "string",
      "example": "Checking",
      "description": "The account name from the institution"
    },
    "type": {
      "type": "string",
      "example": "checking",
      "description": "CFR: `ALL` (`checking` / `savings` / `loan` / `mortgage` / `credit card` / `CD` / `MM` / `investment`...)"
    },
    "number": {
      "type": "string",
      "example": "XX1111",
      "description": "The account number from the institution (obfuscated)"
    },
    "ownerName": {
      "$ref": "#/components/schemas/ReportAccountOwnerName"
    },
    "balanceDate": {
      "type": "integer",
      "format": "int64",
      "example": 1614880526,
      "description": "A timestamp showing when the `balance` was captured"
    },
    "ownerAddress": {
      "$ref": "#/components/schemas/ReportAccountOwnerAddress"
    },
    "transactions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ReportTransaction"
      },
      "description": "a list of transaction records"
    },
    "currentBalance": {
      "type": "number",
      "example": 100000,
      "description": "The cleared balance of the account as-of `balanceDate`"
    },
    "availableBalance": {
      "type": "number",
      "example": 1000,
      "description": "Available balance"
    },
    "aggregationStatusCode": {
      "type": "integer",
      "example": 0,
      "description": "The status of the most recent aggregation attempt for this account (non-zero means the account was not accessed successfully for this report, and additional fields for this account may not be reliable)"
    }
  }
}

{
  "type": "object",
  "required": [
    "id",
    "name",
    "urlHomeApp",
    "accounts"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "102105",
      "description": "Finicity institution ID"
    },
    "name": {
      "type": "string",
      "example": "FinBank Profiles",
      "description": "Finicity institution name"
    },
    "accounts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CashFlowPossibleLoanDepositsAccount"
      },
      "description": "A list of account records"
    },
    "urlHomeApp": {
      "type": "string",
      "example": "http://www.finbank.com",
      "description": "The URL of the Financial Institution"
    }
  }
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/BaseReportAckWithPortfolioId"
    },
    {
      "type": "object",
      "properties": {
        "days": {
          "type": "integer",
          "example": 730,
          "description": "Number of days covered by the report"
        },
        "endDate": {
          "$ref": "#/components/schemas/ReportEndDate"
        },
        "seasoned": {
          "type": "boolean",
          "example": true,
          "description": "\"true\" if the report covers more than 365 days"
        },
        "startDate": {
          "$ref": "#/components/schemas/ReportStartDate"
        },
        "institutions": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/ReportInstitution"
          },
          "description": "A list of institution records, including information about the individual accounts used in this report"
        },
        "cashFlowDebitSummary": {
          "$ref": "#/components/schemas/CashFlowCashFlowDebitSummary"
        },
        "possibleLoanDeposits": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/CashFlowPossibleLoanDeposits"
          },
          "description": "A possible loan deposits record"
        },
        "cashFlowCreditSummary": {
          "$ref": "#/components/schemas/CashFlowCashFlowCreditSummary"
        },
        "cashFlowBalanceSummary": {
          "$ref": "#/components/schemas/CashFlowCashFlowBalanceSummary"
        },
        "cashFlowCharacteristicsSummary": {
          "$ref": "#/components/schemas/CashFlowCashFlowCharacteristicsSummary"
        }
      }
    }
  ],
  "description": "A Cash Flow report"
}

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "example": 6681984,
      "description": "Finicity account ID"
    },
    "name": {
      "type": "string",
      "example": "Checking",
      "description": "The account name from the institution"
    },
    "type": {
      "type": "string",
      "example": "checking",
      "description": "CFR: `ALL` (`checking` / `savings` / `loan` / `mortgage` / `credit card` / `CD` / `MM` / `investment`...)"
    },
    "number": {
      "type": "string",
      "example": "XX1111",
      "description": "The account number from the institution (obfuscated)"
    },
    "ownerName": {
      "$ref": "#/components/schemas/ReportAccountOwnerName"
    },
    "balanceDate": {
      "type": "integer",
      "format": "int64",
      "example": 1614880526,
      "description": "A timestamp showing when the `balance` was captured"
    },
    "ownerAddress": {
      "$ref": "#/components/schemas/ReportAccountOwnerAddress"
    },
    "transactions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ReportTransaction"
      },
      "description": "a list of transaction records"
    },
    "cashFlowDebit": {
      "$ref": "#/components/schemas/CashFlowCashFlowDebit"
    },
    "cashFlowCredit": {
      "$ref": "#/components/schemas/CashFlowCashFlowCredit"
    },
    "currentBalance": {
      "type": "number",
      "example": 100000,
      "description": "The cleared balance of the account as-of `balanceDate`"
    },
    "cashFlowBalance": {
      "$ref": "#/components/schemas/CashFlowCashFlowBalance"
    },
    "availableBalance": {
      "type": "number",
      "example": 1000,
      "description": "Available balance"
    },
    "aggregationStatusCode": {
      "type": "integer",
      "example": 0,
      "description": "The status of the most recent aggregation attempt for this account (non-zero means the account was not accessed successfully for this report, and additional fields for this account may not be reliable)"
    },
    "cashFlowCharacteristic": {
      "$ref": "#/components/schemas/CashFlowCashFlowCharacteristic"
    }
  }
}

{
  "allOf": [
    {
      "$ref": "#/components/schemas/BaseReportAck"
    },
    {
      "type": "object",
      "properties": {
        "constraints": {
          "$ref": "#/components/schemas/CashFlowReportConstraintsOut"
        }
      }
    }
  ],
  "required": [
    "id",
    "customerType",
    "customerId",
    "requestId",
    "requesterName",
    "createdDate",
    "title",
    "consumerId",
    "consumerSsn",
    "type",
    "status",
    "constraints"
  ]
}

{
  "type": "object",
  "properties": {
    "showNsf": {
      "$ref": "#/components/schemas/ShowNsf"
    },
    "fromDate": {
      "$ref": "#/components/schemas/UnixDate"
    },
    "accountIds": {
      "$ref": "#/components/schemas/ReportAccountIdsString"
    },
    "reportCustomFields": {
      "$ref": "#/components/schemas/ReportCustomFields"
    },
    "incomeStreamConfidenceMinimum": {
      "$ref": "#/components/schemas/IncomeStreamConfidenceMinimum"
    }
  }
}

{
  "type": "object",
  "properties": {
    "showNsf": {
      "$ref": "#/components/schemas/ShowNsf"
    },
    "fromDate": {
      "$ref": "#/components/schemas/UnixDate"
    },
    "accountIds": {
      "$ref": "#/components/schemas/ReportAccountIds"
    },
    "reportCustomFields": {
      "$ref": "#/components/schemas/ReportCustomFields"
    },
    "incomeStreamConfidenceMinimum": {
      "$ref": "#/components/schemas/IncomeStreamConfidenceMinimum"
    }
  }
}

{
  "type": "object",
  "required": [
    "averageTransactionValueByMonthForTheReportTimePeriod",
    "activityWithdrawalsDebitsForTheReportTimePeriod",
    "activityDepositsCreditsForTheReportTimePeriod"
  ],
  "properties": {
    "lastTransactionDate": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "date"
        ],
        "properties": {
          "date": {
            "type": "string",
            "example": "2020-03-25",
            "description": "Date the deposit transaction was posted"
          },
          "depositsCredits": {
            "type": "number",
            "example": 500,
            "description": "Amount of transaction if deposit, otherwise null"
          },
          "withdrawalsDebits": {
            "type": "number",
            "example": 500,
            "description": "Amount of transaction if withdrawal, otherwise null"
          },
          "zeroAmountTransaction": {
            "type": "number",
            "example": 0,
            "description": "Amount of transaction if zero, otherwise null"
          },
          "transactionDescription": {
            "type": "string",
            "example": "VENMO            CASHOUT",
            "description": "Description of transaction"
          }
        }
      },
      "description": "Latest posted transaction(s) to the account. May be more than one if they share the same timestamp"
    },
    "historicWeeksWithZeroTransactions": {
      "$ref": "#/components/schemas/CashFlowNumWeeksZeros"
    },
    "netCashFlowForTheReportTimePeriod": {
      "type": "number",
      "example": 1544.94,
      "description": "Net cash flow during the report period (may be positive or negative)"
    },
    "netCashFlowByMonthForTheReportTimePeriod": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ObbDateRangeAndAmount"
      },
      "description": "Net cash flow for each month during the report period"
    },
    "activityDepositsCreditsForTheReportTimePeriod": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CashFlowActivityDepositsCredits"
      },
      "description": "List of all deposit transactions posted to the account during the report period"
    },
    "activityWithdrawalsDebitsForTheReportTimePeriod": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CashFlowActivityWithdrawalsDebits"
      },
      "description": "List of all withdrawal transactions posted to the account during the report period"
    },
    "averageTransactionValueByMonthForTheReportTimePeriod": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ObbDateRangeAndAmount"
      },
      "description": "Average value of transactions during periods in the report. Values may be positive or negative"
    }
  },
  "description": "Transaction Analytics Attributes"
}

{
  "type": "string",
  "example": "ATM Fee",
  "description": "The different categories for transactions.\n* \"ATM Fee\"\n\n* \"Advertising\"\n\n* \"Air Travel\"\n\n* \"Alcohol & Bars\"\n\n* \"Allowance\"\n\n* \"Amusement\"\n\n* \"Arts\"\n\n* \"Auto & Transport\"\n\n* \"Auto Insurance\"\n\n* \"Auto Payment\"\n\n* \"Baby Supplies\"\n\n* \"Babysitter & Daycare\"\n\n* \"Bank Fee\"\n\n* \"Bills & Utilities\"\n\n* \"Bonus\"\n\n* \"Books\"\n\n* \"Books & Supplies\"\n\n* \"Business Services\"\n\n* \"Buy\"\n\n* \"Cash & ATM\"\n\n* \"Charity\"\n\n* \"Check\"\n\n* \"Child Support\"\n\n* \"Clothing\"\n\n* \"Coffee Shops\"\n\n* \"Credit Card Payment\"\n\n* \"Dentist\"\n\n* \"Deposit\"\n\n* \"Dividend & Cap Gains\"\n\n* \"Doctor\"\n\n* \"Education\"\n\n* \"Electronics & Software\"\n\n* \"Entertainment\"\n\n* \"Eyecare\"\n\n* \"Fast Food\"\n\n* \"Federal Tax\"\n\n* \"Fees & Charges\"\n\n* \"Finance Charge\"\n\n* \"Financial\"\n\n* \"Financial Advisor\"\n\n* \"Food & Dining\"\n\n* \"Furnishings\"\n\n* \"Gas & Fuel\"\n\n* \"Gift\"\n\n* \"Gifts & Donations\"\n\n* \"Groceries\"\n\n* \"Gym\"\n\n* \"Hair\"\n\n* \"Health & Fitness\"\n\n* \"Health Insurance\"\n\n* \"Hobbies\"\n\n* \"Home\"\n\n* \"Home Improvement\"\n\n* \"Home Insurance\"\n\n* \"Home Phone\"\n\n* \"Home Services\"\n\n* \"Home Supplies\"\n\n* \"Hotel\"\n\n* \"Income\"\n\n* \"Interest Income\"\n\n* \"Internet\"\n\n* \"Investments\"\n\n* \"Kids\"\n\n* \"Kids Activities\"\n\n* \"Late Fee\"\n\n* \"Laundry\"\n\n* \"Lawn & Garden\"\n\n* \"Legal\"\n\n* \"Life Insurance\"\n\n* \"Loan Fees and Charges\"\n\n* \"Loan Insurance\"\n\n* \"Loan Interest\"\n\n* \"Loan Payment\"\n\n* \"Loan Principal\"\n\n* \"Loans\"\n\n* \"Local Tax\"\n\n* \"Low Balance\"\n\n* \"Mobile Phone\"\n\n* \"Mortgage & Rent\"\n\n* \"Movies & DVDs\"\n\n* \"Music\"\n\n* \"Newspapers & Magazines\"\n\n* \"Office Supplies\"\n\n* \"Parking\"\n\n* \"Paycheck\"\n\n* \"Personal Care\"\n\n* \"Pet Food & Supplies\"\n\n* \"Pet Grooming\"\n\n* \"Pets\"\n\n* \"Pharmacy\"\n\n* \"Printing\"\n\n* \"Property Tax\"\n\n* \"Public Transportation\"\n\n* \"Reimbursement\"\n\n* \"Rental Car & Taxi\"\n\n* \"Restaurants\"\n\n* \"Sales Tax\"\n\n* \"Sell\"\n\n* \"Service & Parts\"\n\n* \"Service Fee\"\n\n* \"Shipping\"\n\n* \"Shopping\"\n\n* \"Spa & Massage\"\n\n* \"Sporting Goods\"\n\n* \"Sports\"\n\n* \"State Tax\"\n\n* \"Streaming Services\"\n\n* \"Student Loan\"\n\n* \"Taxes\"\n\n* \"Television\"\n\n* \"Toys\"\n\n* \"Trade Commissions\"\n\n* \"Transfer\"\n\n* \"Transfer for Cash Spending\"\n\n* \"Travel\"\n\n* \"Tuition\"\n\n* \"Uncategorized\"\n\n* \"Utilities\"\n\n* \"Vacation\"\n\n* \"Veterinary\"\n\n* \"Internet / Broadband Charges\""
}

{
  "type": "object",
  "required": [
    "normalizedPayeeName",
    "category",
    "country"
  ],
  "properties": {
    "city": {
      "$ref": "#/components/schemas/City"
    },
    "state": {
      "$ref": "#/components/schemas/State"
    },
    "country": {
      "$ref": "#/components/schemas/Country"
    },
    "category": {
      "$ref": "#/components/schemas/Categories"
    },
    "postalCode": {
      "$ref": "#/components/schemas/ZipCode"
    },
    "bestRepresentation": {
      "type": "string",
      "example": "VERIZON WIRELESS PAYMENTS",
      "description": "Combines the `description` and `memo` data together, removing duplicated information and numbers and special characters"
    },
    "normalizedPayeeName": {
      "type": "string",
      "example": "Mad Science Research",
      "description": "A normalized payee, derived from the transaction's description and memo fields"
    }
  },
  "description": "Categorization Record"
}

{
  "type": "object",
  "required": [
    "name",
    "id",
    "transAgg",
    "ach",
    "stateAgg",
    "voi",
    "voa",
    "aha",
    "availBalance",
    "accountOwner",
    "loanPaymentDetails",
    "studentLoanData"
  ],
  "properties": {
    "id": {
      "$ref": "#/components/schemas/NumericInstitutionId"
    },
    "ach": {
      "$ref": "#/components/schemas/InstitutionAch"
    },
    "aha": {
      "$ref": "#/components/schemas/InstitutionAha"
    },
    "voa": {
      "$ref": "#/components/schemas/InstitutionVoa"
    },
    "voi": {
      "$ref": "#/components/schemas/InstitutionVoi"
    },
    "name": {
      "$ref": "#/components/schemas/InstitutionName"
    },
    "rssd": {
      "$ref": "#/components/schemas/Rssd"
    },
    "stateAgg": {
      "$ref": "#/components/schemas/InstitutionStateAgg"
    },
    "transAgg": {
      "$ref": "#/components/schemas/InstitutionTransAgg"
    },
    "accountOwner": {
      "$ref": "#/components/schemas/InstitutionAccountOwner"
    },
    "availBalance": {
      "$ref": "#/components/schemas/InstitutionAvailableBalance"
    },
    "studentLoanData": {
      "$ref": "#/components/schemas/StudentLoanDataCertification"
    },
    "childInstitutions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ChildInstitution"
      },
      "minItems": 0,
      "description": "An array of child financial institutions"
    },
    "loanPaymentDetails": {
      "$ref": "#/components/schemas/LoanPaymentDetailCertification"
    }
  }
}

{
  "type": "object",
  "required": [
    "found",
    "displaying",
    "moreAvailable",
    "requestedDate",
    "institutions"
  ],
  "properties": {
    "found": {
      "$ref": "#/components/schemas/FoundResults"
    },
    "displaying": {
      "$ref": "#/components/schemas/DisplayingResults"
    },
    "institutions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CertifiedInstitution"
      },
      "maxItems": 1000,
      "minItems": 0,
      "description": "A list of institutions"
    },
    "moreAvailable": {
      "$ref": "#/components/schemas/MoreResultsAvailable"
    },
    "requestedDate": {
      "$ref": "#/components/schemas/UnixDate"
    }
  },
  "description": "A list of financial institutions from the Get Certified Institutions API"
}

{
  "type": "object",
  "required": [
    "rssd",
    "parentRSSD",
    "name",
    "institutionId"
  ],
  "properties": {
    "name": {
      "$ref": "#/components/schemas/InstitutionName"
    },
    "rssd": {
      "$ref": "#/components/schemas/Rssd"
    },
    "parentRSSD": {
      "$ref": "#/components/schemas/Rssd"
    },
    "institutionId": {
      "$ref": "#/components/schemas/NumericInstitutionId"
    }
  }
}

{
  "type": "string",
  "example": "Murray",
  "description": "City"
}

{
  "type": "number",
  "example": 100,
  "description": "The confidence score 0-100 of the name classification."
}

{
  "type": "object",
  "required": [
    "partnerId",
    "customerId",
    "consumerId",
    "email"
  ],
  "properties": {
    "email": {
      "$ref": "#/components/schemas/EmailOptions"
    },
    "webhook": {
      "$ref": "#/components/schemas/Webhook"
    },
    "fromDate": {
      "$ref": "#/components/schemas/ConnectFromDate"
    },
    "language": {
      "$ref": "#/components/schemas/ConnectLanguage"
    },
    "partnerId": {
      "$ref": "#/components/schemas/PartnerId"
    },
    "consumerId": {
      "$ref": "#/components/schemas/ConsumerId"
    },
    "customerId": {
      "$ref": "#/components/schemas/CustomerId"
    },
    "experience": {
      "$ref": "#/components/schemas/Experience"
    },
    "redirectUri": {
      "$ref": "#/components/schemas/RedirectUri"
    },
    "webhookData": {
      "$ref": "#/components/schemas/WebhookData"
    },
    "singleUseUrl": {
      "$ref": "#/components/schemas/SingleUseUrl"
    },
    "webhookHeaders": {
      "$ref": "#/components/schemas/WebhookHeaders"
    },
    "reportCustomFields": {
      "$ref": "#/components/schemas/ReportCustomFields"
    },
    "webhookContentType": {
      "$ref": "#/components/schemas/WebhookContentType"
    },
    "institutionSettings": {
      "$ref": "#/components/schemas/InstitutionSettings"
    },
    "optionalConsumerInfo": {
      "$ref": "#/components/schemas/ConsumerInfo"
    }
  }
}

{
  "type": "object",
  "required": [
    "link",
    "emailConfig"
  ],
  "properties": {
    "link": {
      "$ref": "#/components/schemas/ConnectLink"
    },
    "emailConfig": {
      "$ref": "#/components/schemas/EmailOptions"
    }
  }
}

{
  "type": "integer",
  "format": "int64",
  "example": 1607450357,
  "description": "The `fromDate` parameter is used when experiences are associated with a credit decisioning report and any other reports with transaction data. The value is in epoch time and must be 10 digits. Example: 1494449017. If it's greater than 10 digits, then the `fromDate` is set to the credit decisioning report's default `fromDate`.\n\nFor an experience that generates multiple reports, the `fromDate` gets passed to the reports that support it.\n\nHowever, Connect doesn't pass this parameter to the following reports:\n* Pay Statement Extraction Report \n* VOIE - Paystub (with TXVerify) Report \n* Statement Report \n* Verification of Income Report \n* VOIE - Payroll Report \n\nNote: this field isn't used if you're only collecting transaction data without a report."
}

{
  "type": "object",
  "required": [
    "partnerId",
    "borrowers",
    "email",
    "experience"
  ],
  "properties": {
    "email": {
      "$ref": "#/components/schemas/EmailOptions"
    },
    "webhook": {
      "$ref": "#/components/schemas/Webhook"
    },
    "fromDate": {
      "$ref": "#/components/schemas/ConnectFromDate"
    },
    "language": {
      "$ref": "#/components/schemas/ConnectLanguage"
    },
    "borrowers": {
      "$ref": "#/components/schemas/Borrowers"
    },
    "partnerId": {
      "$ref": "#/components/schemas/PartnerId"
    },
    "experience": {
      "$ref": "#/components/schemas/Experience"
    },
    "redirectUri": {
      "$ref": "#/components/schemas/RedirectUri"
    },
    "webhookData": {
      "$ref": "#/components/schemas/WebhookData"
    },
    "singleUseUrl": {
      "$ref": "#/components/schemas/SingleUseUrl"
    },
    "webhookHeaders": {
      "$ref": "#/components/schemas/WebhookHeaders"
    },
    "reportCustomFields": {
      "$ref": "#/components/schemas/ReportCustomFields"
    },
    "webhookContentType": {
      "$ref": "#/components/schemas/WebhookContentType"
    },
    "institutionSettings": {
      "$ref": "#/components/schemas/InstitutionSettings"
    }
  }
}

{
  "type": "object",
  "required": [
    "partnerId",
    "borrowers"
  ],
  "properties": {
    "webhook": {
      "$ref": "#/components/schemas/Webhook"
    },
    "fromDate": {
      "$ref": "#/components/schemas/ConnectFromDate"
    },
    "language": {
      "$ref": "#/components/schemas/ConnectLanguage"
    },
    "borrowers": {
      "$ref": "#/components/schemas/Borrowers"
    },
    "partnerId": {
      "$ref": "#/components/schemas/PartnerId"
    },
    "experience": {
      "$ref": "#/components/schemas/Experience"
    },
    "redirectUri": {
      "$ref": "#/components/schemas/RedirectUri"
    },
    "webhookData": {
      "$ref": "#/components/schemas/WebhookData"
    },
    "singleUseUrl": {
      "$ref": "#/components/schemas/SingleUseUrl"
    },
    "webhookHeaders": {
      "$ref": "#/components/schemas/WebhookHeaders"
    },
    "reportCustomFields": {
      "$ref": "#/components/schemas/ReportCustomFields"
    },
    "webhookContentType": {
      "$ref": "#/components/schemas/WebhookContentType"
    },
    "institutionSettings": {
      "$ref": "#/components/schemas/InstitutionSettings"
    }
  }
}

{
  "type": "string",
  "example": "es",
  "description": "By default, the Connect application is in English. You don't need to pass this parameter unless\nyou want to translate Connect into one of our supported languages.\n\n* Spanish (United States): `es`\n* French (Canada): `fr`\n"
}

{
  "type": "string",
  "example": "https://connect2.finicity.com?customerId=5025024821&institutionId=102105&origin=url&partnerId=2445583925753&signature=b5667164db7a9a0007b59267785c996ca3bc9ce97f2e72c98099cead76edfad9&timestamp=1648050761908&ttl=1648057961908&type=lite&webhookContentType=application%2Fjson",
  "description": "A generated Connect URL"
}

{
  "type": "object",
  "required": [
    "partnerId",
    "customerId"
  ],
  "properties": {
    "webhook": {
      "$ref": "#/components/schemas/Webhook"
    },
    "fromDate": {
      "$ref": "#/components/schemas/ConnectFromDate"
    },
    "language": {
      "$ref": "#/components/schemas/ConnectLanguage"
    },
    "isWebView": {
      "$ref": "#/components/schemas/IsWebView"
    },
    "partnerId": {
      "$ref": "#/components/schemas/PartnerId"
    },
    "consumerId": {
      "$ref": "#/components/schemas/ConsumerId"
    },
    "customerId": {
      "$ref": "#/components/schemas/CustomerId"
    },
    "experience": {
      "$ref": "#/components/schemas/Experience"
    },
    "redirectUri": {
      "$ref": "#/components/schemas/RedirectUri"
    },
    "webhookData": {
      "$ref": "#/components/schemas/WebhookData"
    },
    "singleUseUrl": {
      "$ref": "#/components/schemas/SingleUseUrl"
    },
    "webhookHeaders": {
      "$ref": "#/components/schemas/WebhookHeaders"
    },
    "reportCustomFields": {
      "$ref": "#/components/schemas/ReportCustomFields"
    },
    "webhookContentType": {
      "$ref": "#/components/schemas/WebhookContentType"
    },
    "institutionSettings": {
      "$ref": "#/components/schemas/InstitutionSettings"
    },
    "optionalConsumerInfo": {
      "$ref": "#/components/schemas/ConsumerInfo"
    }
  }
}

{
  "type": "object",
  "required": [
    "link"
  ],
  "properties": {
    "link": {
      "$ref": "#/components/schemas/ConnectLink"
    }
  },
  "description": "A Connect URL object"
}

{
  "type": "string",
  "example": "cr_4pfI3r1X8aOHrDDwrwC01NHFxOXlT1",
  "description": "Third party access key receipt ID. Generated by generate third party access key API."
}

{
  "type": "object",
  "required": [
    "id",
    "firstName",
    "lastName",
    "customerId",
    "address",
    "city",
    "state",
    "zip",
    "phone",
    "ssn",
    "birthday",
    "email",
    "createdDate"
  ],
  "properties": {
    "id": {
      "$ref": "#/components/schemas/ConsumerId"
    },
    "ssn": {
      "$ref": "#/components/schemas/SocialSecurityNumberLastDigits"
    },
    "zip": {
      "$ref": "#/components/schemas/ZipCode"
    },
    "city": {
      "$ref": "#/components/schemas/City"
    },
    "email": {
      "$ref": "#/components/schemas/EmailAddress"
    },
    "phone": {
      "$ref": "#/components/schemas/PhoneNumber"
    },
    "state": {
      "$ref": "#/components/schemas/State"
    },
    "suffix": {
      "$ref": "#/components/schemas/Suffix"
    },
    "address": {
      "$ref": "#/components/schemas/Address"
    },
    "birthday": {
      "$ref": "#/components/schemas/Birthday"
    },
    "lastName": {
      "$ref": "#/components/schemas/LastName"
    },
    "firstName": {
      "$ref": "#/components/schemas/FirstName"
    },
    "customerId": {
      "$ref": "#/components/schemas/NumericCustomerId"
    },
    "createdDate": {
      "$ref": "#/components/schemas/UnixDate"
    }
  },
  "description": "A finicity consumer record"
}

{
  "type": "integer",
  "format": "int64",
  "example": 1607450357,
  "description": "The consumer's date of birth in Unix epoch time (in seconds). See: Handling Epoch Dates and Times. The timestamp should be set at the start of day of birth."
}

{
  "type": "string",
  "example": "0bf46322c167b562e6cbed9d40e19a4c",
  "description": "A consumer ID. See Create Consumer API for how to create a consumer ID."
}

{
  "type": "object",
  "required": [
    "ssn"
  ],
  "properties": {
    "dob": {
      "$ref": "#/components/schemas/ConsumerDateOfBirth"
    },
    "ssn": {
      "$ref": "#/components/schemas/SocialSecurityNumberNoHyphens"
    }
  },
  "description": "The SSN and date of birth of a consumer"
}

{
  "type": "object",
  "properties": {
    "ssn": {
      "$ref": "#/components/schemas/SocialSecurityNumber"
    },
    "zip": {
      "$ref": "#/components/schemas/ZipCode"
    },
    "city": {
      "$ref": "#/components/schemas/City"
    },
    "email": {
      "$ref": "#/components/schemas/EmailAddress"
    },
    "phone": {
      "$ref": "#/components/schemas/PhoneNumber"
    },
    "state": {
      "$ref": "#/components/schemas/State"
    },
    "suffix": {
      "$ref": "#/components/schemas/Suffix"
    },
    "address": {
      "$ref": "#/components/schemas/Address"
    },
    "birthday": {
      "$ref": "#/components/schemas/Birthday"
    },
    "lastName": {
      "$ref": "#/components/schemas/LastName"
    },
    "firstName": {
      "$ref": "#/components/schemas/FirstName"
    }
  }
}

{
  "type": "integer",
  "format": "int64",
  "example": 1607450357,
  "description": "(Student Loan) The date the loan enters into repayment. A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://developer.mastercard.com/open-banking-us/documentation/codes-and-formats/)."
}

{
  "type": "string",
  "example": "USA",
  "description": "Country code is Iso3166-1 Alpha-2 code and Alpha 3 standard (max length 3)."
}

{
  "type": "string",
  "example": "US",
  "maxLength": 2,
  "minLength": 2,
  "description": "Two-letter ISO 3166-1 alpha-2 country code"
}

{
  "type": "string",
  "example": "1",
  "maxLength": 3,
  "minLength": 1,
  "description": "The country code digit representing the phone number for specific country"
}

{
  "type": "object",
  "properties": {
    "id": {
      "$ref": "#/components/schemas/ConsumerId"
    },
    "customerId": {
      "$ref": "#/components/schemas/NumericCustomerId"
    },
    "createdDate": {
      "$ref": "#/components/schemas/UnixDate"
    }
  },
  "description": "A consumer that was just created"
}

{
  "type": "object",
  "required": [
    "id",
    "username",
    "createdDate"
  ],
  "properties": {
    "id": {
      "$ref": "#/components/schemas/CustomerId"
    },
    "username": {
      "$ref": "#/components/schemas/CustomerUsername"
    },
    "createdDate": {
      "$ref": "#/components/schemas/UnixDate"
    }
  },
  "description": "A new customer that was just enrolled"
}

{
  "type": "object",
  "required": [
    "id",
    "createdDate"
  ],
  "properties": {
    "id": {
      "$ref": "#/components/schemas/TransactionId"
    },
    "createdDate": {
      "$ref": "#/components/schemas/UnixDate"
    }
  },
  "description": "Response for TxPush test transaction"
}

{
  "type": "string",
  "example": "USD",
  "description": "A currency code"
}

{
  "type": "object",
  "required": [
    "id",
    "username",
    "type",
    "createdDate"
  ],
  "properties": {
    "id": {
      "$ref": "#/components/schemas/CustomerId"
    },
    "type": {
      "$ref": "#/components/schemas/CustomerType"
    },
    "lastName": {
      "$ref": "#/components/schemas/LastName"
    },
    "username": {
      "$ref": "#/components/schemas/CustomerUsername"
    },
    "firstName": {
      "$ref": "#/components/schemas/FirstName"
    },
    "createdDate": {
      "$ref": "#/components/schemas/StringUnixDate"
    },
    "lastModifiedDate": {
      "$ref": "#/components/schemas/StringUnixDate"
    }
  },
  "description": "A finicity customer record"
}

{
  "type": "object",
  "required": [
    "id",
    "accountNumberDisplay",
    "name",
    "accountNickname",
    "number",
    "type",
    "status",
    "customerId",
    "institutionId",
    "createdDate",
    "currency",
    "institutionLoginId"
  ],
  "properties": {
    "id": {
      "$ref": "#/components/schemas/AccountId"
    },
    "name": {
      "$ref": "#/components/schemas/Name"
    },
    "type": {
      "$ref": "#/components/schemas/AccountType"
    },
    "detail": {
      "$ref": "#/components/schemas/CustomerAccountDetail"
    },
    "number": {
      "type": "string",
      "example": "2000004444",
      "deprecated": true,
      "description": "The account number from the institution"
    },
    "status": {
      "$ref": "#/components/schemas/AggregationStatus"
    },
    "balance": {
      "type": "number",
      "example": 401.26,
      "description": "The cleared balance of the account as of `balanceDate`"
    },
    "currency": {
      "$ref": "#/components/schemas/Currency"
    },
    "position": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CustomerAccountPosition"
      },
      "description": "Investment holdings"
    },
    "customerId": {
      "$ref": "#/components/schemas/CustomerId"
    },
    "balanceDate": {
      "$ref": "#/components/schemas/CustomerAccountBalanceDate"
    },
    "createdDate": {
      "$ref": "#/components/schemas/CustomerAccountCreatedDate"
    },
    "institutionId": {
      "$ref": "#/components/schemas/InstitutionId"
    },
    "marketSegment": {
      "$ref": "#/components/schemas/CustomerAccountMarketSegment"
    },
    "parentAccount": {
      "$ref": "#/components/schemas/CustomerAccountParentAccountId"
    },
    "displayPosition": {
      "$ref": "#/components/schemas/DisplayPosition"
    },
    "lastUpdatedDate": {
      "$ref": "#/components/schemas/CustomerLastUpdatedDate"
    },
    "institutionLoginId": {
      "$ref": "#/components/schemas/NumericInstitutionLoginId"
    },
    "lastTransactionDate": {
      "$ref": "#/components/schemas/CustomerAccountLastTransactionDate"
    },
    "accountNumberDisplay": {
      "$ref": "#/components/schemas/AccountNumberDisplay"
    },
    "aggregationStatusCode": {
      "$ref": "#/components/schemas/AggregationStatusCode"
    },
    "oldestTransactionDate": {
      "$ref": "#/components/schemas/CustomerAccountOldestTransactionDate"
    },
    "aggregationAttemptDate": {
      "$ref": "#/components/schemas/CustomerAccountAggregationAttemptDate"
    },
    "aggregationSuccessDate": {
      "$ref": "#/components/schemas/CustomerAccountAggregationSuccessDate"
    },
    "realAccountNumberLast4": {
      "$ref": "#/components/schemas/AccountNumberLast4"
    }
  },
  "description": "An account represents a bank account such as a checking or savings that the customer has added via the Connect interface."
}

{
  "type": "integer",
  "format": "int64",
  "example": 1607450357,
  "description": "A timestamp showing the last aggregation attempt, whether successful or not. This will not be present until you have run your first aggregation for the account. A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://developer.mastercard.com/open-banking-us/documentation/codes-and-formats/)."
}

{
  "type": "integer",
  "format": "int64",
  "example": 1607450357,
  "description": "A timestamp showing the last successful aggregation of the account. This will not be present until you have run your first aggregation for the account. A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://developer.mastercard.com/open-banking-us/documentation/codes-and-formats/)."
}