API Reference
API Reference
Every entry on this page is generated from one OpenAPI 3.1 specification rather than written by hand, so the reference cannot drift from the contract it documents. That is 481 operations across 405 resource paths, downloadable in full. Implemented servicing routes are identified separately, and roadmap contracts stay visible beside them so you can design against the destination.
Read the availability badge. Implemented means the method and path are present in the composed servicing route manifest. Future-facing preserves an existing product contract that is not on the current servicing runtime surface. Read the current servicing boundary, download the client, connector, or combined OpenAPI, or import Postman.
Servicing Workspace API
The current plane implements cases, tasks, interactions, content, governed operations, workforce, AI review, voice dispatch, evidence, and reporting. Roadmap APIs remain in the same reference.
Cases →
Durable borrower and merchant matters, workflow state, timelines, escalation, and closure. · 21 implemented · 1 roadmap
Tasks →
Queue work, reservation, assignment, execution, and completion. · 12 implemented
Interactions →
Inbound and outbound communications across voice, email, SMS, secure message, and mail. · 10 implemented
Compliance decisions →
Execution-time, explainable policy decisions grounded in fresh facts. · 0 implemented · 3 roadmap
Promises →
Borrower payment commitments, approval, revision, suppression, and evaluation. · 3 implemented · 3 roadmap
Action requests →
Case-linked, typed requests to change an authoritative system of record. · 8 implemented
Case documents →
Register, classify, review, and securely retrieve case evidence. · 14 implemented
Verification →
Identity and authority verification sessions with attempt controls. · 2 implemented · 2 roadmap
AI sessions →
Governed AI work sessions, proposed output, review, and termination. · 0 implemented · 4 roadmap
Webhooks →
Tenant-owned event subscriptions, signing-secret rotation, tests, and delivery history. · 0 implemented · 8 roadmap
Core bindings →
Additional bring-your-own-core deployment option: capabilities, facts, actions, identity mappings, and reconciliation. · 0 implemented · 8 roadmap
Workforce →
Composed human users, AI worker registrations, eligibility, and presence. · 11 implemented
Supercases →
Bounded portfolio-event containers and structurally linked customer subcases. · 7 implemented
Case notes →
Revisioned, link-aware, sensitive operational notes owned by the servicing plane. · 9 implemented
Servicing administration →
Case-type, reason, review-timer, allocation, queue-coverage, and field configuration owned by the servicing plane. · 21 implemented
Privacy requests →
Access, deletion, correction, and portability workflows. · 4 implemented
Governed operations →
Case-scoped operations that execute directly when allowed and create a request only when policy requires one. · 8 implemented
Connector callbacks →
Gateway-signed channel events and dispatch-bound voice callbacks. · 4 implemented
Case effects →
Workflow-created typed effects, status reads, and terminal-failure recovery. · 3 implemented
AI governance →
Reviewable AI outputs and scope-specific suppression controls. · 3 implemented
Voice →
Outbound AI voice dispatch, execution-time dial authorization, dial grants, and the voice-provider console pass-through. · 15 implemented
Servicing reports →
Bounded workforce, collections, interaction, compliance, AI-quality, reconciliation, and promise-allocation projections, plus the curated investor reporting pack and the drift workspace. · 11 implemented
Evidence exports →
Audited case and customer evidence bundles reconstructed from retained causal records. · 2 implemented
Workflow administration →
Workflow-definition drafting, validation, vocabulary, import/export, and versioned activation under a separate promotion authority. · 13 implemented
Portal contracts →
The servicing side of borrower self-service: agreements, documents, invitations, interactions, message tasks, signals, and upload sessions. · 23 implemented
Case copilot →
The case copilot: panel context, threads, turns, feedback, proposal confirmation, and its admin surface. · 12 implemented
Email threads →
Email conversation threads with bounded previews, audited body reads, and governed threaded replies. · 5 implemented
Scheduled callbacks →
Borrower-promised callback windows held as first-class tasks with window-scoped consent and at-dial compliance. · 8 implemented
Hardship →
Versioned hardship policies and guardrails, case hardship state and offers, and evidence-analysis review. · 20 implemented
Credit reporting →
The furnisher profile, enrolled accounts, reviewable furnishing cycles, the generated file, and the dispute and correction path. · 19 implemented
External signals →
The connection registry, monitoring runs and coverage, and the protection findings a specialist adjudicates. · 9 implemented
Accounting export →
Consolidated journal batches, account mapping, and the accounting connection. · 6 implemented
Lending Core API
The LendEasy Lending Core — the platform's native system of record for consumer installment loans, BNPL, and receivables-based merchant advances — from product and charge configuration through origination, money movement, and governed servicing commands.
Customers →
Customer aggregates with a closed INDIVIDUAL or CORPORATE profile, masked ordinary reads, audited sensitive reads, and an append-only history ledger. · 8 operations
Addresses →
Typed customer addresses with focused mutations and history. · 4 operations
Contact points →
Email and phone contact points with explicit texting permission and trusted-integration verification. · 3 operations
Customer identifiers →
Government identifiers stored normalized, masked on ordinary reads, revealed only through audited sensitive routes. · 3 operations
Consents →
The closed consent catalog: grants with capture evidence and immutable revocation. · 2 operations
Payment instruments →
Processor-tokenized bank and card instruments with masked reads and provider-event verification. · 12 operations
Loan parties →
Co-borrower, guarantor, and authorized-party relationships with explicit authority scopes. · 6 operations
External parties →
Merchants and other verified counterparties eligible to receive funding. · 4 operations
Search →
Permission-aware exact and prefix search across customers and loans. · 1 operations
Restrictions →
Customer- and loan-scoped holds enforced at execution time. · 3 operations
Servicing actions →
Governed loan commands under case governance and maker-checker, reschedules, interest pauses, and the governance ledger. · 16 operations
Payments →
Loan payment intents from creation through rail submission, posting, and provider-driven returns. · 5 operations
Autopay →
Single current enrollment per loan, Regulation E authorization, and per-rail failure policies. · 7 operations
Funding →
Approval-gated disbursements and outbound refunds to verified recipients. · 7 operations
Reconciliation →
Exceptions between provider events, money intents, and the ledger, with CSV export. · 4 operations
Documents →
Customer and loan documents with virus scanning, checksum-verified downloads, links, and history. · 10 operations
Notes →
Customer and loan notes with immutable revisions, links, and permanent redaction. · 11 operations
Forms →
Administered form definitions and typed customer and loan form entries with derived per-form permissions. · 16 operations
Statements →
Job-generated due-date statements with governed regeneration and PDF download. · 3 operations
Charges →
Charge definitions with immutable Regulation Z classification, and governed loan-charge commands. · 12 operations
Loan products →
Progressive loan products carrying LendEasy APR, statement, and overpayment configuration. · 5 operations
Loans →
Loan applications, lifecycle commands, embedded schedules, and the servicing summary read model with payoff and APR. · 6 operations
Accounting →
Balanced journal entries and the chart of accounts. · 4 operations
Reporting →
The operational report-definition catalog. · 2 operations
Merchant advances →
Receivables purchases, sales reports, remittances, projections, and breach monitoring. · 15 operations