# Swippee

> Developer documentation for Swippee — Nepal's financial data layer. Convert Nepali bank statement PDFs into structured, machine-readable data, and read Nepal's public-sector financial datasets over a single REST API.

## Docs

- [Get usage](https://docs.swippee.com/api-reference/account/get-usage.md): Check your quota and usage for the current month.
- [Get a bank profile](https://docs.swippee.com/api-reference/banks/get-a-bank-profile.md): Full profile for one bank — SWIFT code, branch count, contact info, NRB paid-up capital, head office, and current Nepal market interest rates.
- [List banks](https://docs.swippee.com/api-reference/banks/list-banks.md): List all banks and wallets Swippee knows about, with live NRB BFI data. READ_ONLY scope, no quota consumed.
- [Create a Connect request](https://docs.swippee.com/api-reference/connect/create-a-connect-request.md): Your backend starts a hosted consent flow. Returns a request_token and connect_url to open in the browser.
- [Exchange a public token](https://docs.swippee.com/api-reference/connect/exchange-a-public-token.md): Exchange the public_token from a completed Connect flow for an access_token and grant_id.
- [Read granted data](https://docs.swippee.com/api-reference/connect/read-granted-data.md): Read only the scopes the consumer granted. The access token goes in the X-Swippee-Access-Token header, never the URL.
- [Create a consent](https://docs.swippee.com/api-reference/consents/create-a-consent.md): Let the statement owner share a parsed report with a third party via a scoped, expiring token — without handing over an API key.
- [List consents](https://docs.swippee.com/api-reference/consents/list-consents.md)
- [Redeem a consent](https://docs.swippee.com/api-reference/consents/redeem-a-consent.md): Grantee reads the shared data with the opaque token only — no API key required.
- [Revoke a consent](https://docs.swippee.com/api-reference/consents/revoke-a-consent.md)
- [Banking indicator series](https://docs.swippee.com/api-reference/data-—-nrb/banking-indicator-series.md): One indicator over time.
- [Banking indicators](https://docs.swippee.com/api-reference/data-—-nrb/banking-indicators.md): Flat indicator list for a month, filterable by BFI class.
- [Banking snapshot](https://docs.swippee.com/api-reference/data-—-nrb/banking-snapshot.md): All C4 indicators for a month.
- [Convert currency](https://docs.swippee.com/api-reference/data-—-nrb/convert-currency.md): Convert an amount using the latest reference rate.
- [Forex series](https://docs.swippee.com/api-reference/data-—-nrb/forex-series.md): Daily series for one currency.
- [Interest-rate series](https://docs.swippee.com/api-reference/data-—-nrb/interest-rate-series.md): One rate over time (base-rate, spread-rate, wavg-deposit, wavg-credit…).
- [Latest forex rates](https://docs.swippee.com/api-reference/data-—-nrb/latest-forex-rates.md): Latest buy/sell reference rates for all currencies. Counts against your Data API quota.
- [Latest interest rates](https://docs.swippee.com/api-reference/data-—-nrb/latest-interest-rates.md): All commercial-bank interest rates for the latest month.
- [Latest macro indicators](https://docs.swippee.com/api-reference/data-—-nrb/latest-macro-indicators.md): Latest report's indicators, each with a source quote.
- [Latest payment indicators](https://docs.swippee.com/api-reference/data-—-nrb/latest-payment-indicators.md): All channels (volume + value) for the latest month.
- [Licensed BFI directory](https://docs.swippee.com/api-reference/data-—-nrb/licensed-bfi-directory.md): Licensed banks and financial institutions, filterable by class.
- [Macro series](https://docs.swippee.com/api-reference/data-—-nrb/macro-series.md): One indicator over time (inflation, remittance, reserves, bop…).
- [Payments series](https://docs.swippee.com/api-reference/data-—-nrb/payments-series.md): One channel/metric over time.
- [Enrich transactions](https://docs.swippee.com/api-reference/enrichment/enrich-transactions.md): Send raw transactions; get merchant, MCC, and spend category tags back. A transform endpoint — no report required.
- [Look up a terminal](https://docs.swippee.com/api-reference/merchants/look-up-a-terminal.md): Resolve a single Fonepay terminal PAN to its merchant.
- [Resolve merchants](https://docs.swippee.com/api-reference/merchants/resolve-merchants.md): Turn raw Fonepay terminal PANs and merchant-name strings into clean merchant data — name, MCC, spend category, and city. FULL scope; bills 1 unit per call (batch up to 1000 lookups).
- [Parse a bank statement](https://docs.swippee.com/api-reference/parsing/parse-a-bank-statement.md): Upload a Nepali bank statement (PDF, JPEG, or PNG, max 20 MB). Returns a full `StatementReport` with statement metadata, signals, monthly summary, categories, and every categorized transaction. Bills 1 unit.
- [Asset Report](https://docs.swippee.com/api-reference/products/asset-report.md): The full underwriting view — statement, signals, monthly summary, categories, and every transaction.
- [Balance](https://docs.swippee.com/api-reference/products/balance.md): Opening/closing balances, average and minimum balance, and the balance trend.
- [Identity](https://docs.swippee.com/api-reference/products/identity.md): Account holder, account number, bank, currency, and statement period — to confirm the uploader owns the account.
- [Income](https://docs.swippee.com/api-reference/products/income.md): Salary detection (amount, regularity, day-of-month), monthly credits, stability score, and the income transactions.
- [Liabilities](https://docs.swippee.com/api-reference/products/liabilities.md): EMI/loan obligations bucketed by detected lender, monthly EMI total, EMI load %, and bounce count.
- [Score](https://docs.swippee.com/api-reference/products/score.md): A single 0–1000 creditworthiness score derived from the statement signals.
- [Underwriting](https://docs.swippee.com/api-reference/products/underwriting.md): Full lender decision: FOIR, disposable income, max supportable EMI, risk flags, and an approve/review/decline verdict. Bills 1 unit per call.
- [Verify](https://docs.swippee.com/api-reference/products/verify.md): Forgery/tamper detection — a verdict (authentic | review | suspicious), confidence, and every check with pass/fail + severity.
- [Get a report](https://docs.swippee.com/api-reference/reports/get-a-report.md): Fetch a single completed report by its ID.
- [List reports](https://docs.swippee.com/api-reference/reports/list-reports.md): List your organization's recent reports.
- [List transactions](https://docs.swippee.com/api-reference/reports/list-transactions.md): The categorized transaction list for a report, with query filters. Filters combine with AND.
- [Authentication](https://docs.swippee.com/authentication.md): How Swippee API keys, scopes, and bearer authentication work.
- [Errors](https://docs.swippee.com/concepts/errors.md): Swippee's error envelope and the full error-code taxonomy.
- [Products](https://docs.swippee.com/concepts/products.md): The focused views you can derive from a parsed report — Income, Identity, Balance, Liabilities, Score, Verify, Underwriting.
- [Reports & transactions](https://docs.swippee.com/concepts/reports.md): The StatementReport object, the transaction shape, and how to filter transactions.
- [Webhooks](https://docs.swippee.com/concepts/webhooks.md): Receive parse results on your backend, with signed, retried delivery.
- [Connect — embed the consumer Vault](https://docs.swippee.com/guides/connect.md): A hosted consent flow where the consumer approves which scopes you receive — your app never sees their statement or login.
- [Consents — share a report safely](https://docs.swippee.com/guides/consents.md): Let a statement owner share a parsed report with a third party via a scoped, expiring token — without handing over an API key.
- [Swippee Data API](https://docs.swippee.com/guides/data-api.md): Read-only access to Nepal's public-sector financial data — forex, interest rates, payments, macro — sourced from Nepal Rastra Bank with attribution.
- [Merchant enrichment](https://docs.swippee.com/guides/merchant-enrichment.md): Resolve Fonepay terminal PANs and merchant-name strings to a clean name, MCC, spend category, and city.
- [SDKs & client libraries](https://docs.swippee.com/guides/sdks.md): Official Swippee packages — the TypeScript API client (@swippee/sdk) and the React Connect component (@swippee/connect-react).
- [Introduction](https://docs.swippee.com/introduction.md): Swippee turns Nepali bank statement PDFs into structured, machine-readable financial data — and serves Nepal's public-sector financial datasets — over one REST API.
- [Quickstart](https://docs.swippee.com/quickstart.md): Parse your first Nepali bank statement and read a product view in a few minutes.

## OpenAPI Specs

- [openapi](https://docs.swippee.com/openapi.json)