$
loading_
← zpět do aplikace

API DOCUMENTATION

Convert bank statements programmatically

// GETTING STARTED

The BSC API allows you to convert PDF bank statements to Excel (.xlsx) or CSV format programmatically. All API conversions count against your plan's monthly page limit and appear in your "Recent" conversions list.

1. Subscribe to any paid plan
2. Generate an API token from the API Access section on the main page
3. Send requests with your token in the Authorization header

// AUTHENTICATION

All API requests require a Bearer token. Include it in the Authorization header:

Authorization: Bearer bsc_your_token_here

Tokens are shown only once when generated. If you lose a token, revoke it and create a new one.

// CONVERT ENDPOINT

POST/api/v1/convert

Request

PartDetails
Content-Typemultipart/form-data
Body fieldfile — the PDF file
AuthorizationBearer <token>

Query Parameters

ParamTypeDefaultDescription
formatstringxlsxOutput format: xlsx or csv
minimalstringfalseSet to true to strip all headers — only raw transaction rows

Response

200 OK — The converted file as a binary download (xlsx or csv)

Custom response headers are included with metadata:

HeaderDescription
X-BSC-BankDetected bank name
X-BSC-TransactionsNumber of transactions extracted
X-BSC-Partialtrue if only partial pages were processed (plan limit)
X-BSC-Pages-ProcessedNumber of pages actually processed
X-BSC-Pages-TotalTotal pages in the PDF

Error Responses

Errors return JSON with an error field:

StatusMeaning
400Bad request (missing file, invalid format, not a PDF)
401Invalid or missing API token
403No active subscription
429Page limit reached
500Conversion failed (parsing error)

// OUTPUT FORMATS

XLSX (default)

> Normal: bank info header, column names, styled rows

> Minimal: raw transaction rows only, no headers or styling

CSV

> Normal: bank info, column headers, then transaction rows

> Minimal: transaction rows only — date,description,amount,balance,reference,counterparty

// EXAMPLES

Convert to Excel:
curl -X POST "/api/v1/convert?format=xlsx" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "file=@statement.pdf" \
  --output converted.xlsx
Convert to CSV:
curl -X POST "/api/v1/convert?format=csv" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "file=@statement.pdf" \
  --output converted.csv
Minimal CSV (data only, no headers):
curl -X POST "/api/v1/convert?format=csv&minimal=true" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "file=@statement.pdf" \
  --output data.csv

// USAGE & LIMITS

API conversions share your plan's monthly page limit. Each page of an uploaded PDF counts as one page toward your limit.

Starter500 pages/month
Pro2,000 pages/month
Business6,000 pages/month

If you exceed your limit, the API will return a 429 status. If a PDF has more pages than your remaining quota, only the allowed pages will be processed and the partial flag will be set.

// DATA COLUMNS

Each transaction row contains these fields (in both xlsx and csv):

ColumnTypeDescription
datestringTransaction date (YYYY-MM-DD)
descriptionstringTransaction description / memo
amountnumberPositive = credit, negative = debit
balancenumber?Running balance after transaction (may be empty)
referencestring?Bank reference or transaction ID
counterpartystring?Name of the other party

// NEED HELP?

Having issues with the API? Contact us at or use the contact form on the main page.