List

List external bank accounts

get/v1/external_bank_accounts

List all the external bank accounts for the provided search criteria.

Query Parameters

account_tokenstring

optional

formatuuid

account_typesarray of enum

optional

Hide ParametersShow Parameters

"CHECKING"

"SAVINGS"

countriesarray of string

optional

ending_beforestring

optional

A cursor representing an item's token before which a page of results should end. Used to retrieve the previous page of results before this item.

owner_typesarray of OwnerType

optional

page_sizenumber

optional

Page size (for pagination).

maximum100

minimum1

starting_afterstring

optional

A cursor representing an item's token after which a page of results should begin. Used to retrieve the next page of results after this item.

statesarray of enum

optional

Hide ParametersShow Parameters

"ENABLED"

"CLOSED"

"PAUSED"

verification_statesarray of enum

optional

Hide ParametersShow Parameters

"PENDING"

"ENABLED"

"FAILED_VERIFICATION"

"INSUFFICIENT_FUNDS"

Returns

dataarray of object

Hide ParametersShow Parameters

tokenstring

A globally unique identifier for this record of an external bank account association. If a program links an external bank account to more than one end-user or to both the program and the end-user, then Lithic will return each record of the association

formatuuid

countrystring

The country that the bank account is located in using ISO 3166-1. We will only accept USA bank accounts e.g., USA

createdstring

An ISO 8601 string representing when this funding source was added to the Lithic account.

formatdate-time

currencystring

currency of the external account 3-character alphabetic ISO 4217 code

last_fourstring

The last 4 digits of the bank account. Derived by Lithic from the account number passed

ownerstring

Legal Name of the business or individual who owns the external account. This will appear in statements

owner_typeenum

Accepts one of the following: "BUSINESS", "INDIVIDUAL"

Owner Type

Hide ParametersShow Parameters

"BUSINESS"

"INDIVIDUAL"

routing_numberstring

Routing Number

stateenum

Accepts one of the following: "ENABLED", "CLOSED", "PAUSED"

Account State

Hide ParametersShow Parameters

"ENABLED"

"CLOSED"

"PAUSED"

typeenum

Accepts one of the following: "CHECKING", "SAVINGS"

Account Type

Hide ParametersShow Parameters

"CHECKING"

"SAVINGS"

verification_attemptsnumber

The number of attempts at verification

verification_methodenum

Accepts one of the following: "MANUAL", "MICRO_DEPOSIT", "PLAID", "PRENOTE"

Verification Method

Hide ParametersShow Parameters

"MANUAL"

"MICRO_DEPOSIT"

"PLAID"

"PRENOTE"

verification_stateenum

Accepts one of the following: "PENDING", "ENABLED", "FAILED_VERIFICATION", "INSUFFICIENT_FUNDS"

Verification State

Hide ParametersShow Parameters

"PENDING"

"ENABLED"

"FAILED_VERIFICATION"

"INSUFFICIENT_FUNDS"

account_tokenstring

optional

Indicates which Lithic account the external account is associated with. For external accounts that are associated with the program, account_token field returned will be null

formatuuid

addressaddress1stringcitystringcountrystringpostal_codestringstatestringaddress2stringExternalBankAccountAddress

optional

Address

company_idstring

optional

Optional field that helps identify bank accounts in receipts

dobstring

optional

Date of Birth of the Individual that owns the external bank account

formatdate

doing_business_asstring

optional

Doing Business As

financial_account_tokenstring

optional

The financial account token of the operating account to fund the micro deposits

formatuuid

namestring

optional

The nickname for this External Bank Account

user_defined_idstring

optional

User Defined ID

verification_failed_reasonstring

optional

Optional free text description of the reason for the failed verification. For ACH micro-deposits returned, this field will display the reason return code sent by the ACH network

has_moreboolean

Request example Request

curl https://api.lithic.com/v1/external_bank_accounts \
    -H "Authorization: $LITHIC_API_KEY"

200 Example

{
  "data": [
    {
      "token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "country": "country",
      "created": "2019-12-27T18:11:19.117Z",
      "currency": "currency",
      "last_four": "last_four",
      "owner": "owner",
      "owner_type": "BUSINESS",
      "routing_number": "routing_number",
      "state": "ENABLED",
      "type": "CHECKING",
      "verification_attempts": 0,
      "verification_method": "MANUAL",
      "verification_state": "PENDING",
      "account_token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "address": {
        "address1": "x",
        "city": "x",
        "country": "USD",
        "postal_code": "11201",
        "state": "xx",
        "address2": "x"
      },
      "company_id": "company_id",
      "dob": "2019-12-27",
      "doing_business_as": "doing_business_as",
      "financial_account_token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "name": "name",
      "user_defined_id": "user_defined_id",
      "verification_failed_reason": "verification_failed_reason"
    }
  ],
  "has_more": true
}