Upload a bank statement (write scope)

curl --request POST \
  --url https://api.trycherry.ai/v1/bank-statements \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form file='@example-file' \
  --form entityId=3c90c3cc-0d44-4b50-8888-8dd25736052a

import requests

url = "https://api.trycherry.ai/v1/bank-statements"

files = { "file": ("example-file", open("example-file", "rb")) }
payload = { "entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a" }
headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('file', '<string>');
form.append('entityId', '3c90c3cc-0d44-4b50-8888-8dd25736052a');

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

fetch('https://api.trycherry.ai/v1/bank-statements', 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.trycherry.ai/v1/bank-statements",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"entityId\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data"
  ],
]);

$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.trycherry.ai/v1/bank-statements"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"entityId\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.trycherry.ai/v1/bank-statements")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"entityId\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.trycherry.ai/v1/bank-statements")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"entityId\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "data": {
    "documentId": "9f8e7d6c-5b4a-4321-8765-4321fedcba98",
    "status": "processing"
  }
}

{
  "error": "<string>",
  "reason": "<string>"
}

{
  "error": "<string>",
  "reason": "<string>"
}

{
  "error": "<string>",
  "reason": "<string>"
}

{
  "error": "<string>",
  "reason": "<string>"
}

{
  "error": "<string>",
  "reason": "<string>"
}

Bank statements

Upload a bank statement (write scope)

Send a statement file and Cherry does the rest: transcribes it, verifies the transactions roll the opening balance forward to the printed closing balance (a statement that doesn’t reconcile is rejected whole), creates or matches the manual institution + account, and lands the transactions — deduplicated against rows pushed via POST /transactions.

Processing is asynchronous: the response is a 202 with a documentId; poll GET /bank-statements/ for the outcome (typically well under a minute). Re-uploading the same statement is a no-op: the period is keyed by (account, periodStart, periodEnd) and each transaction by its content, so nothing duplicates.

PDF is the best input; images of statements work too. 25 MB max. Requires the write scope. Rate-limited more tightly than other writes — each upload costs a transcription pass.

POST

bank-statements

Upload a bank statement (write scope)

curl --request POST \
  --url https://api.trycherry.ai/v1/bank-statements \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form file='@example-file' \
  --form entityId=3c90c3cc-0d44-4b50-8888-8dd25736052a

import requests

url = "https://api.trycherry.ai/v1/bank-statements"

files = { "file": ("example-file", open("example-file", "rb")) }
payload = { "entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a" }
headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('file', '<string>');
form.append('entityId', '3c90c3cc-0d44-4b50-8888-8dd25736052a');

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

fetch('https://api.trycherry.ai/v1/bank-statements', 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.trycherry.ai/v1/bank-statements",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"entityId\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data"
  ],
]);

$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.trycherry.ai/v1/bank-statements"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"entityId\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.trycherry.ai/v1/bank-statements")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"entityId\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.trycherry.ai/v1/bank-statements")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"entityId\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "data": {
    "documentId": "9f8e7d6c-5b4a-4321-8765-4321fedcba98",
    "status": "processing"
  }
}

{
  "error": "<string>",
  "reason": "<string>"
}

{
  "error": "<string>",
  "reason": "<string>"
}

{
  "error": "<string>",
  "reason": "<string>"
}

{
  "error": "<string>",
  "reason": "<string>"
}

{
  "error": "<string>",
  "reason": "<string>"
}

Authorizations

Authorization

string

header

required

Cherry API key, created in the app. Sent as Authorization: Bearer ck_live_….

Body

multipart/form-data

file

required

The statement file (PDF or image). Max 25 MB.

entityId

string<uuid>

Legal entity the account belongs to (UUID from GET /entities). Defaults to the tenant's primary entity.

Response

Accepted — processing has started.

data

object

Show child attributes

⌘I

Meta

Transactions

Accounts

Bank accounts

Bank statements

Journal

Reports

Entities

Obligations

Health

Upload a bank statement (write scope)

Authorizations

Body

Response