Terminology
The words this reference uses for the same thing everywhere: deal, ref, lane, band, basis.
One vocabulary runs through the payloads, the emails and the Hub. Learn these once and every endpoint reads the same way.
| Term | What it means |
|---|---|
| Applicant | The business asking for funding. Called the client in the messaging endpoints and the borrower once a deal completes. |
| Deal | One funding request routed to one lender lane, addressed by its ref. The same applicant can produce several deals across the panel. |
| Ref | The deal reference, for example CV93A41205. It is the id in every path, and the same string that appears in referral email subjects. |
| Lane | Your queue. Routing decides which deals enter it, from your buy box and from the outcomes you report. |
| Buy box | The markets, products, amount range, minimum revenue and months trading, and excluded sectors you fund. Routing matches against it. |
| Market block | Retired. A deal used to carry one of uk, us, ca or other; it now carries a single market object with the same keys in every country. market_block and market_region remain as deprecated aliases. |
| Band | A range the applicant selected, sent as the range they selected. A band is never converted into a point figure without its basis. |
| Basis | How a number next to a band was produced: band_midpoint when it is the midpoint of the selected band, reported when the applicant gave the figure directly. |
| Indicative offer | Terms posted before full assessment. They render immediately in the applicant comparison. |
| Firm offer | Terms you will honour. Firm offers outrank indicative ones in the comparison. |
| Handover | The link an applicant follows from the marketplace into your own completion journey. |
| White-label completion | Completion run inside the marketplace under the Capvant surface, with your agreement and your disbursement account. |
| Document request | A typed request for a named item on a deal, tracked through requested, uploaded and forwarded. |
| Statements | Bank statements on file for a deal, with the parsed figures where a parse recorded them. |
| Registry | The public company register for a market. Where one is connected, registry facts arrive on market.registry with the time they were read; elsewhere that field is null. |
| Sandbox | Test deals for your account, created with the test endpoints. Same keys, same endpoints, no applicant contact. |
| Webhook | An HTTP callback to your endpoint when a deal event fires. Every delivery is signed. |
| Referral | A funding request submitted through the Partner API by a referral partner, rather than routed to a lender lane. |