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"
}
]
}
'import requests
url = "https://api.sandbox.goteal.co/documents/bank-statements/presign"
payload = { "files": [
{
"file_name": "hsbc-january-2024.pdf",
"external_id": "ext-stmt-2024-01"
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({files: [{file_name: 'hsbc-january-2024.pdf', external_id: 'ext-stmt-2024-01'}]})
};
fetch('https://api.sandbox.goteal.co/documents/bank-statements/presign', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.goteal.co/documents/bank-statements/presign",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'files' => [
[
'file_name' => 'hsbc-january-2024.pdf',
'external_id' => 'ext-stmt-2024-01'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.goteal.co/documents/bank-statements/presign"
payload := strings.NewReader("{\n \"files\": [\n {\n \"file_name\": \"hsbc-january-2024.pdf\",\n \"external_id\": \"ext-stmt-2024-01\"\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.sandbox.goteal.co/documents/bank-statements/presign")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"files\": [\n {\n \"file_name\": \"hsbc-january-2024.pdf\",\n \"external_id\": \"ext-stmt-2024-01\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.goteal.co/documents/bank-statements/presign")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"files\": [\n {\n \"file_name\": \"hsbc-january-2024.pdf\",\n \"external_id\": \"ext-stmt-2024-01\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"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"
}
]
}{
"errors": [
"The request is missing the required field `name`"
]
}{
"errors": [
"Not Authorization: Bearer <token> provided or wrong value"
]
}Doc Scan
Presign bank statement uploads
Generates short-lived presigned URLs that you can use to upload bank statement PDFs directly to Teal-managed storage. Use this endpoint before uploading any files and submitting them for processing.
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"
}
]
}
'import requests
url = "https://api.sandbox.goteal.co/documents/bank-statements/presign"
payload = { "files": [
{
"file_name": "hsbc-january-2024.pdf",
"external_id": "ext-stmt-2024-01"
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({files: [{file_name: 'hsbc-january-2024.pdf', external_id: 'ext-stmt-2024-01'}]})
};
fetch('https://api.sandbox.goteal.co/documents/bank-statements/presign', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.goteal.co/documents/bank-statements/presign",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'files' => [
[
'file_name' => 'hsbc-january-2024.pdf',
'external_id' => 'ext-stmt-2024-01'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.goteal.co/documents/bank-statements/presign"
payload := strings.NewReader("{\n \"files\": [\n {\n \"file_name\": \"hsbc-january-2024.pdf\",\n \"external_id\": \"ext-stmt-2024-01\"\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.sandbox.goteal.co/documents/bank-statements/presign")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"files\": [\n {\n \"file_name\": \"hsbc-january-2024.pdf\",\n \"external_id\": \"ext-stmt-2024-01\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.goteal.co/documents/bank-statements/presign")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"files\": [\n {\n \"file_name\": \"hsbc-january-2024.pdf\",\n \"external_id\": \"ext-stmt-2024-01\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"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"
}
]
}{
"errors": [
"The request is missing the required field `name`"
]
}{
"errors": [
"Not Authorization: Bearer <token> provided or wrong value"
]
}Authorizations
Bearer token for authentication. The token should be the one returned by the /user-tokens endpoint.
Headers
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-4f6a-8b8c-9a0b1c2d3e4f"
Body
application/json
Bank statement files that require presigned upload URLs
Minimum array length:
1Show child attributes
Show child attributes
Response
Presigned URLs generated successfully
Generated URLs and metadata for uploading the requested files.
Show child attributes
Show child attributes
⌘I