API Reference
API Reference
The complete LendEasy v1 public contract: 242 operations across 186 resource paths, generated from one downloadable OpenAPI 3.1 specification. The Servicing Plane is independently adoptable; the Lending Core is optional when you bring your own system of record.
Design against the contract. Every operation includes its permission, idempotency behavior, request schema, complete example, success response, and problem responses. Download OpenAPI or import the Postman collection.
Servicing Plane API
Cases, queues, interactions, compliance decisions, AI sessions, action requests, evidence, privacy, and the currently available bring-your-own-core contract.
Cases →
Durable borrower and merchant matters, workflow state, timelines, escalation, and closure. · 9 operations
Tasks →
Queue work, reservation, assignment, execution, and completion. · 8 operations
Interactions →
Inbound and outbound communications across voice, email, SMS, secure message, and mail. · 5 operations
Compliance decisions →
Execution-time, explainable policy decisions grounded in fresh facts. · 3 operations
Promises →
Borrower payment commitments, approval, revision, suppression, and evaluation. · 6 operations
Action requests →
Case-linked, typed requests to change an authoritative system of record. · 8 operations
Case documents →
Register, classify, review, and securely retrieve case evidence. · 5 operations
Verification →
Identity and authority verification sessions with attempt controls. · 4 operations
AI sessions →
Governed AI work sessions, proposed output, review, and termination. · 5 operations
Privacy requests →
Access, deletion, correction, and portability workflows. · 4 operations
Webhooks →
Tenant-owned event subscriptions, signing-secret rotation, tests, and delivery history. · 8 operations
Core bindings →
Bring-your-own-core capabilities, facts, actions, identity mappings, and reconciliation. · 8 operations
Lending Core (LMS) API
The optional system-of-record surface 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