Skip to main content
GET
Get a report

Authorizations

Authorization
string
header
required

Your API key from the dashboard, sent as Authorization: Bearer swippee_sk_live_....

Path Parameters

id
string
required

Response

The report

report_id
string
Example:

"cl_abc123"

status
string
Example:

"complete"

data_source
enum<string>

How the data was obtained: parsed from the bank's PDF/Excel, or read from a photo/scan.

Available options:
PARSED_STATEMENT,
OCR_IMAGE
Example:

"PARSED_STATEMENT"

tamper_verifiable
boolean

Whether the source supports document tamper-verification (false for OCR_IMAGE).

Example:

true

statement
object
signals
object
monthly_summary
object[]
categories
object
merchant_categories
object
transactions
object[]