Share Links

Share links let you grant read-only access to a deal report without requiring the recipient to have a Banklyze account or API key. Each link generates a unique, opaque token that can be sent to applicants, brokers, or internal reviewers who only need to view the report — not manage deals.

Share links expose a curated subset of the deal report: financial summary, health score, AI narrative, and underwriting decision. Raw transaction data, screening flag details, and internal notes are not included in shared views. Links can be set to expire at a specific date and time, or left non-expiring.

Generate a new share link for a deal. The response includes the full shareable url and the raw token. Multiple share links can be created for the same deal — for example, one for the applicant and one for the broker.

Path Parameters

Name	Type	Required	Description
deal_id	integer	Required	The unique deal ID

Request Body

Name	Type	Required	Description
label	string	Optional	A human-readable label to identify this share link (max 255 characters). For example: Shared with applicant or Broker review.
expires_at	string (ISO 8601)	Optional	Optional expiration date-time in UTC. After this time the link returns 404 to viewers. Omit for a non-expiring link.

Example

curl

curl -X POST https://api.banklyze.com/v1/deals/42/share \
  -H "X-API-Key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "label": "Shared with applicant",
    "expires_at": "2026-04-04T00:00:00Z"
  }'

Response

Response — 201 Created

{
  "id": 5,
  "deal_id": 42,
  "token": "shr_d4f2a1e8c3b09f7e",
  "url": "https://app.banklyze.com/share/shr_d4f2a1e8c3b09f7e",
  "label": "Shared with applicant",
  "expires_at": "2026-04-04T00:00:00Z",
  "view_count": 0,
  "created_at": "2026-03-04T11:00:00Z"
}

Retrieve all share links created for a deal, including expired ones. The view_count tracks how many times the shared URL has been loaded by a viewer.

Path Parameters

Name	Type	Required	Description
deal_id	integer	Required	The unique deal ID

Query Parameters

Name	Type	Required	Description
page	integer	Default: 1	Page number
per_page	integer	Default: 25	Results per page (max 100)

Example

curl

curl -X GET https://api.banklyze.com/v1/deals/42/shares \
  -H "X-API-Key: your_api_key_here"

Response

Response — 200 OK

{
  "data": [
    {
      "id": 5,
      "deal_id": 42,
      "token": "shr_d4f2a1e8c3b09f7e",
      "url": "https://app.banklyze.com/share/shr_d4f2a1e8c3b09f7e",
      "label": "Shared with applicant",
      "expires_at": "2026-04-04T00:00:00Z",
      "view_count": 3,
      "created_at": "2026-03-04T11:00:00Z"
    },
    {
      "id": 3,
      "deal_id": 42,
      "token": "shr_b7c1e5a2f4d08e3a",
      "url": "https://app.banklyze.com/share/shr_b7c1e5a2f4d08e3a",
      "label": "Broker review",
      "expires_at": null,
      "view_count": 12,
      "created_at": "2026-02-20T09:30:00Z"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 25,
    "total": 2,
    "total_pages": 1
  }
}

Retrieve the shared deal report for a given token. This endpoint requires no authentication — it is designed to be called directly from a browser or embedded viewer. Expired tokens return a 404 Not Found response. Each successful request increments the view_count for the share link.

This endpoint is rate-limited per token to 60 requests per minute to prevent abuse.

Path Parameters

Name	Type	Required	Description
token	string	Required	The opaque share token returned from POST /deals/{deal_id}/share

Example

curl

curl -X GET https://api.banklyze.com/v1/share/shr_d4f2a1e8c3b09f7e

Response

Response — 200 OK

{
  "token": "shr_d4f2a1e8c3b09f7e",
  "deal": {
    "id": 42,
    "business_name": "Acme Trucking LLC",
    "dba_name": "Acme Freight",
    "industry": "Transportation",
    "entity_type": "llc",
    "health_score": 72.5,
    "paper_grade": "B",
    "decision": "approve",
    "avg_monthly_deposits": 125430.00,
    "avg_daily_balance": 34500.00,
    "ending_balance": 41200.00,
    "total_deposits": 376290.00,
    "months_covered": 3,
    "nsf_count": 2,
    "ai_summary": "Acme Trucking shows consistent deposit volumes averaging $125K/month over the review period. Revenue trend is stable with moderate seasonality. NSF count is within acceptable thresholds at 2 incidents. Overall profile supports a conditional approval at a reduced advance amount.",
    "funding_amount_requested": 50000.00,
    "max_advance": 37629.00,
    "report_date": "2026-02-15"
  },
  "expires_at": "2026-04-04T00:00:00Z",
  "shared_at": "2026-03-04T11:00:00Z"
}