Skip to main content
POST
Create a sandbox report

Authorizations

Authorization
string
header
required

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

Body

application/json
scenario
enum<string>
default:salaried

A report scenario, or an error_* scenario to force a failure.

Available options:
salaried,
thin_file,
high_risk,
remittance,
error_unsupported_bank,
error_unsupported_document,
error_password_required,
error_image_not_tamper_verified,
error_tamper_detected
override_transactions
object[]

Extra transactions appended to the scenario (balance is recomputed).

Response

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