Skip to main content
PUT
/
documents
/
bank-statements
/
presign
Generate presigned URLs for bank statement uploads
curl --request PUT \
  --url https://api.sandbox.goteal.co/documents/bank-statements/presign \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "files": [
    {
      "file_name": "hsbc-january-2024.pdf",
      "external_id": "ext-stmt-2024-01"
    }
  ]
}
'
{
  "presigned_urls": [
    {
      "file_name": "hsbc-january-2024.pdf",
      "presigned_url": "https://s3.amazonaws.com/bucket/presigned-upload-key?signature=abc123",
      "path": "client/acct123/users/user456/stmt1.pdf",
      "external_id": "ext-stmt-2024-01"
    }
  ]
}

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

Bank statement files that require presigned upload URLs

Minimum array length: 1

Response

Presigned URLs generated successfully

presigned_urls
object[]
required

Generated URLs and metadata for uploading the requested files.