{"info":{"_postman_id":"9bc471bf-1f8f-4539-bef0-60cf85bda2ee","name":"Vertical Referral API","description":"<html><head></head><body><p>This documentation will describe the various endpoints available to interact with your partnership agreement via the Vertical Connect API.</p>\n</body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"51504193","collectionId":"9bc471bf-1f8f-4539-bef0-60cf85bda2ee","publishedId":"2sBYHXQdby","public":true,"customColor":{"top-bar":"1c1c3b","right-sidebar":"1c1c3b","highlight":"6b38e5"},"publishDate":"2026-11-02T16:02:14.000Z"},"item":[{"name":"Auth","item":[],"id":"0927db05-e79c-4726-b96b-ca1326e75243","description":"<p>The Vertical Referral API is a RESTful API which requires an API key and an API secret, issued by Vertical, to access.</p>\n<h2 id=\"get-requests\">GET requests</h2>\n<p>GET requests contain no body payload and so only require the API key to be passed in the API-KEY header</p>\n<h2 id=\"post-put-and-patch-requests\">POST, PUT and PATCH requests</h2>\n<p>Requests which send a payload in the body require, in addition to the API key passed in the headers, an HMAC hash of the body payload to be sent in another header, API-HASH, using the issued API secret.</p>\n<p>Example in PHP, where <code>$payload</code> is your JSON body:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-php\">    $hash = hash_hmac(\"sha512\", $payload, $secret);\n    curl_setopt($ch, CURLOPT_HTTPHEADER, array(\n        \"API-KEY: {$key}\",\n        \"API-HASH: {$hash}\"\n    ));\n\n</code></pre>\n<h2 id=\"variables\">Variables</h2>\n<p>To use this postman collections the below environmental variables should be set:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Name</strong></th>\n<th><strong>Type</strong></th>\n<th><strong>Test Value</strong></th>\n<th><strong>Live Value</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>base_url</td>\n<td>default</td>\n<td><a href=\"https://api.test.durham.cloud/wholesale\">https://api.test.durham.cloud/wholesale</a></td>\n<td><a href=\"https://api.durham.cloud/wholesale\">https://api.durham.cloud/wholesale</a></td>\n</tr>\n<tr>\n<td>API_key</td>\n<td>secret</td>\n<td>to be provided by Vertical</td>\n<td>to be provided by Vertical</td>\n</tr>\n<tr>\n<td>secret</td>\n<td>secret</td>\n<td>to be provided by Vertical</td>\n<td>to be provided by Vertical</td>\n</tr>\n</tbody>\n</table>\n</div><p>All values in single {} should be replaced with the appropriate value.</p>\n","_postman_id":"0927db05-e79c-4726-b96b-ca1326e75243"},{"name":"Quote","item":[{"name":"Get Quote UUID","id":"58e7fd51-2ff7-4b2c-882e-92377096d5ed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-KEY","value":"{{API-KEY}}","type":"text"}],"url":"{{base_url}}/quote/{quote_uuid}","description":"<p>Retrieve a quote that has been previously created.</p>\n<p><strong>Path Parameters:</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Name</strong></th>\n<th><strong>Type</strong></th>\n<th><strong>Desc</strong></th>\n<th><strong>Required</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>quote_uuid</td>\n<td>string</td>\n<td>The unique reference for the quote.</td>\n<td>Y</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["quote","{quote_uuid}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"1d2572f3-509c-48a1-a669-dd01fde8d9dc","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"API-KEY","value":"{{API-KEY}}","type":"text"}],"url":"{{base_url}}/quote/{quote_uuid}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 21 Aug 2025 09:38:33 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Cache-Control","value":"private, must-revalidate"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"-1"},{"key":"X-RateLimit-Limit","value":"1000"},{"key":"X-RateLimit-Remaining","value":"999"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":" {\n    \"uuid\":\t\"<string>\",\n    //The UUID to use for future requests related to this quote.\n\n    \"address\":\t\"<string>\",\n    //Address lines including Town and Postcode\n\n    \"capacity\":\t\"integer\",\n    //The number of people that will be living at the property.\n\n    \"start_date\": \"<string>\",\n    //The date the quote will be started from in YYYY-MM-DD format.\n\n    \"end_date\":\t\"<string>\",\n    //The end date for the quote.\n\n    \"unlimited\": \"boolean\",\n    //True if the quote is using the unlimited tariff. Otherwise, false.\n\n    \"contract_reference\": \"<string>\",\n    //The reference to the generated contract once the quote has been completed.\n\n    \"quote_link\": \"<string>\",\n    //The unique link for unidentified tenants to be able to signup to.\n\n    \"services\": {\n    //The services attached to the quote. Each service can be null if it has not been requested or is unavailable. There is the possibility of a new property being added if a new service is offered.\n\n        \"electricity\":  {\n        //Price structure for an energy service quote. Service will only be displayed if selected on request.\n\n            \"monthly_price\": \"<number>\",\n            \"tenant_week\": \"<number>\",\n            \"tenant_month\":\t\"<number>\",\n            \"unit_rate\": \"<number>\",\n            \"standing_charge\": \"<number>\"\n        },\n    \n        \"gas\": {\n        //Price structure for an energy service quote. Service will only be displayed if selected on request.\n\n            \"monthly_price\": \"<number>\",\n            \"tenant_week\": \"<number>\",\n            \"tenant_month\":\t\"<number>\",\n            \"unit_rate\": \"<number>\",\n            \"standing_charge\": \"<number>\"\n        },\n    \n        \"water\": {\n        //Price structure for a service on a quote. Service will only be displayed if selected on request.\n\n            \"monthly_price\": \"<number>\",\n            \"tenant_week\": \"<number>\",\n            \"tenant_month\":\t\"<number>\"\n        },\n    \n        \"broadband\": {\n        //Broadband quotes for available package. Service will only be displayed if selected on request.\n\n            \"monthly_price\": \"<number>\",\n            \"tenant_week\": \"<number>\",\n            \"tenant_month\":\t\"<number>\",\n            \"provider\":\t\"<string>\",\n            \"package_name\": \"<string>\",\n            \"package_code\": \"<string>\",\n            \"min_speed\": \"<number>\",\n            \"max_speed\": \"<number>\",\n            \"estimated_speed\": \"<number>\"\n        },\n    \n        \"tvl\":  {\n        //Price structure for a service on a quote. Service will only be displayed if selected on request.\n\n            \"monthly_price\": \"<number>\",\n            \"tenant_week\": \"<number>\",\n            \"tenant_month\":\t\"<number>\"\n        }\n    },\n    \n    \"tenants\":  [\n    //The list of tenant details attached to the quote.\n        \n        {\n        //An object containing an individual tenants details.\n\n            \"uuid\":\t\"<string>\",\n            //The unique identifier for the tenant.\n\n            \"name\":\t\"<string>\",\n            //The tenants full name.\n\n            \"email\": \"<string>\",\n            //The tenants e-mail address.\n\n            \"mobile\": \"<string>\",\n            //The tenants mobile number.\n\n            \"tenant_resume_link\": \"<string>\",\n            //The unique link for this tenant to signup to the terms and conditions.\n\n            \"completed\": \"boolean\"\n            //True if we have the full customers details and they have signed up to the terms and conditions. Otherwise, false.\n        }\n    ]\n }"},{"id":"cc712c21-f64b-4c7d-be5c-aaf5df59ebea","name":"400 Invalid Request","originalRequest":{"method":"GET","header":[{"key":"API-KEY","value":"{{API-KEY}}","type":"text"}],"url":"{{base_url}}/quote/{quote_uuid}"},"status":"Invalid Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 21 Aug 2025 09:37:26 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Cache-Control","value":"private, must-revalidate"},{"key":"X-RateLimit-Limit","value":"1000"},{"key":"X-RateLimit-Remaining","value":"999"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"-1"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"<string>\"\n    //Simple error message.\n}"},{"id":"e70500bd-6f0c-4399-ad0c-c7624cf6452f","name":"404 Not Found","originalRequest":{"method":"GET","header":[{"key":"API-KEY","value":"{{API-KEY}}","type":"text"}],"url":"{{base_url}}/quote/{quote_uuid}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 21 Aug 2025 09:37:26 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Cache-Control","value":"private, must-revalidate"},{"key":"X-RateLimit-Limit","value":"1000"},{"key":"X-RateLimit-Remaining","value":"999"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"-1"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"<string>\"\n    //Simple error message.\n}"}],"_postman_id":"58e7fd51-2ff7-4b2c-882e-92377096d5ed"},{"name":"Create a Quote","event":[{"listen":"prerequest","script":{"exec":["// get secret","var secret = pm.environment.get(\"secret\");","// get request body","var req = request.data","var requestBody = pm.variables.replaceIn(pm.request.body.raw);","","// create HMAC SHA512 hash request body and secret","var hashHmacSHA512 = CryptoJS.enc.Hex.stringify(CryptoJS.HmacSHA512(requestBody, secret));","// add headers to request","//pm.request.headers.add({key: \"API-HASH\", value: hashHmacSHA512});","pm.environment.set(\"API-HASH\", hashHmacSHA512);",""],"type":"text/javascript","packages":{},"id":"a2aa867b-a8ac-4978-9078-6f9797064633"}}],"id":"38565269-4374-48b5-8bdf-4b2a8b0d36f5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"API-KEY","value":"{{API-KEY}}","type":"text"},{"key":"API-HASH","value":"{{API-HASH}}","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"address\": \"string\", //The properties address lines, excluding the town and postcode.\n\n    \"town\": \"string\", //The town of the property.\n\n    \"postcode\": \"string\", //The properties postcode. The format must include a space between the outward and inward code.\n\n    \"capacity\": \"integer\", //The number of people that will be living at the property.\n\n    \"start_date\": \"string\", //The date the contract will be started from in YYYY-MM-DD format.\n\n    \"end_date\": \"string\", //The end date for the contract. Date must be at least 10 months ahead of start_date and in YYYY-MM-DD format.\n\n    \"udprn\": \"string\", //The unique delivery point reference number. (Min Len: 8 , Max Len 8)\n\n    \"uprn\": \"string\", //The unique property reference number. (Min Len: 1 , Max Len 12)\n\n    \"unlimited\": \"boolean\", //True if the quote should use the Unlimited tariff options. Otherwise, false.\n\n    \"electricity\": \"boolean\", //Quotes must have electricity. Therefore, this should be true.\n\n    \"gas\": \"boolean\", //True if the quote should have gas. Otherwise, false.\n\n    \"water\": \"boolean\", //True if the quote should have water. Otherwise, false.\n\n    \"broadband\": \"boolean\", //True if the quote should have broadband. Otherwise, false.\n\n    \"tvl\": \"boolean\" //True if the quote should have TV licence. Otherwise, false.\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/quote","description":"<p>Create a new quote for a particular address with selected services and contractual dates.</p>\n","urlObject":{"path":["quote"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"30013945-86c3-433d-b56d-1016b9b4c8b5","name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"API-KEY","value":"{{API-KEY}}","description":"API key provided by TSEG","type":"text"},{"key":"API-HASH","value":"{{API-HASH}}","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"address\": \"string\",\n    \"town\": \"string\",\n    \"postcode\": \"string\",\n    \"capacity\": 2,\n    \"start_date\": \"string\",\n    \"end_date\": \"string\",\n    \"udprn\": \"string\",\n    \"uprn\": \"string\",\n    \"unlimited\": false,\n    \"electricity\": true,\n    \"gas\": true,\n    \"water\": false,\n    \"broadband\": false,\n    \"tvl\": false\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/quote"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 20 Aug 2025 13:22:42 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"Cache-Control","value":"private, must-revalidate"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"-1"},{"key":"X-RateLimit-Limit","value":"1000"},{"key":"X-RateLimit-Remaining","value":"999"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":" {\n    \"uuid\":\t\"<string>\",\n    //The UUID to use for future requests related to this quote.\n\n    \"address\":\t\"<string>\",\n    //Address lines including Town and Postcode\n\n    \"capacity\":\t\"integer\",\n    //The number of people that will be living at the property.\n\n    \"start_date\": \"<string>\",\n    //The date the quote will be started from in YYYY-MM-DD format.\n\n    \"end_date\":\t\"<string>\",\n    //The end date for the quote.\n\n    \"unlimited\": \"boolean\",\n    //True if the quote is using the unlimited tariff. Otherwise, false.\n\n    \"contract_reference\": \"<string>\",\n    //The reference to the generated contract once the quote has been completed.\n\n    \"quote_link\": \"<string>\",\n    //The unique link for unidentified tenants to be able to signup to.\n\n    \"services\": {\n    //The services attached to the quote. Each service can be null if it has not been requested or is unavailable. There is the possibility of a new property being added if a new service is offered.\n\n        \"electricity\":  {\n        //Price structure for an energy service quote. Service will only be displayed if selected on request.\n\n            \"monthly_price\": \"<number>\",\n            \"tenant_week\": \"<number>\",\n            \"tenant_month\":\t\"<number>\",\n            \"unit_rate\": \"<number>\",\n            \"standing_charge\": \"<number>\"\n        },\n    \n        \"gas\": {\n        //Price structure for an energy service quote. Service will only be displayed if selected on request.\n\n            \"monthly_price\": \"<number>\",\n            \"tenant_week\": \"<number>\",\n            \"tenant_month\":\t\"<number>\",\n            \"unit_rate\": \"<number>\",\n            \"standing_charge\": \"<number>\"\n        },\n    \n        \"water\": {\n        //Price structure for a service on a quote. Service will only be displayed if selected on request.\n\n            \"monthly_price\": \"<number>\",\n            \"tenant_week\": \"<number>\",\n            \"tenant_month\":\t\"<number>\"\n        },\n    \n        \"broadband\": {\n        //Broadband quotes for available package. Service will only be displayed if selected on request.\n\n            \"monthly_price\": \"<number>\",\n            \"tenant_week\": \"<number>\",\n            \"tenant_month\":\t\"<number>\",\n            \"provider\":\t\"<string>\",\n            \"package_name\": \"<string>\",\n            \"package_code\": \"<string>\",\n            \"min_speed\": \"<number>\",\n            \"max_speed\": \"<number>\",\n            \"estimated_speed\": \"<number>\"\n        },\n    \n        \"tvl\":  {\n        //Price structure for a service on a quote. Service will only be displayed if selected on request.\n\n            \"monthly_price\": \"<number>\",\n            \"tenant_week\": \"<number>\",\n            \"tenant_month\":\t\"<number>\"\n        }\n    },\n    \n    \"tenants\":  [\n    //The list of tenant details attached to the quote.\n        \n        {\n        //An object containing an individual tenants details.\n\n            \"uuid\":\t\"<string>\",\n            //The unique identifier for the tenant.\n\n            \"name\":\t\"<string>\",\n            //The tenants full name.\n\n            \"email\": \"<string>\",\n            //The tenants e-mail address.\n\n            \"mobile\": \"<string>\",\n            //The tenants mobile number.\n\n            \"tenant_resume_link\": \"<string>\",\n            //The unique link for this tenant to signup to the terms and conditions.\n\n            \"completed\": \"boolean\"\n            //True if we have the full customers details and they have signed up to the terms and conditions. Otherwise, false.\n        }\n    ]\n }"},{"id":"5a93b0ee-b322-4ec0-a789-e6568bc91579","name":"400 Invalid Request","originalRequest":{"method":"POST","header":[{"key":"API-KEY","value":"{{API-KEY}}","description":"API key provided by TSEG","type":"text"},{"key":"API-HASH","value":"{{API-HASH}}","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"address\": \"string\",\n    \"town\": \"string\",\n    \"postcode\": \"string\",\n    \"capacity\": 2,\n    \"start_date\": \"string\",\n    \"end_date\": \"string\",\n    \"udprn\": \"string\",\n    \"uprn\": \"string\",\n    \"unlimited\": false,\n    \"electricity\": true,\n    \"gas\": true,\n    \"water\": false,\n    \"broadband\": false,\n    \"tvl\": false\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/quote"},"status":"Invalid Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 20 Aug 2025 13:22:42 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"Cache-Control","value":"private, must-revalidate"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"-1"},{"key":"X-RateLimit-Limit","value":"1000"},{"key":"X-RateLimit-Remaining","value":"999"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":" {\n    \"error\": \"<string>\"\n    //Simple error message.\n }"}],"_postman_id":"38565269-4374-48b5-8bdf-4b2a8b0d36f5"},{"name":"Update an existing Quote","event":[{"listen":"prerequest","script":{"exec":["// get secret","var secret = pm.environment.get(\"secret\");","// get request body","var req = request.data","var requestBody = pm.variables.replaceIn(pm.request.body.raw);","","// create HMAC SHA512 hash request body and secret","var hashHmacSHA512 = CryptoJS.enc.Hex.stringify(CryptoJS.HmacSHA512(requestBody, secret));","// add headers to request","//pm.request.headers.add({key: \"API-HASH\", value: hashHmacSHA512});","pm.environment.set(\"API-HASH\", hashHmacSHA512);",""],"type":"text/javascript","packages":{},"id":"ff5cad92-8e3e-4521-8169-4acdeeb347af"}}],"id":"ef9db0e7-af72-48e1-b47e-15ddc34716a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"API-KEY","value":"{{API-KEY}}","type":"text"},{"key":"API-HASH","value":"{{API-HASH}}","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"unlimited\": \"boolean\", //True if the quote should use the Unlimited tariff options. Otherwise, false.\n\n    \"electricity\": \"boolean\", //Quotes must have electricity. Therefore, this should be true.\n\n    \"gas\": \"boolean\", //True if the quote should have gas. Otherwise, false.\n\n    \"water\": \"boolean\", //True if the quote should have water. Otherwise, false.\n\n    \"broadband\": \"boolean\", //True if the quote should have broadband. Otherwise, false.\n\n    \"tvl\": \"boolean\" //True if the quote should have TV licence. Otherwise, false.\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/quote/{quote_uuid}","description":"<p>Update information on an incomplete quote. Any changes made can affect the price of services. Changes will be blocked once at least one tenant has signed terms and conditions.</p>\n<p><strong>Path Parameters:</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Name</strong></th>\n<th><strong>Type</strong></th>\n<th><strong>Desc</strong></th>\n<th><strong>Required</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>quote_uuid</td>\n<td>string</td>\n<td>The unique reference for the quote</td>\n<td>Y</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["quote","{quote_uuid}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"3c3bcde7-5ac7-43ee-8c79-fa7adf8243cb","name":"200 OK","originalRequest":{"method":"PATCH","header":[{"key":"API-KEY","value":"{{API-KEY}}","type":"text"},{"key":"API-HASH","value":"{{API-HASH}}","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"unlimited\": \"boolean\", \n    \"electricity\": \"boolean\",\n    \"gas\": \"boolean\", \n    \"water\": \"boolean\",\n    \"broadband\": \"boolean\",\n    \"tvl\": \"boolean\" \n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/quote/{quote_uuid}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":" {\n    \"uuid\":\t\"<string>\",\n    //The UUID to use for future requests related to this quote.\n\n    \"address\":\t\"<string>\",\n    //Address lines including Town and Postcode\n\n    \"capacity\":\t\"integer\",\n    //The number of people that will be living at the property.\n\n    \"start_date\": \"<string>\",\n    //The date the quote will be started from in YYYY-MM-DD format.\n\n    \"end_date\":\t\"<string>\",\n    //The end date for the quote.\n\n    \"unlimited\": \"boolean\",\n    //True if the quote is using the unlimited tariff. Otherwise, false.\n\n    \"contract_reference\": \"<string>\",\n    //The reference to the generated contract once the quote has been completed.\n\n    \"quote_link\": \"<string>\",\n    //The unique link for unidentified tenants to be able to signup to.\n\n    \"services\": {\n    //The services attached to the quote. Each service can be null if it has not been requested or is unavailable. There is the possibility of a new property being added if a new service is offered.\n\n        \"electricity\":  {\n        //Price structure for an energy service quote. Service will only be displayed if selected on request.\n\n            \"monthly_price\": \"<number>\",\n            \"tenant_week\": \"<number>\",\n            \"tenant_month\":\t\"<number>\",\n            \"unit_rate\": \"<number>\",\n            \"standing_charge\": \"<number>\"\n        },\n    \n        \"gas\": {\n        //Price structure for an energy service quote. Service will only be displayed if selected on request.\n\n            \"monthly_price\": \"<number>\",\n            \"tenant_week\": \"<number>\",\n            \"tenant_month\":\t\"<number>\",\n            \"unit_rate\": \"<number>\",\n            \"standing_charge\": \"<number>\"\n        },\n    \n        \"water\": {\n        //Price structure for a service on a quote. Service will only be displayed if selected on request.\n\n            \"monthly_price\": \"<number>\",\n            \"tenant_week\": \"<number>\",\n            \"tenant_month\":\t\"<number>\"\n        },\n    \n        \"broadband\": {\n        //Broadband quotes for available package. Service will only be displayed if selected on request.\n\n            \"monthly_price\": \"<number>\",\n            \"tenant_week\": \"<number>\",\n            \"tenant_month\":\t\"<number>\",\n            \"provider\":\t\"<string>\",\n            \"package_name\": \"<string>\",\n            \"package_code\": \"<string>\",\n            \"min_speed\": \"<number>\",\n            \"max_speed\": \"<number>\",\n            \"estimated_speed\": \"<number>\"\n        },\n    \n        \"tvl\":  {\n        //Price structure for a service on a quote. Service will only be displayed if selected on request.\n\n            \"monthly_price\": \"<number>\",\n            \"tenant_week\": \"<number>\",\n            \"tenant_month\":\t\"<number>\"\n        }\n    },\n    \n    \"tenants\":  [\n    //The list of tenant details attached to the quote.\n        \n        {\n        //An object containing an individual tenants details.\n\n            \"uuid\":\t\"<string>\",\n            //The unique identifier for the tenant.\n\n            \"name\":\t\"<string>\",\n            //The tenants full name.\n\n            \"email\": \"<string>\",\n            //The tenants e-mail address.\n\n            \"mobile\": \"<string>\",\n            //The tenants mobile number.\n\n            \"tenant_resume_link\": \"<string>\",\n            //The unique link for this tenant to signup to the terms and conditions.\n\n            \"completed\": \"boolean\"\n            //True if we have the full customers details and they have signed up to the terms and conditions. Otherwise, false.\n        }\n    ]\n }"},{"id":"2c29afd3-10a7-4a92-bdfe-74d24fe33578","name":"400 Invalid request","originalRequest":{"method":"PATCH","header":[{"key":"API-KEY","value":"{{API-KEY}}","type":"text"},{"key":"API-HASH","value":"{{API-HASH}}","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"unlimited\": \"boolean\", \n    \"electricity\": \"boolean\",\n    \"gas\": \"boolean\", \n    \"water\": \"boolean\",\n    \"broadband\": \"boolean\",\n    \"tvl\": \"boolean\" \n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/quote/{quote_uuid}"},"status":"Invalid request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"<string>\"\n    //Simple error message.\n}"},{"id":"86841ca6-fe3e-4053-b387-490abc1bc6e3","name":"404 Quote Not Found","originalRequest":{"method":"PATCH","header":[{"key":"API-KEY","value":"{{API-KEY}}","type":"text"},{"key":"API-HASH","value":"{{API-HASH}}","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"unlimited\": \"boolean\", \n    \"electricity\": \"boolean\",\n    \"gas\": \"boolean\", \n    \"water\": \"boolean\",\n    \"broadband\": \"boolean\",\n    \"tvl\": \"boolean\" \n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/quote/{quote_uuid}"},"status":"Invalid request","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"<string>\"\n    //Simple error message.\n}"}],"_postman_id":"ef9db0e7-af72-48e1-b47e-15ddc34716a5"}],"id":"8ef21857-2207-4bc7-940d-af6a9570380c","_postman_id":"8ef21857-2207-4bc7-940d-af6a9570380c","description":""},{"name":"Tenant","item":[{"name":"Add a tenant to a quote","event":[{"listen":"prerequest","script":{"exec":["// get secret","var secret = pm.environment.get(\"secret\");","// get request body","var req = request.data","var requestBody = pm.variables.replaceIn(pm.request.body.raw);","","// create HMAC SHA512 hash request body and secret","var hashHmacSHA512 = CryptoJS.enc.Hex.stringify(CryptoJS.HmacSHA512(requestBody, secret));","// add headers to request","//pm.request.headers.add({key: \"API-HASH\", value: hashHmacSHA512});","pm.environment.set(\"API-HASH\", hashHmacSHA512);",""],"type":"text/javascript","packages":{},"id":"b7733d12-ef97-4117-9b0e-2e72a0cb9676"}}],"id":"654cad82-7f12-4f11-8352-30e73630f885","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"API-KEY","value":"{{API-KEY}}","type":"text"},{"key":"API-HASH","value":"{{API-HASH}}","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"firstname\": \"string\", //First name\n\n    \"lastname\":\t\"string\", //Last name\n\n    \"email\": \"string\", //E-mail address. Required if mobile number is not passed.\n\n    \"mobile\": \"string\", //Mobile number. Required if e-mail address is not passed.\n\n    \"completed\": \"boolean\" //True if the individual has already agreed to terms and conditions. Otherwise, false. This feature is turned off by default and needs to be granted.\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/quote/{quote_uuid}/tenant","description":"<p>Provide tenant details and attach them to an existing quote. The number of tenants must not exceed the capacity on the quote.</p>\n<p><strong>Path Parameters:</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Name</strong></th>\n<th><strong>Type</strong></th>\n<th><strong>Desc</strong></th>\n<th><strong>Required</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>quote_uuid</td>\n<td>string</td>\n<td>The unique reference for the quote.</td>\n<td>Y</td>\n</tr>\n<tr>\n<td>tenant_uuid</td>\n<td>string</td>\n<td>The unique reference for the tenant.</td>\n<td>Y</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["quote","{quote_uuid}","tenant"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"97e2b5a6-8687-4a14-ba6e-ae1430b93681","name":"201 Success","originalRequest":{"method":"POST","header":[{"key":"API-KEY","value":"{{API-KEY}}","type":"text"},{"key":"API-HASH","value":"{{API-HASH}}","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"firstname\": \"string\",\n    \"lastname\": \"string\",\n    \"email\": \"string\",\n    \"mobile\": \"string\",\n    \"completed\": \"boolean\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/quote/{quote_uuid}/tenant"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 21 Aug 2025 10:17:47 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"Cache-Control","value":"private, must-revalidate"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"-1"},{"key":"X-RateLimit-Limit","value":"1000"},{"key":"X-RateLimit-Remaining","value":"998"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n//An object containing an individual tenants details.\n\n    \"uuid\": \"<string>\",\n    // The unique identifier for the tenant.\n\n    \"name\": \"<string>\",\n    // The tenants full name.\n\n    \"email\": \"<string>\",\n    // The tenants e-mail address.\n\n    \"mobile\": \"<string>\",\n    // The tenants mobile number.\n\n    \"tenant_resume_link\": \"<string>\",\n    // The unique link for this tenant to signup to the terms and conditions.\n\n    \"completed\": \"<boolean>\"\n    // True if we have the full customers details and they have signed up to the terms and conditions. Otherwise, false.\n}"},{"id":"16141feb-5e94-46a7-a4b4-7fd8b6e016ba","name":"400 Invalid request","originalRequest":{"method":"POST","header":[{"key":"API-KEY","value":"{{API-KEY}}","type":"text"},{"key":"API-HASH","value":"{{API-HASH}}","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"firstname\": \"string\",\n    \"lastname\": \"string\",\n    \"email\": \"string\",\n    \"mobile\": \"string\",\n    \"completed\": \"boolean\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/quote/{quote_uuid}/tenant"},"status":"Invalid request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"<string>\"\n    //Simple error message.\n}"}],"_postman_id":"654cad82-7f12-4f11-8352-30e73630f885"},{"name":"Update a tenant on a quote Copy","event":[{"listen":"prerequest","script":{"exec":["// get secret","var secret = pm.environment.get(\"secret\");","// get request body","var req = request.data","var requestBody = pm.variables.replaceIn(pm.request.body.raw);","","// create HMAC SHA512 hash request body and secret","var hashHmacSHA512 = CryptoJS.enc.Hex.stringify(CryptoJS.HmacSHA512(requestBody, secret));","// add headers to request","//pm.request.headers.add({key: \"API-HASH\", value: hashHmacSHA512});","pm.environment.set(\"API-HASH\", hashHmacSHA512);",""],"type":"text/javascript","packages":{},"id":"3505e6aa-bd1d-4e17-a0ee-ce20cec9b8f6"}}],"id":"4782a2a2-91ec-44b3-9009-3ac6c7f847c6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"API-KEY","value":"{{API-KEY}}","type":"text"},{"key":"API-HASH","value":"{{API-HASH}}","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"completed\": \"boolean\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/quote/{quote_uuid}/tenant/{tenant_uuid}","description":"<p>Update the 'completed' status on an incomplete tenant linked to an quote. This feature is turned off by default and needs to be granted.</p>\n<p><strong>Path Parameters:</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Name</strong></th>\n<th><strong>Type</strong></th>\n<th><strong>Desc</strong></th>\n<th><strong>Required</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>quote_uuid</td>\n<td>string</td>\n<td>The unique reference for the quote.</td>\n<td>Y</td>\n</tr>\n<tr>\n<td>tenant_uuid</td>\n<td>string</td>\n<td>The unique reference for the tenant.</td>\n<td>Y</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["quote","{quote_uuid}","tenant","{tenant_uuid}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"5c191803-066a-4f08-a6bc-732a9ebbd29a","name":"200 OK","originalRequest":{"method":"PATCH","header":[{"key":"API-KEY","value":"{{API-KEY}}","type":"text"},{"key":"API-HASH","value":"{{API-HASH}}","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"firstname\": \"string\",\n    \"lastname\": \"string\",\n    \"email\": \"string\",\n    \"mobile\": \"string\",\n    \"completed\": \"boolean\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/quote/{quote_uuid}/tenant/{tenant_uuid}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 21 Aug 2025 10:17:47 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"Cache-Control","value":"private, must-revalidate"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"-1"},{"key":"X-RateLimit-Limit","value":"1000"},{"key":"X-RateLimit-Remaining","value":"998"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n//An object containing an individual tenants details.\n\n    \"uuid\": \"<string>\",\n    // The unique identifier for the tenant.\n\n    \"name\": \"<string>\",\n    // The tenants full name.\n\n    \"email\": \"<string>\",\n    // The tenants e-mail address.\n\n    \"mobile\": \"<string>\",\n    // The tenants mobile number.\n\n    \"tenant_resume_link\": \"<string>\",\n    // The unique link for this tenant to signup to the terms and conditions.\n\n    \"completed\": \"<boolean>\"\n    // True if we have the full customers details and they have signed up to the terms and conditions. Otherwise, false.\n}"},{"id":"3ed66180-5652-4fc7-be2c-f404e308639b","name":"400 Invalid request","originalRequest":{"method":"PATCH","header":[{"key":"API-KEY","value":"{{API-KEY}}","type":"text"},{"key":"API-HASH","value":"{{API-HASH}}","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"firstname\": \"string\",\n    \"lastname\": \"string\",\n    \"email\": \"string\",\n    \"mobile\": \"string\",\n    \"completed\": \"boolean\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/quote/{quote_uuid}/tenant/{tenant_uuid}"},"status":"Invalid request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"<string>\"\n    //Simple error message.\n}"},{"id":"cc7ae1a1-1857-4c0d-82bd-e63b62b0b15c","name":"404 - Tenant not found","originalRequest":{"method":"PATCH","header":[{"key":"API-KEY","value":"{{API-KEY}}","type":"text"},{"key":"API-HASH","value":"{{API-HASH}}","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"firstname\": \"string\",\n    \"lastname\": \"string\",\n    \"email\": \"string\",\n    \"mobile\": \"string\",\n    \"completed\": \"boolean\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/quote/{quote_uuid}/tenant/{tenant_uuid}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"<string>\"\n    //Simple error message.\n}"}],"_postman_id":"4782a2a2-91ec-44b3-9009-3ac6c7f847c6"}],"id":"ba712ede-2ae9-4c9f-9184-423086002e84","_postman_id":"ba712ede-2ae9-4c9f-9184-423086002e84","description":""}]}