{"info":{"_postman_id":"ea2bbe69-6e95-44ab-87c0-49dcce06a52e","name":"V3 Portal API","description":"<html><head></head><body><p>Integration API Exposed by V3 Portal</p>\n</body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"53415706","collectionId":"ea2bbe69-6e95-44ab-87c0-49dcce06a52e","publishedId":"2sBYAyroKW","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-09-11T10:16:49.000Z"},"item":[{"name":"api","item":[{"name":"updateStatus","item":[{"name":"Update the status of a contract on the portal","id":"ce78baee-bf41-4dff-a5fc-ddd5a5b6a16f","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"meterIdentifierType\": \"SiteSupplyId\",\n  \"meterIdentifier\": \"1234\",\n  \"newStatus\": \"ValidationFailed\",\n  \"message\": \"The provided consumption was outside of expected range\"\n}","options":{"raw":{"language":"json"}}},"url":"/api/updateStatus","description":"<p>This endpoint is used by suppliers to update the status of a contract created on the portal.\nThe status change could relate to an internal workflow stage such as manual validation\nand auditing or part of the registration flow as the meter moves to the new supplier.</p>\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apiKey"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"ea2bbe69-6e95-44ab-87c0-49dcce06a52e","id":"ea2bbe69-6e95-44ab-87c0-49dcce06a52e","name":"V3 Portal API","type":"collection"}},"urlObject":{"path":["api","updateStatus"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"84d74ce4-9778-4b6b-9c44-f654d78ac7b4","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"apiKey","value":"<API Key>","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n  \"meterIdentifierType\": \"SiteSupplyId\",\n  \"meterIdentifier\": \"1234\",\n  \"newStatus\": \"ValidationFailed\",\n  \"message\": \"The provided consumption was outside of expected range\"\n}","options":{"raw":{"language":"json"}}},"url":"/api/updateStatus"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n  {\n    \"errorMessage\": \"Failed to update one or more site supply statueses. Either the sitesupply could not be located from the provided information or the current status of the site supply cannot be changed to the requested state. Meter Identifier Type: SiteSupplyId, Meter Identifier 223082, Status From: Saved, Status To: Savedd, Valid Statuses Are:  Saved, ExperianReferralAwaitingUpdate, ExperianReferralDecisionMade, Submitted\",\n    \"actionData\": {\n      \"meterIdentifierType\": \"SiteSupplyId\",\n      \"meterIdentifier\": \"1234\",\n      \"newStatus\": \"ValidationFailed\",\n      \"message\": \"The provided consumption was outside of expected range\"\n    },\n    \"success\": false\n  },\n  {\n    \"errorMessage\": \"Failed to update one or more site supply statueses. Either the sitesupply could not be located from the provided information or the current status of the site supply cannot be changed to the requested state. Meter Identifier Type: SiteSupplyId, Meter Identifier 223082, Status From: Saved, Status To: Savedd, Valid Statuses Are:  Saved, ExperianReferralAwaitingUpdate, ExperianReferralDecisionMade, Submitted\",\n    \"actionData\": {\n      \"meterIdentifierType\": \"SiteSupplyId\",\n      \"meterIdentifier\": \"1234\",\n      \"newStatus\": \"ValidationFailed\",\n      \"message\": \"The provided consumption was outside of expected range\"\n    },\n    \"success\": false\n  }\n]"},{"id":"1fc7c584-918e-4f87-8488-e070908448c0","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"apiKey","value":"<API Key>","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n  \"meterIdentifierType\": \"SiteSupplyId\",\n  \"meterIdentifier\": \"1234\",\n  \"newStatus\": \"ValidationFailed\",\n  \"message\": \"The provided consumption was outside of expected range\"\n}","options":{"raw":{"language":"json"}}},"url":"/api/updateStatus"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"errorMessage\": \"Failed to update one or more site supply statueses. Either the sitesupply could not be located from the provided information or the current status of the site supply cannot be changed to the requested state. Meter Identifier Type: SiteSupplyId, Meter Identifier 223082, Status From: Saved, Status To: Savedd, Valid Statuses Are:  Saved, ExperianReferralAwaitingUpdate, ExperianReferralDecisionMade, Submitted\",\n  \"actionData\": {\n    \"meterIdentifierType\": \"SiteSupplyId\",\n    \"meterIdentifier\": \"1234\",\n    \"newStatus\": \"ValidationFailed\",\n    \"message\": \"The provided consumption was outside of expected range\"\n  },\n  \"success\": false\n}"}],"_postman_id":"ce78baee-bf41-4dff-a5fc-ddd5a5b6a16f"}],"id":"59966b37-1554-4377-a87c-d02801e1172a","_postman_id":"59966b37-1554-4377-a87c-d02801e1172a","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apiKey"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"ea2bbe69-6e95-44ab-87c0-49dcce06a52e","id":"ea2bbe69-6e95-44ab-87c0-49dcce06a52e","name":"V3 Portal API","type":"collection"}}},{"name":"dataExport","item":[{"name":"Retrieve a data export from the portal","id":"6535b7dd-8a02-49d9-b47d-97904eeb0c23","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/api/dataExport?dataTemplate=SubmittedAcquisitionElecContractsAwaitingExport&showTestSites=true","description":"<p>This export is used to extract data based on a predefined data template. This is used\nprimarily for retrieving data on recent contract submissions so they can be exported\nto a supplier via SFTP. Alternatively the supplier can call this endpoint directly to \npull the data themselves.</p>\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apiKey"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"ea2bbe69-6e95-44ab-87c0-49dcce06a52e","id":"ea2bbe69-6e95-44ab-87c0-49dcce06a52e","name":"V3 Portal API","type":"collection"}},"urlObject":{"path":["api","dataExport"],"host":[""],"query":[{"description":{"content":"<p>The name of the dataTemplate to return data from. This may vary by supplier depending\non if there are different data templates for gas/elec and acquisition/renewal.</p>\n","type":"text/plain"},"key":"dataTemplate","value":"SubmittedAcquisitionElecContractsAwaitingExport"},{"description":{"content":"<p>Test sites added via POWWR will be visible if set to true</p>\n","type":"text/plain"},"key":"showTestSites","value":"true"}],"variable":[]}},"response":[{"id":"a33b93bd-1359-4e7a-a8e6-ebf6b2322117","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"apiKey","value":"<API Key>","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"/api/dataExport?dataTemplate=SubmittedAcquisitionElecContractsAwaitingExport&showTestSites=true","host":[""],"path":["api","dataExport"],"query":[{"key":"dataTemplate","value":"SubmittedAcquisitionElecContractsAwaitingExport","description":"The name of the dataTemplate to return data from. This may vary by supplier depending\non if there are different data templates for gas/elec and acquisition/renewal.\n"},{"key":"showTestSites","value":"true","description":"Test sites added via POWWR will be visible if set to true\n"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"UniqueID\": \"string\",\n  \"ExternalCustomerReference\": \"string\",\n  \"ExperianCreditRef\": \"string\",\n  \"YUECustomerReference\": \"string\",\n  \"CompanyName\": \"string\",\n  \"CustomerClass\": \"string\",\n  \"CompanyRegistrationNumber\": \"string\",\n  \"CreditScore\": \"string\",\n  \"BusinessType\": \"string\",\n  \"BusinessStartDate\": \"string\",\n  \"Industry\": \"string\",\n  \"CompanyStatus\": \"string\",\n  \"RegisteredAddress1\": \"string\",\n  \"RegisteredAddress2\": \"string\",\n  \"RegisteredAddress3\": \"string\",\n  \"RegisteredAddress4\": \"string\",\n  \"RegisteredAddress5\": \"string\",\n  \"RegisteredPostCode\": \"string\",\n  \"DirectorTitle\": \"string\",\n  \"DirectorFirstName\": \"string\",\n  \"DirectorSurname\": \"string\",\n  \"DirectorJobTitle\": \"string\",\n  \"DirectorAddress1\": \"string\",\n  \"DirectorAddress2\": \"string\",\n  \"DirectorAddress3\": \"string\",\n  \"DirectorAddress4\": \"string\",\n  \"DirectorAddress5\": \"string\",\n  \"DirectorPostCode\": \"string\",\n  \"DirectorPhoneNumber\": \"string\",\n  \"DirectorMobileNumber\": \"string\",\n  \"DirectorYearsAtAddress\": \"string\",\n  \"NumberOfPartners\": \"string\",\n  \"CharityName\": \"string\",\n  \"CharityNumber\": \"string\",\n  \"ContactType\": \"string\",\n  \"ContactSurname\": \"string\",\n  \"ContactFirstname\": \"string\",\n  \"ContactTitle\": \"string\",\n  \"ContactEmailAddress\": \"string\",\n  \"ContactDateOfBirth\": \"string\",\n  \"ContactPrimaryTelephoneNumber\": \"string\",\n  \"ContactSecondaryTelephoneNumber\": \"string\",\n  \"BillDeliveryMethod\": \"string\",\n  \"CommunicationDeliveryMethod\": \"string\",\n  \"IsPrimaryContact\": \"string\",\n  \"Address1\": \"string\",\n  \"Address2\": \"string\",\n  \"Address3\": \"string\",\n  \"Address4\": \"string\",\n  \"Address5\": \"string\",\n  \"AddressPostcode\": \"string\",\n  \"AgreementStartDate\": \"string\",\n  \"AgreementEndDate\": \"string\",\n  \"AgreementTerm\": \"string\",\n  \"Uplift\": \"string\",\n  \"ProductBundleRef\": \"string\",\n  \"DayUsage\": \"string\",\n  \"NightUsage\": \"string\",\n  \"EveningWeekendUsage\": \"string\",\n  \"AllPeriodsUsage\": \"string\",\n  \"AnnualUsage\": \"string\",\n  \"BrokerCode\": \"string\",\n  \"BrokerName\": \"string\",\n  \"BrokerAgentReference\": \"string\",\n  \"BrokerReference\": \"string\",\n  \"AgentName\": \"string\",\n  \"DateOfSale\": \"string\",\n  \"PaymentMethod\": \"string\",\n  \"BillingFrequency\": \"string\",\n  \"NumberOfBills\": \"string\",\n  \"NumberOfMeterReadings\": \"string\",\n  \"BankAccountName\": \"string\",\n  \"BankSortCode\": \"string\",\n  \"BankAccountNumber\": \"string\",\n  \"DirectDebitPaymentDay\": \"string\",\n  \"BankName\": \"string\",\n  \"VATDeclaration\": \"string\",\n  \"MeterPointIdentifier\": \"string\",\n  \"Fuel\": \"Gas - Gas Meter Point\",\n  \"ProfileClass\": \"string\",\n  \"SerialNumber\": \"string\",\n  \"TopLine\": \"string\",\n  \"MeterType\": \"string\",\n  \"MeasurementClass\": \"string\",\n  \"AssetContactType\": \"string\",\n  \"Available247\": \"string\",\n  \"AssetContactDescription\": \"string\",\n  \"AssetContactSurname\": \"string\",\n  \"AssetContactFirstname\": \"string\",\n  \"AssetContactInitials\": \"string\",\n  \"AssetContactTitle\": \"string\",\n  \"AssetContactEmailAddress\": \"string\",\n  \"AssetContactTelephoneNumber1\": \"string\",\n  \"AssetContactTelephoneNumber2\": \"string\",\n  \"AssetContactTelephoneNumber3\": \"string\",\n  \"PropertyContactType\": \"string\",\n  \"PropertySurname\": \"string\",\n  \"PropertyFirstname\": \"string\",\n  \"PropertyTitle\": \"string\",\n  \"PropertyEmailAddress\": \"string\",\n  \"PropertyTelephoneNumber\": \"string\",\n  \"PropertySecondaryTelephoneNumber\": \"string\",\n  \"PropertySietName\": \"string\",\n  \"PropertyAddress1\": \"string\",\n  \"PropertyAddress2\": \"string\",\n  \"PropertyAddress3\": \"string\",\n  \"PropertyAddress4\": \"string\",\n  \"PropertyAddress5\": \"string\",\n  \"PropertyAddressPostcode\": \"string\",\n  \"SupplyCapacity\": \"string\",\n  \"CurrentSupplier\": \"string\",\n  \"CurrentContractEndDate\": \"string\",\n  \"SalesType\": \"Acquisition\",\n  \"COTFlag\": \"string\",\n  \"COTDate\": \"string\",\n  \"ConsentQuote\": \"string\",\n  \"ConsentMarketingPost\": \"string\",\n  \"PrivacyPolicy\": \"string\",\n  \"Rates\": {\n    \"Rate\": [\n      {\n        \"ProductItemReference\": \"STANDING-CHARGE\",\n        \"RateName\": \"Standard\",\n        \"Rate\": \"string\",\n        \"AnnualConsumption\": \"string\"\n      },\n      {\n        \"ProductItemReference\": \"STANDING-CHARGE\",\n        \"RateName\": \"Day\",\n        \"Rate\": \"string\",\n        \"AnnualConsumption\": \"string\"\n      }\n    ]\n  },\n  \"Contract Type\": \"string\",\n  \"Product Name\": \"string\",\n  \"Renewable\": \"string\"\n}"},{"id":"cc58a578-d640-43ba-9736-0330c1103ba5","name":"No data available","originalRequest":{"method":"GET","header":[{"key":"apiKey","value":"<API Key>","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"/api/dataExport?dataTemplate=SubmittedAcquisitionElecContractsAwaitingExport&showTestSites=true","host":[""],"path":["api","dataExport"],"query":[{"key":"dataTemplate","value":"SubmittedAcquisitionElecContractsAwaitingExport","description":"The name of the dataTemplate to return data from. This may vary by supplier depending\non if there are different data templates for gas/elec and acquisition/renewal.\n"},{"key":"showTestSites","value":"true","description":"Test sites added via POWWR will be visible if set to true\n"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"6535b7dd-8a02-49d9-b47d-97904eeb0c23"}],"id":"da19f183-a7f8-48c2-a62b-ad08b3eb5675","_postman_id":"da19f183-a7f8-48c2-a62b-ad08b3eb5675","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apiKey"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"ea2bbe69-6e95-44ab-87c0-49dcce06a52e","id":"ea2bbe69-6e95-44ab-87c0-49dcce06a52e","name":"V3 Portal API","type":"collection"}}}],"id":"7a2945c2-a6b9-437a-9204-2e14db2374d4","_postman_id":"7a2945c2-a6b9-437a-9204-2e14db2374d4","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apiKey"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"ea2bbe69-6e95-44ab-87c0-49dcce06a52e","id":"ea2bbe69-6e95-44ab-87c0-49dcce06a52e","name":"V3 Portal API","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apiKey"},{"key":"value","value":"{{apiKey}}"}]}},"variable":[{"key":"baseUrl","value":""}]}