Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.swippee.com/llms.txt

Use this file to discover all available pages before exploring further.

Once a report is complete, each product is a focused GET on it. All take a Bearer key and return JSON shaped for that one product — call only what you need, billed as one parse regardless of how many you read.
ProductEndpointReturns
Asset ReportGET /v1/reports/:id/asset-reportThe full underwriting view — statement, signals, monthly summary, categories, and every transaction.
IncomeGET /v1/reports/:id/incomeSalary detection (amount, regularity, day-of-month), monthly credits, stability score, and income transactions.
IdentityGET /v1/reports/:id/identityAccount holder, account number, bank, currency, and statement period.
BalanceGET /v1/reports/:id/balanceOpening/closing balances, average and minimum balance, and the balance trend.
LiabilitiesGET /v1/reports/:id/liabilitiesEMI/loan obligations bucketed by detected lender, monthly EMI total, EMI load %, and bounce count.
ScoreGET /v1/reports/:id/scoreA single 0–1000 creditworthiness score derived from the statement signals.
VerifyGET /v1/reports/:id/verifyForgery/tamper detection — a verdict (authentic | review | suspicious), confidence, and every check with pass/fail + severity.
UnderwritingPOST /v1/reports/:id/underwritingFull lender decision: FOIR, disposable income, max supportable EMI, risk flags, approve/review/decline verdict. Bills 1 unit per call.
# fetch just the income view of a completed report
curl https://api.swippee.com/v1/reports/cl_abc123/income \
  -H "Authorization: Bearer $SWIPPEE_API_KEY"
enrich is a transform endpoint (POST /v1/enrich) — send raw transactions, get merchant / MCC / category tags back. connect is the hosted upload flow — see the Connect guide.