Skip to main content
PUT
/
documents
/
bank-statements
Submit previously uploaded bank statements for processing
curl --request PUT \
  --url https://api.sandbox.goteal.co/documents/bank-statements \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "files": [
    {
      "path": "client/acct123/users/user456/stmt1.pdf",
      "external_document_id": "ext-stmt-2024-01"
    }
  ]
}
'
{
  "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
    }
  ],
  "bank_statement_errors": [
    {
      "error": "<string>",
      "file_name": "<string>"
    }
  ]
}

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

Authorization
string
header
required

Bearer token for authentication. The token should be the one returned by the /user-tokens endpoint.

Headers

x-teal-authorisation-id
string<uuid>

Optional authorisation ID to associate with this request. If not provided, the system will attempt to resolve a valid authorisation for the user automatically.

Example:

"7f3b8c2a-1d4e-5f6g-7h8i-9j0k1l2m3n4o"

Body

application/json
files
object[]
required
Minimum array length: 1

Response

OK — all files successfully extracted

bank_statement_submissions
object[]

Successfully processed bank statements

bank_statement_errors
object[]

Files that failed extraction