Fields

address : String

The street address.
address2 : String

The second line of the street address.
city : String

The city of the address.
esiId : String

The ESI ID (unique identifier) of the meterpoint at the address.
houseNumber : String

The house number of the address.
isCustomer : OeCustomerOutput

Whether the address is associated with an existing customer.
Deprecation
The 'isCustomer' field is deprecated.

Please use `isKrakenCustomer` instead.

- Marked as deprecated on 2025-08-21.
- Scheduled for removal on or after 2025-09-21.
isKrakenCustomer : IsKrakenCustomerOutput

Whether the address is associated with the current customer.
loadZone : LoadZone

The load zone for the meter point at the address.
meterType : MeterTypeOptions

The type of meter at the property.
postCode : String

The postal code of the address.
premiseType : PremiseType

Type of property.
serviceProvider : ServiceProvider

The service provider for the meter point at the address (TDSP).
state : String

The state of the address.
The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "address": "business-first-risk-six-of", "address2": "later-evidence-law-hair-score", "city": "herself-threat-back-often-argue", "esiId": "16539911", "houseNumber": "model-offer-yeah-six-reflect", "isKrakenCustomer": IsKrakenCustomerOutput, "loadZone": "LZ_HOUSTON", "meterType": "AMSM", "postCode": "second-gun-walk-poor-I", "premiseType": "RESIDENTIAL", "serviceProvider": "AEP_TCC", "state": "let-woman-mother-cold-chance" }