The Bunch Partner API
Build powerful household bill quote applications with our comprehensive API. Create quotes, manage customers, and integrate seamlessly with The Bunch platform.
curl -X POST "https://development-backend.the-bunch.co.uk/partner-api/Auth/token" \
-H "Content-Type: application/json" \
-d '{
"clientId": "your-client-id",
"clientSecret": "your-client-secret"
}'Quick Start
Authentication
Get your Auth0 credentials and obtain an access token using the Client Credentials Flow.
POST /Auth/token
{
"clientId": "your-client-id",
"clientSecret": "your-client-secret"
}Lookup Addresses
Find available properties by postcode to create quotes for your customers.
GET /Addresses/lookup?postcode=SW1P 2DX
Authorization: Bearer {access_token}Create Quote
Create a new quote with selected packages and customer information.
POST /Quotes
{
"addressUid": "4b61cc99-63a7-4639-aa4b-bc06988d4388",
"packages": ["electricity", "gas"]
}Key Features
Address Lookup
Find available properties by UK postcode with detailed address information and UPRN data.
Quote Management
Create, update, and manage household bill quotes with flexible package options and pricing.
Customer Management
Handle customer information, PSR (Priority Services Register) details, and payment setup with comprehensive validation.
Broadband Integration
Check broadband availability and add broadband products to household bill quotes seamlessly.