API Reference
Complete REST API reference for Banklyze. Every endpoint is documented with request/response schemas, authentication requirements, and example code in cURL, Python, and TypeScript.
All endpoints require authentication and use the base URL https://api.banklyze.com/v1. See the Authentication guide for details on API keys, bearer tokens, and OAuth2.
Endpoints
The API is organized into 13 modules. Click any module to view its full endpoint reference.
Deals (14 endpoints)
Create, update, and manage funding deals. Includes notes, decisions, summary regeneration, and status transitions.
Documents (11 endpoints)
Upload bank statements, tax returns, and P&L docs. Manage processing, reprocess failed documents, and retrieve analysis results.
Transactions (4 endpoints)
List, filter, and flag extracted transactions. Search by amount, date, description, or risk category.
Exports (4 endpoints)
Generate branded PDF reports, CSV transaction exports, and structured JSON snapshots for downstream systems.
Rulesets (6 endpoints)
Configure underwriting rulesets with custom thresholds, score weights, and approval criteria per organization.
Bulk Ingest (2 endpoints)
Submit batches of deals and documents from CRM systems or loan origination platforms in a single request.
Webhooks Config (6 endpoints)
Register, update, and test webhook endpoints. Manage event subscriptions and inspect delivery logs.
CRM (8 endpoints)
Link deals to external CRM records. Sync contacts, pipeline stages, and deal metadata with Salesforce, HubSpot, and more.
API Keys (3 endpoints)
Create, list, and revoke API keys. Manage scopes and rotate credentials programmatically.
Events (3 SSE endpoints)
Subscribe to real-time Server-Sent Events for deal updates, document processing, and system notifications.
Usage (2 endpoints)
Query API usage metrics, rate limit status, and document processing quotas for your organization.
Collaboration (14 endpoints)
Manage deal assignments, comments, activity logs, and notifications across your underwriting team.
Share Links (4 endpoints)
Create time-limited share links for deal summaries and reports. Control access with passwords and expiration dates.
Common Patterns
These guides cover cross-cutting concerns that apply to all endpoints:
- Authentication — API keys, bearer tokens, OAuth2, and SSE
- Pagination — cursor-based and offset pagination for list endpoints
- Error Handling — error codes, retry strategies, and idempotency
- Idempotency — safely retry failed requests with idempotency keys