API overview

The Pathway API can manage the full underwriting workspace. Create Books, upload documents, run parses, read and edit extracted data, calculate analytics, apply screening rules, match funders, generate exports, and connect deal data to the rest of your system. Pathway’s web app uses this API. The built-in chat agent also uses it to work across Books, documents, analytics, funders, screening settings, intake email, and organization data. The web app authenticates with a signed-in user session. Your application or agent authenticates with a Personal Access Token and receives the same organization-scoped access allowed by that user and token.

Copy into your AI agent

Read the Pathway API documentation:
https://docs.lendpathway.com/api-reference/introduction.md

Use the live OpenAPI schema for exact API details:
https://api.lendpathway.com/openapi.json

What the API covers

Surface	What you can do
Books and documents	Create and manage deals, upload files, inspect source documents, and track where each deal came from
Parsing and extracted data	Start or stop a parse, follow its status, read bank statements, credit reports, tax forms, applications, IDs, and checks
Underwriting	Work with transactions, account history, debt positions, cash-flow analytics, screening results, and exports
Workspace	Read and manage funders, matching rules, inbox data, organization settings, CRM records, and connected product integrations

The live OpenAPI explorer contains every route and generated request schema. This guide explains the main objects and gives you complete working paths through the product.

Base URL

All API requests begin with:

https://api.lendpathway.com/api

Keep the final /api. Endpoint paths in this reference begin with /, so the authentication check resolves to:

https://api.lendpathway.com/api/auth/me

Create an API key

Create a Personal Access Token in Settings → Account → API Access Tokens. Tokens begin with pat_ and are shown once. Use a read-write token for uploads, parsing, edits, and other mutations. A read-only token can safely power an agent, reporting job, or data warehouse sync.

The UI calls this an API Access Token. The credential is a Personal Access Token, or PAT. It is the API key used in every example here.

Make your first request

Call GET /auth/me before doing any work. It returns the user and organization attached to the token, confirming the host, final /api, authorization header, and organization scope in one request.

import requests

API_BASE = "https://api.lendpathway.com/api"
TOKEN = "pat_your_token_here"

response = requests.get(
    f"{API_BASE}/auth/me",
    headers={"Authorization": f"Bearer {TOKEN}"},
    timeout=30,
)
response.raise_for_status()

print(response.json())

const API_BASE = "https://api.lendpathway.com/api";
const TOKEN = "pat_your_token_here";

const response = await fetch(`${API_BASE}/auth/me`, {
  headers: {
    Authorization: `Bearer ${TOKEN}`,
  },
});

if (!response.ok) {
  throw new Error(`${response.status}: ${await response.text()}`);
}

console.log(await response.json());

curl --fail-with-body \
  "https://api.lendpathway.com/api/auth/me" \
  -H "Authorization: Bearer pat_your_token_here"

Response

{
  "org_id": "c4f9dda9-7875-4115-961f-0ac4b9630526",
  "org_name": "Acme Funding",
  "user_id": "fa576914-9590-40af-bbb8-c3af6f500859",
  "user_name": "John Doe"
}

Get one deal through the API

POST /submit-book is the shortest path from files to a parsed Book. It creates the Book, uploads every file in the multipart request, and starts parsing. This Python example waits for completion and reads the simple account-first bank statement result.

import time
from pathlib import Path

import requests

API_BASE = "https://api.lendpathway.com/api"
TOKEN = "pat_your_token_here"
HEADERS = {"Authorization": f"Bearer {TOKEN}"}

paths = [Path("january.pdf"), Path("february.pdf")]
handles = [path.open("rb") for path in paths]

try:
    response = requests.post(
        f"{API_BASE}/submit-book",
        headers=HEADERS,
        data={"book_name": "Acme Coffee"},
        files=[("files", (path.name, handle, "application/pdf")) for path, handle in zip(paths, handles)],
        timeout=120,
    )
    response.raise_for_status()
    book_id = response.json()["book_id"]
finally:
    for handle in handles:
        handle.close()

while True:
    response = requests.get(
        f"{API_BASE}/books/{book_id}",
        headers=HEADERS,
        timeout=30,
    )
    response.raise_for_status()
    book = response.json()

    if book["parse_status"] in {"completed", "failed", "cancelled"}:
        break
    time.sleep(3)

if book["parse_status"] != "completed":
    raise RuntimeError(book.get("parse_status_message") or "Parse did not complete")

response = requests.get(
    f"{API_BASE}/books/{book_id}/statements",
    headers=HEADERS,
    timeout=60,
)
response.raise_for_status()

for account in response.json():
    print(account["bank_name"], account["account_number"])
    for statement in account["statements"]:
        print(statement["statement_end_date"], statement["ending_balance"])

Use Documents and parsing when your application needs to control Book creation, file uploads, and parsing separately. The complete parse and retrieve cookbook includes Python and webhook flows.

Understand the result

There are four useful views of a parsed bank-statement Book. They serve different jobs.

Request or field	Shape	Best use
`GET /books/{book_id}`	Complete Book, including `book_meta`	Status, provenance, user edits, and every raw parser result
Canonical MCA result inside `book_meta`	Raw business, owners, accounts, statements, transactions, and stored positions	Exact extracted data and transaction-level work
`GET /books/{book_id}/analytics`	Full computed `BookAnalytics`	Underwriting metrics, enriched positions, cash-flow patterns, and screening
`GET /books/{book_id}/statements`	Compact account-first statement history	A simple account and balance view with very little transformation code

The Books reference defines the complete Book and canonical raw MCA models. The Analytics reference defines the full computed response, including its nested transaction, position, and screening models.

Main references

Submit a Book

Upload a complete deal package and start parsing in one request.

Documents and parsing

Create a Book, upload documents, and control parsing as separate calls.

Books

Read status, provenance, raw parser output, and the canonical bank result.

Analytics

Read computed bank metrics, transactions, debt positions, and screening results.

Exports

Download CSV, choose an Excel template, or fetch an embeddable spreadsheet URL.

Embed

Render one read-only Book inside your application.

Request conventions

Send the PAT in Authorization: Bearer <token>.
Send JSON for normal request bodies and multipart form data for file uploads.
Dates are ISO strings. Parser dates use YYYY-MM-DD. Timestamps include a timezone.
Currency values are JSON numbers in dollars.
JSON endpoints return the response body directly, without an outer data envelope.
Error responses use {"detail": "..."}. Validation failures return a structured list in detail.

PAT traffic is limited to 30 requests per minute per token. A rate-limited request returns 429. Parsing runs asynchronously, so submission and parse-start requests return before the work is complete.

Overview

Endpoints

Cookbook

What the API covers

Base URL

Create an API key

Make your first request

Get one deal through the API

Understand the result

Main references

Submit a Book

Documents and parsing

Books

Analytics

Exports

Embed

Request conventions

​What the API covers

​Base URL

​Create an API key

​Make your first request

​Get one deal through the API

​Understand the result

​Main references

Submit a Book

Documents and parsing

Books

Analytics

Exports

Embed

​Request conventions

What the API covers

Base URL

Create an API key

Make your first request

Get one deal through the API

Understand the result

Main references

Request conventions