REST APIWebhooksSDKsReal-time SSE

Banklyze API Documentation

API-first statement intelligence for private capital. Programmatic underwriting at scale.

Base URL

All API requests are made to the following base URL. Every endpoint described in this documentation is relative to this root.

https://api.banklyze.com/v1

During development you can point to your local instance at http://localhost:8000/v1.

Response Format

All responses are JSON. Single-resource endpoints return a top-level data object. List endpoints return data (array) plus a meta object with pagination info.

Single resource

200 OK
{
  "data": {
    "id": 42,
    "business_name": "Acme Trucking LLC",
    "status": "under_review",
    "health_score": 72.5,
    "created_at": "2025-11-01T14:30:00Z"
  }
}

List response

200 OK
{
  "data": [
    { "id": 42, "business_name": "Acme Trucking LLC", "status": "under_review" },
    { "id": 43, "business_name": "Bolt Logistics Inc", "status": "ready" }
  ],
  "meta": {
    "page": 1,
    "per_page": 25,
    "total": 2,
    "total_pages": 1
  }
}

Error Handling

Errors follow a consistent envelope. The HTTP status code is mirrored inside the error object along with a machine-readable code and a human-friendly message.

404 Not Found
{
  "error": {
    "code": "DEAL_NOT_FOUND",
    "message": "Deal with id 999 not found",
    "status": 404
  }
}

Common HTTP status codes: 400 validation error, 401 unauthorized, 403 forbidden, 404 not found, 409 conflict, 429 rate limited, 500 internal error. See the Error Handling guide for the full error code reference.

Next Steps

  • Quickstart — create your first deal and upload a document in under 5 minutes
  • Authentication — learn how API keys, bearer tokens, and OAuth2 work
  • Deals API Reference — full CRUD reference for your core underwriting pipeline
  • Webhooks Guide — get notified in real-time when processing completes