v1

latestOpenAPI 3.0.0Apache 2.02026-07-244385400.4 KB
Bank Accounts

List Bank Accounts

Returns a list of bank accounts for a customer. The list is sorted by creation date, with the most recently created bank accounts appearing first.

get/customers/{customer_id}/bank_accounts

Path parameters

customer_idstring uuid required

The Inscribe customer id.

Query parameters

sizeinteger required

Set the number of bank accounts to be returned by request.

cursorstring uuid

A cursor to retrieve the next set of bank accounts, starting after the cursor. If no cursor is sent, the first set of bank accounts will be returned.

include_unreconciled_documentsboolean

Unreconciled bank statements are statements where the difference between the parsed opening and closing balances is not explained by the sum of the parsed transaction amounts. Statements are typically unreconciled if the uploaded document has poor quality or is missing some of its original pages. It can also happen when the parsing models fail to parse and extract all relevant data. If this parameter is set to False, unreconciled bank statements will be excluded from the credit insights. This parameter defaults to True, keeping all documents included.

Response

Returns back a list of Bank Account objects.

Example response

{
  "data": [
    {
      "id": "3efae611-ct4b84-8ed0-a4e92ad3bf4bg",
      "account_number": 123456789,
      "account_type": "PERSONAL",
      "account_name": "Chase Premium Checking",
      "end_date": "2022-07-25",
      "start_date": "2022-06-25",
      "guid": "9a5f7a95-8c84-47db-8b2f-584a2f258e7e",
      "institution_name": "JP Morgan Chase"
    },
    {
      "id": "7yfae611-ct4b84-8ed0-a4e92ad3bf4tg",
      "account_number": 123456789,
      "account_type": "PERSONAL",
      "account_name": "Wells Fargo Active Savings",
      "end_date": "2022-07-25",
      "start_date": "2022-06-25",
      "guid": "4b9fdda9-4e60-4123-9728-5d292e216e33",
      "institution_name": "Wells Fargo"
    },
    {
      "id": "8pfae611-ct4b84-8ed0-a4e92ad3bf6dt",
      "account_number": 123456789,
      "account_type": "BUSINESS",
      "account_name": "Bank of America Business Checking",
      "end_date": "2022-07-25",
      "start_date": "2022-06-25",
      "guid": "614e00c4-d533-4cf0-b4bf-d69c9644f9c0",
      "institution_name": "Bank of America"
    }
  ],
  "pagination": {
    "cursor": "9361c7fb-934b-4cac-8e07-4897e590ab94"
  },
  "metadata": {
    "customer_contains_low_trust_score_documents": true,
    "included_data_sources": {
      "documents": [
        {
          "document_id": "3efae611-ct4b84-8ed0-a4e92ad3bf4bg"
        },
        {
          "document_id": "7yfae611-ct4b84-8ed0-a4e92ad3bf4tg"
        },
        {
          "document_id": "8pfae611-ct4b84-8ed0-a4e92ad3bf6dt"
        }
      ],
      "open_banking": []
    },
    "excluded_data_sources": {
      "documents": [],
      "open_banking": []
    },
    "query_parameters": {
      "include_unreconciled_documents": true
    }
  }
}
All 43 operations