Skip to main content
GET
/
bankstatements
/
{user_id}
Returns all bank statement submissions for a user
curl --request GET \
  --url https://api.sandbox.goteal.co/bankstatements/{user_id} \
  --header 'X-API-KEY: <api-key>'
{
  "pagination": {
    "offset": 75,
    "limit": 25,
    "count": 14,
    "total_count": 89
  },
  "bank_statement_submissions": [
    {
      "id": "95a0e70b-fe02-4f47-aef9-2efff279df71",
      "created_at": "2019-05-17T00:00:00.000Z",
      "document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "document_external_id": "<string>",
      "document_filename": "<string>",
      "account_information": {
        "account_holder_name": "JANE DOE",
        "account_number": "12345678",
        "sort_code": "12-34-56",
        "bank_name": "HSBC",
        "iban": "<string>"
      },
      "statement_period": {
        "start_date": "2024-01-01",
        "end_date": "2024-01-31"
      },
      "balance_information": {
        "opening_balance": "1,000.00",
        "closing_balance": "1,250.00"
      },
      "transactions": [
        {
          "date": "2024-01-15",
          "description": "Salary Payment",
          "amount": "2,500.00",
          "type": "credit"
        }
      ],
      "bank_statement_probability": 0.95
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.goteal.co/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
user_id
string<uuid>
required

ID of the user to get bank statements for

Query Parameters

​
offset
integer<int64>
default:0

The offset to start at

Required range: x >= 0
​
limit
integer<int64>
default:100

The number of items to return

Required range: 1 <= x <= 1000
​
created_after
string<date-time>

Filter out bank statements created before the given date

Example:

"2024-01-01T00:00:00.000Z"

​
created_before
string<date-time>

Filter out bank statements created after the given date

Example:

"2024-12-31T23:59:59.000Z"

Response

OK

​
pagination
object
​
bank_statement_submissions
object[]