Skip to main content

Fields

addressKey : String! required

A unique ID per address using part of the address with spaces removed.

addressType : AddressTypeEnum

The type of address (domestic, business or unknown).

display : String! required

The complete and human-legible address in a single string.

electricityMeterPoints : [AddressAPIElectricityMeterPointType]
gspGroupId : String! required

The ID of the Grid Supply Point Group that the address belongs to.

hasPrepaidMeters : Boolean! required
houseNumber : String

The identifier for a property. The house number consists of the part of line 1 of the address that is not the street name. This includes sub-building names, building names, deliver point aliases and building numbers. For example, the house number for the property 'Flat 12 100 Example St' would be 'Flat 12 100'.

line1 : String! required

Line 1 of the address. This is generally the house number and street name.

line2 : String! required

Line 2 of the address. This is generally the area or village.

line3 : String! required

Line 3 of the address. This is generally the area or village.

line4 : String! required

Line 4 of the address. This is generally the city.

line5 : String! required

Line 5 of the address. This is generally the county.

postcode : String! required
streetName : String

The street name for a property. The street name consists of the part of line 1 of the address that is not the house number. For example, the house number for the property 'Flat 12 100 Example St' would be 'Example St'.

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

{ "addressKey": "consumer-debate-current-guess-star", "addressType": "DOMESTIC", "display": "become-send-bed-off-fund", "electricityMeterPoints": [AddressAPIElectricityMeterPointType], "gasMeterPoints": [AddressAPIGasMeterPointType], "gspGroupId": "40524632", "hasPrepaidMeters": true, "houseNumber": "hospital-fill-force-first-suggest", "line1": "throw-field-free-name-often", "line2": "other-each-after-during-authority", "line3": "necessary-audience-avoid-play-fact", "line4": "society-manage-television-child-may", "line5": "some-baby-we-community-simply", "postcode": "world-start-floor-blood-method", "streetName": "try-fall-throw-center-treat" }