Skip to main content
GET
/
bank_statements
/
{id}
Get bank statement
curl --request GET \
  --url https://api.ledgerbeam.com/v1/bank_statements/{id} \
  --header 'API-KEY: <api-key>'
{
  "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

Retrieve detailed information about a specific bank statement by its ID.
  • Statement Details: Get complete information about a specific bank statement
  • Status Checking: Monitor the processing status of a statement
  • Integration: Fetch statement data for external systems
  • Audit Trail: Access statement processing history

Authorizations

​
API-KEY
string
header
required

API key for authentication

Path Parameters

​
id
string
required

Bank statement ID

Response

Bank statement retrieved 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"