Get Account | Modernfi

{
  "id": "a3f1c9d2-4b7e-4f8a-9c3d-2e5b7f9a1c4d",
  "institution_id": "bank_987654321",
  "signer_primary": "John A. Smith",
  "account_title": "John Smith Savings",
  "interest_rate": "1.25%",
  "interest_rate_tiers": [
    {
      "min_balance": "0.00",
      "max_balance": "10000.00",
      "rate": "1.00%",
      "floating_spread": "0.10%",
      "rate_index_type": "EFFR",
      "floating_rate_percentage": "1.10%",
      "custom_benchmark_id": "benchmark_001"
    }
  ],
  "insurance_limit": "250000.00",
  "account_type": "MMDA",
  "created_at": "2023-11-01T09:15:00Z",
  "is_joint_account": true,
  "total_balance": "15234.56",
  "pending_balance": "200.00",
  "is_reciprocation_prioritized": true,
  "is_receiving_printed_statements": false,
  "rate_configuration": "FIXED",
  "signer_primary_tin_last4": "1234",
  "closed_at": null,
  "signer_secondary": "Jane B. Smith",
  "beneficiary_name": "Estate of John Smith",
  "beneficiary_tin": "987654321",
  "beneficiary_tin_last4": "4321",
  "institution_sweep_account_id": "sweep_acc_654321",
  "institution_return_account_id": "return_acc_789012",
  "institution_branch_id": "branch_001",
  "cost_center_id": "cc_2024_01",
  "cost_center_code": "CC1001",
  "depositors": [
    {
      "id": "dep_001",
      "institution_id": "bank_987654321",
      "institution_depositor_id": "dep_inst_001",
      "first_name": "John",
      "last_name": "Smith",
      "entity_name": null,
      "is_organization": false,
      "phone_numbers": [
        {
          "number": "+1-555-123-4567",
          "is_primary": true
        }
      ],
      "emails": [
        {
          "email_address": "john.smith@example.com",
          "is_primary": true
        }
      ],
      "addresses": [
        {
          "street": "123 Maple Street",
          "city": "Springfield",
          "state": "IL",
          "zip": "62704",
          "country_code": "US",
          "is_primary": true
        }
      ],
      "depositor_type": "CONSUMER",
      "tin_last_four": "6789",
      "ownership_category": "JOINT",
      "account_officer": "Sarah Johnson",
      "notes": "Primary account holder",
      "institution_opt_out_federal_ids": [
        "fed_001",
        "fed_002"
      ],
      "tin": "123456789"
    }
  ],
  "managed_sweep_target_balance": "5000.00",
  "shadow_account": {
    "id": "shadow_123",
    "account_number": "9876543210",
    "account_type": "MMDA",
    "closed_at": null
  },
  "notes": "Account opened for savings purposes",
  "pricing_group_id": "pricing_2024A",
  "rate": "1.25%",
  "floating_spread": "0.05%",
  "floating_spread_bps": "5",
  "rate_index_type": "EFFR",
  "floating_rate_percentage": "1.30%",
  "index_rate": "1.20%",
  "custom_benchmark_id": "benchmark_custom_01",
  "custom_benchmark_rate": "1.15%",
  "account_officer": "Sarah Johnson",
  "is_non_interest_bearing": false,
  "custom_field_1": "Preferred customer",
  "custom_field_2": "Tier 1",
  "custom_field_3": "N/A",
  "custom_field_4": "N/A",
  "institution_account_id": "inst_acc_123456",
  "institution_alternative_id": "alt_id_456789"
}

Authentication

AuthorizationBearer

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

Path parameters

account_idstringRequired

Query parameters

id_typeenum or nullOptional

Type of the account id. Must be 'institution' or 'None'.

Allowed values:

Response

Successful Response

idstring

institution_idstring

signer_primarystring or null

account_titlestring

interest_ratestring

interest_rate_tierslist of objects

insurance_limitstring

account_typeenum

created_atstring

is_joint_accountboolean

total_balancestring

pending_balancestring

is_reciprocation_prioritizedboolean

is_receiving_printed_statementsboolean

rate_configurationenum

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

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

$	curl https://api.modernfi.com/digital-banking/v1/accounts/string \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json"