BanklyzeBanklyze/Developer Docs
Sign In

Quickstart

Get from zero to an underwriting recommendation in 5 minutes. This guide walks you through creating a deal, uploading a bank statement, and retrieving the AI-powered analysis results.

You'll need a Banklyze API key. Create one in Settings → API Keys or see the Authentication guide.
1

Install the SDK

Choose your language. The Python SDK provides the best experience, but you can use curl or any HTTP client.

# No installation needed — use curl directly
curl --version
2

Authenticate

Set your API key. We recommend using environment variables rather than hardcoding keys in source code.

# Set your API key as an environment variable
export BANKLYZE_API_KEY="bk_your_api_key_here"

# Test authentication
curl -X GET https://api.banklyze.com/v1/deals \
  -H "X-API-Key: $BANKLYZE_API_KEY"
3

Create a deal

A deal represents a single underwriting application. Provide the business name and requested funding amount.

curl -X POST https://api.banklyze.com/v1/deals \
  -H "X-API-Key: $BANKLYZE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "business_name": "Acme Trucking LLC",
    "funding_amount_requested": 50000,
    "ein": "123456789",
    "entity_type": "llc"
  }'

# Response: { "id": 42, "status": "new", ... }
4

Upload a document

Upload a PDF bank statement. Processing starts automatically — OCR, transaction extraction, metrics computation, and screening all happen in the background.

curl -X POST https://api.banklyze.com/v1/deals/42/documents \
  -H "X-API-Key: $BANKLYZE_API_KEY" \
  -F "file=@bank_statement_jan_2026.pdf"

# Response: { "id": 15, "status": "uploaded", ... }
# Processing starts automatically in the background
Use the SSE Events endpoint for real-time progress updates instead of polling.
5

Check results

Once processing completes, retrieve the full underwriting report with health score, financials, screening results, and recommendation.

# Poll until processing completes
curl -X GET https://api.banklyze.com/v1/documents/15/status \
  -H "X-API-Key: $BANKLYZE_API_KEY"
# { "status": "completed" }

# Get the full underwriting report
curl -X GET https://api.banklyze.com/v1/deals/42 \
  -H "X-API-Key: $BANKLYZE_API_KEY"

# Get the recommendation
curl -X GET https://api.banklyze.com/v1/deals/42/recommendation \
  -H "X-API-Key: $BANKLYZE_API_KEY"

Next Steps