Skip to main content
GET
/
bank-statements
/
{id}
/
balance-summary
Get balance summary
curl --request GET \
  --url https://api.anycheck.ai/bank-statements/{id}/balance-summary \
  --header 'X-API-Key: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "account_number": "1234567890",
  "balance_summary": [
    {
      "month": "2023-01",
      "highest_balance": 5000000,
      "lowest_balance": 1000000,
      "beginning_of_month_balance": 2000000,
      "end_of_month_balance": 2500000,
      "average_balance": 2750000,
      "swing": 4000000
    }
  ]
}

Authorizations

​
X-API-Key
string
header
required

API key for service-to-service authentication

Path Parameters

​
id
string<uuid>
required

Verification ID

Query Parameters

​
account_number
string
required

Account number (required)

​
month
string

Filter by month (YYYY-MM format)

Pattern: ^\\d{4}-\\d{2}$

Response

Balance summary data

​
id
string<uuid>

Verification ID

​
account_number
string

Account number

Example:

"1234567890"

​
balance_summary
object[]