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": [
    "<unknown>"
  ],
  "bank_statement_errors": [
    {
      "error": "<string>",
      "file_name": "<string>"
    }
  ]
}

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
any[]
​
bank_statement_errors
object[]