v1

latestOpenAPI 3.1.02026-07-13385987.3 KB

Bank statements

Extracts bank and account details for instant file verification and UI enhancements.

Statement Info endpoint is a low-latency response analysing the first page of a bank statement which returns key identification details such as the underlying bank institution and the account-holder. The can be used for UX improvements through instant verification of correct file upload, for UI improvements like returning bank names and logos, or for logging information about a file upon upload.

get/datasources/bank_statements/{uuid}/statement-info

Path parameters

uuidstring required

Response

Successful Response

institutionstring nullable

start_datestring date nullable

end_datestring date nullable

Example response

{
  "account_holder": {
    "address": {
      "city": "Victoria",
      "country": "United States",
      "postcode": "77901",
      "state": "Texas",
      "street": "601 Rosebud Avenue"
    },
    "name": "John Doe",
    "type": "consumer"
  },
  "accounts": [
    {
      "closing_balance": 1500,
      "iso_currency_code": "USD",
      "number": "83721",
      "opening_balance": 1000,
      "type": "checking"
    }
  ],
  "end_date": "2024-02-01",
  "institution": "Well's Fargo",
  "start_date": "2024-01-01"
}