BanklyzeBanklyze/Developer Docs
Sign In
REST APIv1OpenAPI 3.1

Banklyze API

AI-powered bank statement analysis and MCA underwriting. Upload PDFs, extract transactions automatically, and receive structured underwriting recommendations — all through a simple REST API.

Base URL

All API requests are made to the following base URL:

https://api.banklyze.com/v1

The API is versioned via the URL path. The current version is v1. When breaking changes are introduced, a new version will be published and the previous version will remain available for a deprecation period.

Response Format

All responses are returned as JSON. Single-resource responses include the requested data directly:

Response — 200 OK
{
  "report_date": "2026-02-15",
  "business": {
    "id": 42,
    "business_name": "Acme Corp",
    "status": "ready"
  },
  "funding_amount_requested": 50000.00,
  "health": { "score": 72.5, "grade": "B" },
  "recommendation": {
    "decision": "approve",
    "total_score": 86.7,
    "max_advance": 37629.00
  }
}

List endpoints return paginated results with metadata:

Paginated Response
{
  "data": [ ... ],
  "meta": {
    "page": 1,
    "per_page": 25,
    "total": 142,
    "total_pages": 6
  }
}

Error Handling

The API uses standard HTTP status codes. Errors return a JSON object with a detail field describing the problem:

Error Response
{
  "detail": "Deal not found",
  "status_code": 404
}
Rate limiting is enforced at 120 requests per minute per API key. See the Error Handling guide for details on status codes, error codes, and retry strategies.

Next Steps

  • Quickstart — Create your first deal and get a recommendation in 5 minutes.
  • Authentication — Learn about API key management, OAuth2, and rate limits.
  • API Reference — Full endpoint documentation for every resource.
  • Webhooks — Set up real-time notifications for deal and document events.
  • SDKs & Libraries — Official client libraries for Python and TypeScript.