Get Account | 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",
  "institution_account_id": "string",
  "institution_alternative_id": "string"
}

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 null

closed_atstring or null

signer_secondarystring or null

beneficiary_namestring or null

beneficiary_tinstring or null

beneficiary_tin_last4string or null

institution_sweep_account_idstring or null

institution_return_account_idstring or null

institution_branch_idstring or null

cost_center_idstring or null

cost_center_codestring or null

depositorslist of objects or null

managed_sweep_target_balancestring or null

shadow_accountobject or null

notesstring or null

pricing_group_idstring or null

ratestring or null

floating_spreadstring or null

floating_spread_bpsstring or null

rate_index_typeenum or null

floating_rate_percentagestring or null

index_ratestring or null

custom_benchmark_idstring or null

custom_benchmark_ratestring or null

account_officerstring or null

Account officer assigned to this account

is_non_interest_bearingbooleanDefaults to false

Whether this account is non-interest-bearing

custom_field_1string or null

Custom field 1

custom_field_2string or null

Custom field 2

custom_field_3string or null

Custom field 3

custom_field_4string or null

Custom field 4

institution_account_idstring or nullDeprecated

institution_alternative_idstring or nullDeprecated

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>"