{
  "type": "boolean",
  "default": false,
  "example": true,
  "description": "Field to indicate whether to extract the deductions on all pay statements"
}

{
  "type": "boolean",
  "default": true,
  "example": true,
  "description": "Field to indicate whether to extract the direct deposits on all pay statements"
}

{
  "type": "boolean",
  "default": true,
  "example": true,
  "description": "Field to indicate whether to extract the earnings on all pay statements"
}

{
  "type": "string",
  "example": "John",
  "description": "The first name of the account holder"
}

{
  "type": "integer",
  "format": "int64",
  "example": 1607450357,
  "description": "(Mortgage/Loan) First payment due date. 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": "object",
  "required": [
    "partnerId",
    "customerId",
    "institutionLoginId"
  ],
  "properties": {
    "webhook": {
      "$ref": "#/components/schemas/Webhook"
    },
    "language": {
      "$ref": "#/components/schemas/ConnectLanguage"
    },
    "isWebView": {
      "$ref": "#/components/schemas/IsWebView"
    },
    "partnerId": {
      "$ref": "#/components/schemas/PartnerId"
    },
    "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"
    },
    "institutionLoginId": {
      "$ref": "#/components/schemas/InstitutionLoginId"
    },
    "webhookContentType": {
      "$ref": "#/components/schemas/WebhookContentType"
    }
  }
}

{
  "type": "integer",
  "example": 200,
  "description": "The total number of results matching search criteria"
}

{
  "type": "string",
  "example": "123456789",
  "description": "A federal or state issued identification number in alphanumeric characters.\n* **United States**:\n\n  * Passport: 6-9 digits.\n\n  * US Visa: 8 digits.\n\n  * Driver's license: 1-19 digits\n* **Canada**:\n\n  * Passport: 8 digits \n\n  * Driver: 6-9 digits"
}

{
  "type": "boolean",
  "example": true,
  "description": "Mastercard Open Banking internal use only to flag reports that should not be retrieved by the GSE's (Government-Sponsored Enterprise).\n\nThis is a mandatory field for VOE-payroll and VOIE-payroll report types."
}

{
  "type": "number",
  "example": 0.574,
  "description": "Comprehensive network score built on behavioral insights such as velocity, popularity, volatility, and age of an attribute, with a higher score indicating a riskier account sign-up. A number between 0 and 1 rounded to three decimal places."
}

{
  "type": "number",
  "example": 275,
  "description": "Comprehensive identity risk score with a higher score indicating a riskier account sign-up."
}

{
  "type": "boolean",
  "default": false,
  "example": true,
  "description": "If pending transactions must be included"
}

{
  "type": "integer",
  "format": "int32",
  "example": 50,
  "description": "Include income streams in the report, based on the income stream's confidence score. For example, Use the value 50 to include only income streams with a confidence score of 50 or higher."
}

{
  "type": "string",
  "description": "The index for the statement. This can range from 1 to 24 statement indexes."
}

{
  "type": "integer",
  "format": "int64",
  "example": 1607450357,
  "description": "(Mortgage/Loan) Original date of loan. 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": "object",
  "properties": {
    "status": {
      "type": "string",
      "example": "Pending",
      "description": "Micro entries successful initiation status"
    },
    "accountId": {
      "$ref": "#/components/schemas/AccountId"
    },
    "depositCount": {
      "$ref": "#/components/schemas/MicroDepositCount"
    },
    "statusDescription": {
      "type": "string",
      "example": "Micro entries successfully initiated",
      "description": "Micro entries successful initiation description"
    }
  }
}

{
  "type": "object",
  "required": [
    "id",
    "transAgg",
    "ach",
    "stateAgg",
    "voi",
    "voa",
    "aha",
    "availBalance",
    "accountOwner",
    "oauthEnabled",
    "currency",
    "status"
  ],
  "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"
    },
    "class": {
      "type": "string",
      "example": "retirement",
      "description": "Institution's class"
    },
    "email": {
      "$ref": "#/components/schemas/EmailAddress"
    },
    "phone": {
      "$ref": "#/components/schemas/PhoneNumber"
    },
    "status": {
      "type": "string",
      "example": "online",
      "description": "Status for the institution: \"online\", \"offline\", \"maintenance\", \"testing\""
    },
    "address": {
      "$ref": "#/components/schemas/InstitutionAddress"
    },
    "branding": {
      "$ref": "#/components/schemas/Branding"
    },
    "currency": {
      "$ref": "#/components/schemas/Currency"
    },
    "stateAgg": {
      "$ref": "#/components/schemas/InstitutionStateAgg"
    },
    "timeZone": {
      "type": "string",
      "example": "America/Denver",
      "description": "The time zone of the institution."
    },
    "transAgg": {
      "$ref": "#/components/schemas/InstitutionTransAgg"
    },
    "urlHomeApp": {
      "type": "string",
      "example": "https://www.example.com/home",
      "description": "The URL of the institution's primary home page"
    },
    "specialText": {
      "type": "string",
      "example": "Please enter your Principal Financial - Retirement (Personal) Username and Password.",
      "description": "Special instructions given to customers for login"
    },
    "urlLogonApp": {
      "type": "string",
      "example": "https://www.example.com/login",
      "description": "The URL of the institution's login page"
    },
    "accountOwner": {
      "$ref": "#/components/schemas/InstitutionAccountOwner"
    },
    "availBalance": {
      "$ref": "#/components/schemas/InstitutionAvailableBalance"
    },
    "oauthEnabled": {
      "type": "boolean",
      "example": true,
      "description": "\"true\": The institution is an OAuth connection\n\n\"false\": The institution isn't an OAuth connection"
    },
    "studentLoanData": {
      "$ref": "#/components/schemas/StudentLoanDataCertification"
    },
    "newInstitutionId": {
      "$ref": "#/components/schemas/NumericInstitutionId"
    },
    "urlForgotPassword": {
      "type": "string",
      "example": "https://www.example.com/forgotPassword.do",
      "description": "Institution's forgot password page"
    },
    "loanPaymentDetails": {
      "$ref": "#/components/schemas/LoanPaymentDetailCertification"
    },
    "oauthInstitutionId": {
      "$ref": "#/components/schemas/NumericInstitutionId"
    },
    "specialInstructions": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "Account details",
        "Balances and transactions",
        "Personal and account ownership info"
      ],
      "description": "Instructions given to the customer before they are sent to the institution website to login for OAuth institutions.\n\nNote: this helps the customer to provide the proper permission for data needed for the application."
    },
    "urlOnlineRegistration": {
      "type": "string",
      "example": "https://www.example.com/signup",
      "description": "Institution's signup page"
    },
    "accountTypeDescription": {
      "type": "string",
      "example": "Workplace Retirement",
      "description": "Values: Banking, Investments, Credit Cards/Accounts, Workplace Retirement, Mortgages and Loans, Insurance"
    },
    "specialInstutionsTitle": {
      "type": "string",
      "example": "Special OAuth Login Instructions",
      "description": "The title of the special instructions, if one exists or is required."
    }
  },
  "description": "A financial institution"
}

{
  "type": "boolean",
  "example": true,
  "description": "\"true\": The institution is certified for the Account Owner product\n\"false\": The institution is decertified for the Account Owner product"
}

{
  "type": "boolean",
  "example": true,
  "description": "\"true\": The institution is certified for the ACH product\n\"false\": The institution is decertified for the ACH product"
}

{
  "type": "object",
  "properties": {
    "city": {
      "$ref": "#/components/schemas/City"
    },
    "state": {
      "$ref": "#/components/schemas/State"
    },
    "country": {
      "$ref": "#/components/schemas/Country"
    },
    "postalCode": {
      "$ref": "#/components/schemas/ZipCode"
    },
    "addressLine1": {
      "$ref": "#/components/schemas/AddressLine1"
    },
    "addressLine2": {
      "$ref": "#/components/schemas/AddressLine2"
    }
  },
  "description": "The address of a financial institution"
}

{
  "type": "boolean",
  "example": false,
  "description": "\"true\": The institution is certified for the Account History Aggregation product\n\"false\": The institution is decertified for the Account History Aggregation product"
}

{
  "type": "boolean",
  "example": false,
  "description": "\"true\": The institution is certified for the Account Balance Check (ABC) product\n\"false\": The institution is decertified for the Account Balance Check (ABC) product"
}

{
  "type": "string",
  "example": "4222",
  "description": "The ID of a financial institution"
}

{
  "type": "string",
  "example": "1007302745",
  "description": "An institution login ID (from the account record)"
}

{
  "type": "string",
  "example": "FinBank",
  "description": "The name of the institution"
}

{
  "type": "object",
  "description": "Advanced options for configuration of which institutions to display in. See [Institution Settings](https://developer.mastercard.com/open-banking-us/documentation/connect/connect-institutions-settings/)."
}

{
  "type": "boolean",
  "example": false,
  "description": "\"true\": The institution is certified for the Statement Aggregation product\n\"false\": The institution is decertified for the Statement Aggregation product"
}

{
  "type": "boolean",
  "example": true,
  "description": "\"true\": The institution is certified for the Transaction Aggregation product\n\"false\": The institution is decertified for the Transaction Aggregation product"
}

{
  "type": "boolean",
  "example": true,
  "description": "\"true\": The institution is certified for the VOA product\n\"false\": The institution is decertified for the VOA product"
}

{
  "type": "boolean",
  "example": true,
  "description": "\"true\": The institution is certified for the VOI product\n\"false\": The institution is decertified for the VOI product"
}

{
  "type": "object",
  "required": [
    "institution"
  ],
  "properties": {
    "institution": {
      "$ref": "#/components/schemas/Institution"
    }
  }
}

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

{
  "type": "object",
  "required": [
    "postedDate",
    "amount",
    "transactionId"
  ],
  "properties": {
    "memo": {
      "type": "string",
      "example": "NSF",
      "maxLength": 255,
      "minLength": 0,
      "description": "Transaction memo"
    },
    "amount": {
      "type": "number",
      "example": -1.65,
      "description": "Amount of the NSF transaction"
    },
    "postedDate": {
      "type": "string",
      "example": "2022-12-19",
      "maxLength": 10,
      "minLength": 10,
      "description": "Posted date of the NSF transaction"
    },
    "description": {
      "type": "string",
      "example": "OVERDRAFT FEE",
      "maxLength": 255,
      "minLength": 0,
      "description": "Description of the transaction"
    },
    "transactionId": {
      "type": "integer",
      "example": 23092384290,
      "description": "Finicity transaction ID"
    }
  }
}

{
  "type": "string",
  "example": "transfer",
  "description": "Keywords in the `description` and `memo` fields were used to translate investment transactions into these types.\n\nPossible values: \n* \"cancel\"\n\n* \"purchaseToClose\"\n\n* \"purchaseToCover\"\n\n* \"contribution\"\n\n* \"optionExercise\"\n\n* \"optionExpiration\"\n\n* \"fee\"\n\n* \"soldToClose\"\n\n* \"soldToOpen\"\n\n* \"split\"\n\n* \"transfer\"\n\n* \"returnOfCapital\"\n\n* \"income\"\n\n* \"purchased\"\n\n* \"sold\"\n\n* \"dividendReinvest\"\n\n* \"tax\"\n\n* \"dividend\"\n\n* \"reinvestOfIncome\"\n\n* \"interest\"\n\n* \"deposit\"\n\n* \"otherInfo\""
}

{
  "type": "number",
  "example": 210,
  "description": "The distance (in miles) between the IP address and the physical address."
}

{
  "type": "string",
  "example": "US",
  "description": "The ISO-3166 alpha-2 country code associated with the geolocation of the IP address."
}

{
  "type": "string",
  "example": "Oregon",
  "description": "More granular detail about the IP address location."
}

{
  "type": "number",
  "example": 15,
  "description": "Count of days since the IP address was last observed in Ekata's Identity Network. If the IP address has not been observed before, IpLastSeenDays will be 0."
}

{
  "type": "number",
  "example": 200,
  "description": "The distance (in miles) between the IP address and the closest physical address associated with the phone number."
}

{
  "type": "number",
  "example": null,
  "description": "True if the IP address is considered risky, based on multiple IP data points and velocity calculations."
}

{
  "type": "number",
  "example": 0.123,
  "description": "Comprehensive risk score associated with an IP address, with a higher score indicating a riskier IP address. A number between 0 and 1 rounded to three decimal places."
}

{
  "type": "boolean",
  "example": true,
  "description": "\"true\": Indicates that the Connect Session will be displayed within a WebView.\nNote: when the `isWebView` parameter is `true` the `redirectUri` parameter is required."
}

{
  "type": "string",
  "example": "Smith",
  "description": "The last name of the account holder"
}

{
  "type": "integer",
  "format": "int64",
  "example": 1607450357,
  "description": "(Credit Card/Line Of Credit) The date of the last payment. 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": "(Mortgage/Loan) Due date of last payment. 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": "(Mortgage/Loan) The date of the last payment. 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": "object",
  "required": [
    "partnerId",
    "customerId",
    "institutionId"
  ],
  "properties": {
    "webhook": {
      "$ref": "#/components/schemas/Webhook"
    },
    "language": {
      "$ref": "#/components/schemas/ConnectLanguage"
    },
    "isWebView": {
      "$ref": "#/components/schemas/IsWebView"
    },
    "partnerId": {
      "$ref": "#/components/schemas/PartnerId"
    },
    "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"
    },
    "institutionId": {
      "$ref": "#/components/schemas/NumericInstitutionId"
    },
    "webhookHeaders": {
      "$ref": "#/components/schemas/WebhookHeaders"
    },
    "webhookContentType": {
      "$ref": "#/components/schemas/WebhookContentType"
    }
  }
}

{
  "type": "boolean",
  "example": true,
  "description": "\"true\": The institution is certified for the Loan Payment Detail product\n\n\"false\": The institution is decertified for the Loan Payment Detail product"
}

{
  "type": "object",
  "required": [
    "loanNumber",
    "loanPaymentNumber",
    "loanPaymentAddress"
  ],
  "properties": {
    "loanNumber": {
      "type": "string",
      "example": "123456789",
      "description": "The number of the specific loan under the account."
    },
    "accountDetail": {
      "$ref": "#/components/schemas/LoanPaymentDetailsAccount"
    },
    "loanPaymentNumber": {
      "type": "string",
      "example": "5231123456789",
      "description": "The payment number given by the institution. This number is typically for manual payments. This is not an ACH payment number."
    },
    "loanPaymentAddress": {
      "type": "string",
      "example": "Heartland ECSI       PO Box 718       Wexford PA 15090",
      "description": "The payment address to send manual payments to"
    }
  },
  "description": "Loan payment details for a customer account"
}

{
  "type": "object",
  "required": [
    "accountId",
    "accountNumber",
    "accountPaymentNumber",
    "accountPaymentAddress"
  ],
  "properties": {
    "accountId": {
      "$ref": "#/components/schemas/AccountId"
    },
    "loanDetail": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/LoanPaymentDetailsLoan"
      },
      "description": "Loan details"
    },
    "groupDetail": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/LoanPaymentDetailsGroup"
      },
      "description": "Group details"
    },
    "accountNumber": {
      "type": "string",
      "example": "9876543210",
      "description": "Institution's ID of the Student Loan Account"
    },
    "accountPaymentNumber": {
      "type": "string",
      "example": 1234895413,
      "description": "The payment number given by the institution. This number is typically for manual payments. This is not an ACH payment number."
    },
    "accountPaymentAddress": {
      "type": "string",
      "example": "P.O. Box 123 Sioux Falls, IA 51054",
      "description": "The payment address to which send manual payments should be sent"
    },
    "accountFuturePayoffDate": {
      "type": "string",
      "format": "date-time",
      "example": "2022-01-01T00:00:00.000Z",
      "description": "The date to which the \"Future Payoff Amount\" applies"
    },
    "accountFuturePayoffAmount": {
      "type": "number",
      "example": 10000,
      "description": "The payoff amount for the account"
    }
  }
}