List Accounts | Modernfi

[
  {
    "id": "string",
    "institution_id": "string",
    "signer_primary": "string",
    "account_title": "string",
    "interest_rate": "string",
    "interest_rate_tiers": [
      {
        "min_balance": "string",
        "max_balance": "string",
        "rate": "string",
        "floating_spread": "string",
        "rate_index_type": "EFFR",
        "floating_rate_percentage": "string",
        "custom_benchmark_id": "string"
      }
    ],
    "insurance_limit": "string",
    "account_type": "MMDA",
    "created_at": "string",
    "is_joint_account": true,
    "total_balance": "string",
    "pending_balance": "string",
    "is_reciprocation_prioritized": true,
    "is_receiving_printed_statements": true,
    "rate_configuration": "FIXED",
    "signer_primary_tin_last4": "string",
    "closed_at": "string",
    "signer_secondary": "string",
    "beneficiary_name": "string",
    "beneficiary_tin": "string",
    "beneficiary_tin_last4": "string",
    "institution_sweep_account_id": "string",
    "institution_return_account_id": "string",
    "institution_branch_id": "string",
    "cost_center_id": "string",
    "cost_center_code": "string",
    "depositors": [
      {
        "id": "string",
        "institution_id": "string",
        "institution_depositor_id": "string",
        "first_name": "string",
        "last_name": "string",
        "entity_name": "string",
        "is_organization": true,
        "phone_numbers": [
          {
            "number": "string",
            "is_primary": true
          }
        ],
        "emails": [
          {
            "email_address": "string",
            "is_primary": true
          }
        ],
        "addresses": [
          {
            "street": "string",
            "city": "string",
            "state": "string",
            "zip": "string",
            "country_code": "string",
            "is_primary": true
          }
        ],
        "depositor_type": "CONSUMER",
        "tin_last_four": "string",
        "ownership_category": "JOINT",
        "account_officer": "string",
        "notes": "string",
        "institution_opt_out_federal_ids": [
          "string"
        ],
        "tin": "string"
      }
    ],
    "managed_sweep_target_balance": "string",
    "shadow_account": {
      "id": "string",
      "account_number": "string",
      "account_type": "MMDA",
      "closed_at": "string"
    },
    "notes": "string",
    "pricing_group_id": "string",
    "rate": "string",
    "floating_spread": "string",
    "floating_spread_bps": "string",
    "rate_index_type": "EFFR",
    "floating_rate_percentage": "string",
    "index_rate": "string",
    "custom_benchmark_id": "string",
    "custom_benchmark_rate": "string",
    "account_officer": "string",
    "is_non_interest_bearing": false,
    "custom_field_1": "string",
    "custom_field_2": "string",
    "custom_field_3": "string",
    "custom_field_4": "string",
    "is_q2_funds_transfer_enabled": false,
    "institution_account_id": "string",
    "institution_alternative_id": "string"
  }
]

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

statuseslist of enums or nullOptional

Filter accounts by status. May be specified multiple times (e.g. ?statuses=CLOSED&statuses=SCHEDULED_FOR_CLOSURE). If omitted, accounts of all statuses are returned.

Allowed values:

institution_account_idslist of strings or nullOptional

Return only accounts whose institution_sweep_account_id or institution_return_account_id is one of these values. Repeat the parameter for each value, up to 1000 per request. Closed accounts are included unless statuses is also supplied.

Response

Successful Response

idstring

institution_idstring

signer_primarystring or null

account_titlestring

interest_ratestring

interest_rate_tierslist of objects

insurance_limitstring

account_typeenum

Allowed values:

created_atstring

is_joint_accountboolean

total_balancestring

pending_balancestring

is_reciprocation_prioritizedboolean

is_receiving_printed_statementsboolean

rate_configurationenum

Allowed values:

signer_primary_tin_last4string or nullOptional

closed_atstring or nullOptional

signer_secondarystring or nullOptional

beneficiary_namestring or nullOptional

beneficiary_tinstring or nullOptional

beneficiary_tin_last4string or nullOptional

institution_sweep_account_idstring or nullOptional

institution_return_account_idstring or nullOptional

institution_branch_idstring or nullOptional

cost_center_idstring or nullOptional

cost_center_codestring or nullOptional

depositorslist of objects or nullOptional

managed_sweep_target_balancestring or nullOptional

shadow_accountobject or nullOptional

notesstring or nullOptional

pricing_group_idstring or nullOptional

ratestring or nullOptional

floating_spreadstring or nullOptional

floating_spread_bpsstring or nullOptional

rate_index_typeenum or nullOptional

floating_rate_percentagestring or nullOptional

index_ratestring or nullOptional

custom_benchmark_idstring or nullOptional

custom_benchmark_ratestring or nullOptional

account_officerstring or nullOptional

Account officer assigned to this account

is_non_interest_bearingbooleanOptionalDefaults to false

Whether this account is non-interest-bearing

custom_field_1string or nullOptional

Custom field 1

custom_field_2string or nullOptional

Custom field 2

custom_field_3string or nullOptional

Custom field 3

custom_field_4string or nullOptional

Custom field 4

is_q2_funds_transfer_enabledbooleanOptionalDefaults to false

Whether the Q2 digital banking integration may move this account's funds. False when the institution's Q2 enrollment is not enabled or the account is exempt from integration.

institution_account_idstring or nullOptionalDeprecated

institution_alternative_idstring or nullOptionalDeprecated

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error

500

Internal Server Error