Skip to main content
POST
/
bank_statements
Submit bank statement
curl --request POST \
  --url https://api.ledgerbeam.com/v1/bank_statements \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "url": "https://example.com/statement.pdf"
}'
{
  "id": "bs_123456789",
  "url": "https://example.com/statement.pdf",
  "status": "processing",
  "created_at": "2024-01-15T10:30:00Z",
  "processed_at": "2024-01-15T10:35:00Z"
}

​
Overview

Submit a bank statement for processing and transaction extraction. This endpoint accepts a URL to a bank statement file and begins the processing workflow.
  • Statement Processing: Upload bank statements for automated transaction extraction
  • Bulk Import: Process multiple bank statements in batch
  • Integration: Submit statements from external systems
  • Data Migration: Import historical transaction data

Authorizations

​
API-KEY
string
header
required

API key for authentication

Body

application/json
​
url
string<uri>
required

URL of the bank statement file

Example:

"https://example.com/statement.pdf"

Response

Bank statement submitted successfully

​
id
string

Bank statement ID

Example:

"bs_123456789"

​
url
string<uri>

URL of the bank statement file

Example:

"https://example.com/statement.pdf"

​
status
enum<string>

Processing status

Available options:
processing,
completed,
failed
Example:

"processing"

​
created_at
string<date-time>

Creation timestamp

Example:

"2024-01-15T10:30:00Z"

​
processed_at
string<date-time> | null

Processing completion timestamp

Example:

"2024-01-15T10:35:00Z"