API Reference
Two API families, one key model, one error envelope: the Lender API and the Partner API.
Two APIs share one authentication model, one error envelope, one rate limit and one webhook signing scheme. Which one you use depends on which side of the marketplace you sit on.
Lender API
Pull the deals routed to your lane, report outcomes, submit offers, message clients, collect documents.
Partner API
Submit referrals, prequalify a business before you send it, track what happened.
Before your first call
Authentication
One X-API-Key header, created and revoked by your own team.
Environments
Sandbox and production, and what differs between them.
Enum reference
Country codes, deal status, entity types, basis values.
Markets
Ten markets, and which fields carry a value in each.
How to read an operation page
Every page below is generated from the OpenAPI document, so it can never drift from the API. Each one gives you the path and method, the parameters with their types and constraints, the response schema, a request sample in the language you pick, and a playground that sends to the sandbox server with your own key.
Pages that return a deal open with the country switcher. Pick your market once and the examples and the populated-field notes follow you across the reference.