Financial Data Exchange (FDX) · Schema

Accounts entity

An optionally paginated array of account descriptors. Each account descriptor is sent as a key-value pair, with the account descriptor object as the value and the account type as the key. Accepted keys include: [`annuityAccount`](#annuity-account-descriptor), [`commercialAccount`](#commercial-account-descriptor), [`depositAccount`](#deposit-account-descriptor), [`digitalWallet`](#digital-wallet-descriptor), [`investmentAccount`](#investment-account-descriptor), [`locAccount`](#line-of-credit-account-descriptor), [`loanAccount`](#loan-account-descriptor), and [`insuranceAccount`](#insurance-account-descriptor).

Financial DataOpen BankingOpen FinanceFinancial Data ExchangeConsumer PermissionedAccount DataTransactionsInvestmentsInsuranceTax DataPayrollRESTOAuth2FAPICFPB 1033
View JSON Schema on GitHub

JSON Schema

fdx-accounts.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Accounts entity",
  "description": "An optionally paginated array of account descriptors.\nEach account descriptor is sent as a key-value pair, with the account descriptor object as the value and the account type as the key.\nAccepted keys include: [`annuityAccount`](#annuity-account-descriptor), [`commercialAccount`](#commercial-account-descriptor), [`depositAccount`](#deposit-account-descriptor), [`digitalWallet`](#digital-wallet-descriptor), [`investmentAccount`](#investment-account-descriptor), [`locAccount`](#line-of-credit-account-descriptor), [`loanAccount`](#loan-account-descriptor), and [`insuranceAccount`](#insurance-account-descriptor).\n",
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/PaginatedArray"
    },
    {
      "type": "object",
      "properties": {
        "accounts": {
          "type": "array",
          "description": "An optionally paginated array of account descriptors.\nEach account descriptor is sent as a key-value pair, with the account descriptor object as the value and the account type as the key.\nAccepted keys include: [`annuityAccount`](#annuity-account-descriptor), [`commercialAccount`](#commercial-account-descriptor), [`depositAccount`](#deposit-account-descriptor), [`digitalWallet`](#digital-wallet-descriptor), [`investmentAccount`](#investment-account-descriptor), [`locAccount`](#line-of-credit-account-descriptor), [`loanAccount`](#loan-account-descriptor), and [`insuranceAccount`](#insurance-account-descriptor).\n",
          "items": {
            "$ref": "#/components/schemas/AccountWithDescriptor"
          },
          "minItems": 1
        }
      },
      "required": [
        "accounts"
      ]
    }
  ]
}