Contracted Supplier API

Poll-based V1 API for authorised contracted suppliers to submit UK business-finance enquiries.

The Contracted Supplier API lets an approved supplier create a Supplier Submission and poll its commercial status.

A Supplier Submission is not a Lead, an Application, or a Case. It has two authorised levels:

• basic — accepted into human qualification only. No Case Reference and no Application until an explicit promotion.
• application — after commercial acceptance, Tera creates at most one Application.

V1 is poll-only. There are no supplier webhooks in this version.

Environments

Sandbox is live. Use https://sandbox-api.terabusinessfinance.com with a test credential.

Production is not yet live. The intended production hostname is https://api.terabusinessfinance.com. DNS or the domain may already be configured, but there is no READY production API deployment and Supplier API production traffic is disabled. Do not send live traffic there yet.

	Sandbox	Production
Status	Live	Not yet live
Host	https://sandbox-api.terabusinessfinance.com	https://api.terabusinessfinance.com (intended)
Credentials	Test keys only (tcs_test_)	Live keys only (tcs_live_) — not accepted until production is enabled
Billing	Always not_billable	Follows the supplier agreement
Data	Synthetic only	Live supplier traffic

Test keys cannot call production. Live keys cannot call sandbox.

Public operations

Method	Path	Purpose
POST	/v1/supplier-submissions	Create a submission
GET	/v1/supplier-submissions/{submission_id}	Poll by Tera id
GET	/v1/supplier-submissions?external_reference=	Poll by your reference
POST	/v1/supplier-submissions/{submission_id}/contact-corrections	Correct working contact fields
POST	/v1/supplier-submissions/{submission_id}/promotion	Promote an accepted basic submission

The machine-readable contract is generated from the runtime Zod schemas. See the OpenAPI file served with this project.

Next steps

1. Sandbox quick start
2. Authentication
3. Basic or application-level create