Skip to main content
POST
Parse a bank statement

Authorizations

Authorization
string
header
required

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

Headers

Idempotency-Key
string

Optional. A unique key (e.g. a UUID v4) so a retry replays the original response instead of creating a duplicate report or double-charging. See https://docs.swippee.com/concepts/idempotency

Required string length: 8 - 255

Body

multipart/form-data
file
file
required

The statement file. PDF, Excel, JPEG, or PNG. Max 20 MB.

bank
enum<string>
default:auto

Bank hint, or auto to detect. GLOBAL_IME is in beta.

Available options:
auto,
NABIL,
NIC_ASIA,
NIMB,
NMB,
KUMARI,
SIDDHARTHA,
PRABHU,
GARIMA,
GLOBAL_IME,
ESEWA,
KHALTI
async
boolean
default:false

If true, returns 202 + poll_url immediately and processes in the background.

Response

Parsed 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[]